LUIS Runtime V3.0 (#7229)

* LUIS Runtime V3.0 * Fix swagger * Edit readme * Edit swagger * minor edit * Remove property * Review 1 + remove v3.0 preview
Azure · Sep 19, 2019 · 87cbcf9 · 87cbcf9
1 parent faf99f5
commit 87cbcf9
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 29 deletions.
diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.go.md
@@ -14,7 +14,7 @@ go:
 ``` yaml $(go) && $(multiapi)
 batch:
   - tag: runtime_2_0
-  - tag: runtime_3_0_preview
+  - tag: runtime_3_0
 ```
 
 ### Tag: runtime_2_0 and go
@@ -26,11 +26,11 @@ Please also specify `--go-sdk-folder=<path to the root directory of your azure-s
 output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/luis/$(namespace)
 ```
 
-### Tag: runtime_3_0_preview and go
+### Tag: runtime_3_0 and go
 
-These settings apply only when `--tag=runtime_3_0_preview --go` is specified on the command line.
+These settings apply only when `--tag=runtime_3_0 --go` is specified on the command line.
 Please also specify `--go-sdk-folder=<path to the root directory of your azure-sdk-for-go clone>`.
 
-``` yaml $(tag) == 'runtime_3_0_preview' && $(go)
-output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/luis/$(namespace)
+``` yaml $(tag) == 'runtime_3_0' && $(go)
+output-folder: $(go-sdk-folder)/services/stable/cognitiveservices/v3.0/luis/$(namespace)
 ```
diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md
@@ -5,12 +5,12 @@
 Configuration for generating LUIS Runtime SDK.
 
 ``` yaml
-tag: runtime_3_0_preview
+tag: runtime_3_0
 add-credentials: true
 openapi-type: data-plane
 ```
 
-The current release for the Runtime Endpoint is `runtime_3_0_preview`.
+The current release for the Runtime Endpoint is `runtime_3_0`.
 
 # Releases
 
@@ -25,11 +25,11 @@ directive:
   remove-operation: Prediction_Resolve2
 ```
 
-## Runtime 3.0-preview
-These settings apply only when `--tag=runtime_3_0_preview` is specified on the command line.
+## Runtime 3.0
+These settings apply only when `--tag=runtime_3_0` is specified on the command line.
 
-``` yaml $(tag) == 'runtime_3_0_preview'
-input-file: preview/v3.0/LUIS-Runtime.json
+``` yaml $(tag) == 'runtime_3_0'
+input-file: stable/v3.0/LUIS-Runtime.json
 
 # remove the GET APIs from code-generation (since the POST and GET operations are functionally identical)
 directive:
@@ -110,7 +110,7 @@ require: $(this-folder)/../../../../../profiles/readme.md
 # all the input files across all versions
 input-file:
   - $(this-folder)/stable/v2.0/LUIS-Runtime.json
-  - $(this-folder)/preview/v3.0/LUIS-Runtime.json
+  - $(this-folder)/stable/v3.0/LUIS-Runtime.json
 
 ```
 

diff --git a/...IS/Runtime/preview/v3.0/LUIS-Runtime.json → ...UIS/Runtime/stable/v3.0/LUIS-Runtime.json b/...IS/Runtime/preview/v3.0/LUIS-Runtime.json → ...UIS/Runtime/stable/v3.0/LUIS-Runtime.json
@@ -2,10 +2,10 @@
   "swagger": "2.0",
   "info": {
     "title": "LUIS Runtime Client",
-    "version": "3.0-preview"
+    "version": "3.0"
   },
   "x-ms-parameterized-host": {
-    "hostTemplate": "{Endpoint}/luis/v3.0-preview",
+    "hostTemplate": "{Endpoint}/luis/v3.0",
     "useSchemePrefix": false,
     "parameters": [
       {
@@ -335,17 +335,12 @@
     "Prediction": {
       "description": "Represents the prediction of a query.",
       "required": [
-        "normalizedQuery",
         "topIntent",
         "intents",
         "entities"
       ],
       "type": "object",
       "properties": {
-        "normalizedQuery": {
-          "description": "The query after pre-processing and normalization.",
-          "type": "string"
-        },
         "alteredQuery": {
           "description": "The query after spell checking. Only set if spell check was enabled and a spelling mistake was found.",
           "type": "string"
@@ -362,7 +357,7 @@
           }
         },
         "entities": {
-          "description": "The dictionary representing the entities that fired.",
+          "description": "A dictionary representing the entities that fired.",
           "type": "object",
           "additionalProperties": {}
         },
@@ -475,7 +470,7 @@
           "description": "The reference DateTime used for predicting datetime entities.",
           "type": "string"
         },
-        "overridePredictions": {
+        "preferExternalEntities": {
           "description": "Whether to make the external entities resolution override the predictions if an overlap occurs.",
           "type": "boolean"
         }
@@ -506,6 +501,11 @@
         },
         "resolution": {
           "description": "A user supplied custom resolution to return as the entity's prediction."
+        },
+        "score": {
+          "format": "float",
+          "description": "A user supplied score to return as the entity's prediction score.",
+          "type": "number"
         }
       }
     },

diff --git a/...PredictionsFromEndpointViaGetRequest.json → ...PredictionsFromEndpointViaGetRequest.json b/...PredictionsFromEndpointViaGetRequest.json → ...PredictionsFromEndpointViaGetRequest.json
@@ -12,7 +12,6 @@
       "body": {
         "query": "forward to frank 30 dollars through HSBC",
         "prediction": {
-          "normalizedQuery": "forward to frank 30 dollars through hsbc",
           "topIntent": "give",
           "intents": {
             "give": {
@@ -28,7 +27,7 @@
             ],
             "money": [
               {
-                "unit": "Dollar",
+                "units": "Dollar",
                 "value": 30
               }
             ],

diff --git a/...redictionsFromEndpointViaPostRequest.json → ...redictionsFromEndpointViaPostRequest.json b/...redictionsFromEndpointViaPostRequest.json → ...redictionsFromEndpointViaPostRequest.json
@@ -39,7 +39,6 @@
       "body": {
         "query": "forward to frank 30 dollars through HSBC",
         "prediction": {
-          "normalizedQuery": "forward to frank 30 dollars through hsbc",
           "topIntent": "give",
           "intents": {
             "give": {
@@ -57,7 +56,7 @@
             ],
             "money": [
               {
-                "unit": "Dollar",
+                "units": "Dollar",
                 "value": 30
               }
             ],

diff --git a/...PredictionsFromEndpointViaGetRequest.json → ...PredictionsFromEndpointViaGetRequest.json b/...PredictionsFromEndpointViaGetRequest.json → ...PredictionsFromEndpointViaGetRequest.json
@@ -12,7 +12,6 @@
       "body": {
         "query": "forward to frank 30 dollars through HSBC",
         "prediction": {
-          "normalizedQuery": "forward to frank 30 dollars through hsbc",
           "topIntent": "give",
           "intents": {
             "give": {
@@ -30,7 +29,7 @@
             ],
             "money": [
               {
-                "unit": "Dollar",
+                "units": "Dollar",
                 "value": 30
               }
             ],

diff --git a/...redictionsFromEndpointViaPostRequest.json → ...redictionsFromEndpointViaPostRequest.json b/...redictionsFromEndpointViaPostRequest.json → ...redictionsFromEndpointViaPostRequest.json
@@ -39,7 +39,6 @@
       "body": {
         "query": "forward to frank 30 dollars through HSBC",
         "prediction": {
-          "normalizedQuery": "forward to frank 30 dollars through hsbc",
           "topIntent": "give",
           "intents": {
             "give": {
@@ -57,7 +56,7 @@
             ],
             "money": [
               {
-                "unit": "Dollar",
+                "units": "Dollar",
                 "value": 30
               }
             ],