diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json index 4ba876584a09..84c75b6d6d56 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json @@ -5,11 +5,52 @@ "version": "2.0" }, "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/luis/api/v2.0", - "useSchemePrefix": false, + "hostTemplate": "{AzureRegion}.api.cognitive.microsoft.{AzureCloud}/luis/api/v2.0", "parameters": [ { - "$ref": "#/parameters/Endpoint" + "name": "AzureRegion", + "description": "Supported Azure regions for Cognitive Services endpoints", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-enum": { + "name": "AzureRegions", + "modelAsString": false + }, + "enum": [ + "westus", + "westeurope", + "southeastasia", + "eastus2", + "westcentralus", + "westus2", + "eastus", + "southcentralus", + "northeurope", + "eastasia", + "australiaeast", + "brazilsouth", + "virginia" + ] + }, + { + "name": "AzureCloud", + "description": "Supported Azure Clouds for Cognitive Services endpoints", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-enum": { + "name": "AzureClouds", + "modelAsString": false + }, + "enum": [ + "com", + "us" + ] } ] }, @@ -28,7 +69,7 @@ "paths": { "/apps/{appId}/versions/{versionId}/patterns": { "post": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Creates a new pattern feature.", + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Creates a new pattern feature in a version of the application.", "operationId": "Features_CreatePatternFeature", "deprecated": true, "parameters": [ @@ -76,7 +117,7 @@ }, "get": { "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets all the pattern features.", - "operationId": "Features_GetApplicationVersionPatternFeatures", + "operationId": "Features_ListApplicationVersionPatternFeatures", "deprecated": true, "parameters": [ { @@ -118,7 +159,7 @@ }, "/apps/{appId}/versions/{versionId}/phraselists": { "post": { - "description": "Creates a new phraselist feature.", + "description": "Creates a new phraselist feature in a version of the application.", "operationId": "Features_AddPhraseList", "parameters": [ { @@ -164,7 +205,7 @@ } }, "get": { - "description": "Gets all the phraselist features.", + "description": "Gets all the phraselist features in a version of the application.", "operationId": "Features_ListPhraseLists", "parameters": [ { @@ -206,7 +247,7 @@ }, "/apps/{appId}/versions/{versionId}/features": { "get": { - "description": "Gets all the extraction features for the specified application version.", + "description": "Gets all the extraction phraselist and pattern features in a version of the application.", "operationId": "Features_List", "parameters": [ { @@ -248,7 +289,7 @@ }, "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { "get": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets the specified pattern feature's info.", + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Gets the specified pattern feature's info in a version of the application.", "operationId": "Features_GetPatternFeatureInfo", "deprecated": true, "parameters": [ @@ -290,7 +331,7 @@ } }, "put": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Updates the pattern, the name and the state of the pattern feature.", + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Updates the pattern, the name and the state of the pattern feature in a version of the application.", "operationId": "Features_UpdatePatternFeature", "deprecated": true, "parameters": [ @@ -344,7 +385,7 @@ } }, "delete": { - "description": "[DEPRECATED NOTICE: This operation will soon be removed] Deletes a pattern feature.", + "description": "[DEPRECATED NOTICE: This operation will soon be removed] Deletes a pattern feature in a version of the application.", "operationId": "Features_DeletePatternFeature", "deprecated": true, "parameters": [ @@ -388,7 +429,7 @@ }, "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { "get": { - "description": "Gets phraselist feature info.", + "description": "Gets phraselist feature info in a version of the application.", "operationId": "Features_GetPhraseList", "parameters": [ { @@ -429,7 +470,7 @@ } }, "put": { - "description": "Updates the phrases, the state and the name of the phraselist feature.", + "description": "Updates the phrases, the state and the name of the phraselist feature in a version of the application.", "operationId": "Features_UpdatePhraseList", "parameters": [ { @@ -481,7 +522,7 @@ } }, "delete": { - "description": "Deletes a phraselist feature.", + "description": "Deletes a phraselist feature from a version of the application.", "operationId": "Features_DeletePhraseList", "parameters": [ { @@ -524,7 +565,7 @@ }, "/apps/{appId}/versions/{versionId}/example": { "post": { - "description": "Adds a labeled example to the application.", + "description": "Adds a labeled example utterance in a version of the application.", "operationId": "Examples_Add", "parameters": [ { @@ -540,7 +581,7 @@ "schema": { "$ref": "#/definitions/ExampleLabelObject" }, - "description": "An example label with the expected intent and entities." + "description": "A labeled example utterance with the expected intent and entities." } ], "consumes": [ @@ -548,7 +589,7 @@ ], "responses": { "201": { - "description": "The ID of the created example.", + "description": "The ID of the created example utterance.", "schema": { "$ref": "#/definitions/LabelExampleResponse" } @@ -572,7 +613,7 @@ }, "/apps/{appId}/versions/{versionId}/examples": { "post": { - "description": "Adds a batch of labeled examples to the application.", + "description": "Adds a batch of labeled example utterances to a version of the application.", "operationId": "Examples_Batch", "parameters": [ { @@ -588,7 +629,7 @@ "schema": { "$ref": "#/definitions/ExampleLabelObjectArray" }, - "description": "Array of examples." + "description": "Array of example utterances." } ], "consumes": [ @@ -596,13 +637,13 @@ ], "responses": { "201": { - "description": "A string array determining which labels were added successfully.", + "description": "A string array determining which labeled example utterances were added successfully.", "schema": { "$ref": "#/definitions/BatchLabelExampleResponse" } }, "207": { - "description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labels.", + "description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labeled example utterances.", "schema": { "$ref": "#/definitions/BatchLabelExampleResponse" } @@ -624,7 +665,7 @@ } }, "get": { - "description": "Returns examples to be reviewed.", + "description": "Returns example utterances to be reviewed from a version of the application.", "operationId": "Examples_List", "parameters": [ { @@ -642,7 +683,7 @@ ], "responses": { "200": { - "description": "A list of predictions and label pairs for every example in the application.", + "description": "A list of predictions and label pairs for every example utterance in the application.", "schema": { "$ref": "#/definitions/LabeledUtterances" } @@ -666,7 +707,7 @@ }, "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { "delete": { - "description": "Deletes the labeled example with the specified ID.", + "description": "Deletes the labeled example utterances with the specified ID from a version of the application.", "operationId": "Examples_Delete", "parameters": [ { @@ -685,7 +726,7 @@ ], "responses": { "200": { - "description": "Successfully deleted example label.", + "description": "Successfully deleted example utterance.", "schema": { "$ref": "#/definitions/OperationStatus" } @@ -709,7 +750,7 @@ }, "/apps/{appId}/versions/{versionId}/intents": { "post": { - "description": "Adds an intent classifier to the application.", + "description": "Adds an intent to a version of the application.", "operationId": "Model_AddIntent", "parameters": [ { @@ -725,7 +766,7 @@ "schema": { "$ref": "#/definitions/ModelCreateObject" }, - "description": "A model object containing the name of the new intent classifier." + "description": "A model object containing the name of the new intent." } ], "consumes": [ @@ -733,7 +774,7 @@ ], "responses": { "201": { - "description": "The ID of the created model.", + "description": "The ID of the created intent model.", "x-nullable": false, "schema": { "$ref": "#/definitions/GuidResponse" @@ -750,7 +791,7 @@ } }, "get": { - "description": "Gets information about the intent models.", + "description": "Gets information about the intent models in a version of the application.", "operationId": "Model_ListIntents", "parameters": [ { @@ -792,7 +833,7 @@ }, "/apps/{appId}/versions/{versionId}/entities": { "post": { - "description": "Adds a simple entity extractor to the application.", + "description": "Adds a simple entity extractor to a version of the application.", "operationId": "Model_AddEntity", "parameters": [ { @@ -839,7 +880,7 @@ } }, "get": { - "description": "Gets information about the entity models.", + "description": "Gets information about all the simple entity models in a version of the application.", "operationId": "Model_ListEntities", "parameters": [ { @@ -881,7 +922,7 @@ }, "/apps/{appId}/versions/{versionId}/hierarchicalentities": { "post": { - "description": "Adds a hierarchical entity extractor to the application version.", + "description": "Adds a hierarchical entity extractor to a version of the application.", "operationId": "Model_AddHierarchicalEntity", "parameters": [ { @@ -928,7 +969,7 @@ } }, "get": { - "description": "Gets information about the hierarchical entity models.", + "description": "Gets information about all the hierarchical entity models in a version of the application.", "operationId": "Model_ListHierarchicalEntities", "parameters": [ { @@ -970,7 +1011,7 @@ }, "/apps/{appId}/versions/{versionId}/compositeentities": { "post": { - "description": "Adds a composite entity extractor to the application.", + "description": "Adds a composite entity extractor to a version of the application.", "operationId": "Model_AddCompositeEntity", "parameters": [ { @@ -1017,7 +1058,7 @@ } }, "get": { - "description": "Gets information about the composite entity models.", + "description": "Gets information about all the composite entity models in a version of the application.", "operationId": "Model_ListCompositeEntities", "parameters": [ { @@ -1059,7 +1100,7 @@ }, "/apps/{appId}/versions/{versionId}/closedlists": { "get": { - "description": "Gets information about the closedlist models.", + "description": "Gets information about all the list entity models in a version of the application.", "operationId": "Model_ListClosedLists", "parameters": [ { @@ -1077,7 +1118,7 @@ ], "responses": { "200": { - "description": "A list of closedlist entity model infos.", + "description": "A list of list entity model infos.", "schema": { "$ref": "#/definitions/ClosedListEntityExtractorsList" } @@ -1099,7 +1140,7 @@ } }, "post": { - "description": "Adds a closed list model to the application.", + "description": "Adds a list entity model to a version of the application.", "operationId": "Model_AddClosedList", "parameters": [ { @@ -1115,7 +1156,7 @@ "schema": { "$ref": "#/definitions/ClosedListModelCreateObject" }, - "description": "A model containing the name and words for the new closed list entity extractor." + "description": "A model containing the name and words for the new list entity extractor." } ], "consumes": [ @@ -1148,7 +1189,7 @@ }, "/apps/{appId}/versions/{versionId}/prebuilts": { "post": { - "description": "Adds a list of prebuilt entity extractors to the application.", + "description": "Adds a list of prebuilt entities to a version of the application.", "operationId": "Model_AddPrebuilt", "parameters": [ { @@ -1194,7 +1235,7 @@ } }, "get": { - "description": "Gets information about the prebuilt entity models.", + "description": "Gets information about all the prebuilt entities in a version of the application.", "operationId": "Model_ListPrebuilts", "parameters": [ { @@ -1236,7 +1277,7 @@ }, "/apps/{appId}/versions/{versionId}/listprebuilts": { "get": { - "description": "Gets all the available prebuilt entity extractors for the application.", + "description": "Gets all the available prebuilt entities in a version of the application.", "operationId": "Model_ListPrebuiltEntities", "parameters": [ { @@ -1272,7 +1313,7 @@ }, "/apps/{appId}/versions/{versionId}/models": { "get": { - "description": "Gets information about the application version models.", + "description": "Gets information about all the intent and entity models in a version of the application.", "operationId": "Model_ListModels", "parameters": [ { @@ -1314,7 +1355,7 @@ }, "/apps/{appId}/versions/{versionId}/models/{modelId}/examples": { "get": { - "description": "Gets the utterances for the given model in the given app version.", + "description": "Gets the example utterances for the given intent or entity model in a version of the application.", "operationId": "Model_Examples", "parameters": [ { @@ -1340,7 +1381,7 @@ ], "responses": { "200": { - "description": "A list of examples for the model.", + "description": "A list of example utterances for the model.", "schema": { "$ref": "#/definitions/ExamplesPerModelResponseObject" } @@ -1364,7 +1405,7 @@ }, "/apps/{appId}/versions/{versionId}/intents/{intentId}": { "get": { - "description": "Gets information about the intent model.", + "description": "Gets information about the intent model in a version of the application.", "operationId": "Model_GetIntent", "parameters": [ { @@ -1401,7 +1442,7 @@ } }, "put": { - "description": "Updates the name of an intent classifier.", + "description": "Updates the name of an intent in a version of the application.", "operationId": "Model_UpdateIntent", "parameters": [ { @@ -1420,7 +1461,7 @@ "schema": { "$ref": "#/definitions/ModelUpdateObject" }, - "description": "A model object containing the new intent classifier name." + "description": "A model object containing the new intent name." } ], "consumes": [ @@ -1450,7 +1491,7 @@ } }, "delete": { - "description": "Deletes an intent classifier from the application.", + "description": "Deletes an intent from a version of the application.", "operationId": "Model_DeleteIntent", "parameters": [ { @@ -1466,7 +1507,7 @@ "name": "deleteUtterances", "in": "query", "type": "boolean", - "description": "Also delete the intent's utterances (true). Or move the utterances to the None intent (false - the default value).", + "description": "If true, deletes the intent's example utterances. If false, moves the example utterances to the None intent. The default value is false.", "default": false } ], @@ -1496,7 +1537,7 @@ }, "/apps/{appId}/versions/{versionId}/entities/{entityId}": { "get": { - "description": "Gets information about the entity model.", + "description": "Gets information about an entity model in a version of the application.", "operationId": "Model_GetEntity", "parameters": [ { @@ -1538,7 +1579,7 @@ } }, "put": { - "description": "Updates the name of an entity extractor.", + "description": "Updates the name of an entity in a version of the application.", "operationId": "Model_UpdateEntity", "parameters": [ { @@ -1592,7 +1633,7 @@ } }, "delete": { - "description": "Deletes an entity extractor from the application.", + "description": "Deletes an entity from a version of the application.", "operationId": "Model_DeleteEntity", "parameters": [ { @@ -1636,7 +1677,7 @@ }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { "get": { - "description": "Gets information about the hierarchical entity model.", + "description": "Gets information about a hierarchical entity in a version of the application.", "operationId": "Model_GetHierarchicalEntity", "parameters": [ { @@ -1673,7 +1714,7 @@ } }, "put": { - "description": "Updates the name and children of a hierarchical entity model.", + "description": "Updates the name and children of a hierarchical entity model in a version of the application.", "operationId": "Model_UpdateHierarchicalEntity", "parameters": [ { @@ -1722,7 +1763,7 @@ } }, "delete": { - "description": "Deletes a hierarchical entity extractor from the application version.", + "description": "Deletes a hierarchical entity from a version of the application.", "operationId": "Model_DeleteHierarchicalEntity", "parameters": [ { @@ -1761,7 +1802,7 @@ }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { "get": { - "description": "Gets information about the composite entity model.", + "description": "Gets information about a composite entity in a version of the application.", "operationId": "Model_GetCompositeEntity", "parameters": [ { @@ -1798,7 +1839,7 @@ } }, "put": { - "description": "Updates the composite entity extractor.", + "description": "Updates a composite entity in a version of the application.", "operationId": "Model_UpdateCompositeEntity", "parameters": [ { @@ -1847,7 +1888,7 @@ } }, "delete": { - "description": "Deletes a composite entity extractor from the application.", + "description": "Deletes a composite entity from a version of the application.", "operationId": "Model_DeleteCompositeEntity", "parameters": [ { @@ -1886,7 +1927,7 @@ }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { "get": { - "description": "Gets information of a closed list model.", + "description": "Gets information about a list entity in a version of the application.", "operationId": "Model_GetClosedList", "parameters": [ { @@ -1898,7 +1939,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list model ID.", + "description": "The list model ID.", "required": true, "type": "string", "format": "uuid" @@ -1906,7 +1947,7 @@ ], "responses": { "200": { - "description": "The closed list model info.", + "description": "The list model info.", "schema": { "$ref": "#/definitions/ClosedListEntityExtractor" } @@ -1928,7 +1969,7 @@ } }, "put": { - "description": "Updates the closed list model.", + "description": "Updates the list entity in a version of the application.", "operationId": "Model_UpdateClosedList", "parameters": [ { @@ -1940,7 +1981,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list model ID.", + "description": "The list model ID.", "required": true, "type": "string", "format": "uuid" @@ -1952,7 +1993,7 @@ "schema": { "$ref": "#/definitions/ClosedListModelUpdateObject" }, - "description": "The new entity name and words list." + "description": "The new list entity name and words list." } ], "consumes": [ @@ -1960,7 +2001,7 @@ ], "responses": { "200": { - "description": "Successfully updated Closed List name and words list.", + "description": "Successfully updated list entity name and words list.", "schema": { "$ref": "#/definitions/OperationStatus" } @@ -1982,7 +2023,7 @@ } }, "patch": { - "description": "Adds a batch of sublists to an existing closedlist.", + "description": "Adds a batch of sublists to an existing list entity in a version of the application.", "operationId": "Model_PatchClosedList", "parameters": [ { @@ -1994,7 +2035,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list model ID.", + "description": "The list entity model ID.", "required": true, "type": "string", "format": "uuid" @@ -2014,7 +2055,7 @@ ], "responses": { "200": { - "description": "Successfully added sublists to Closed List.", + "description": "Successfully added sublists to the list entity.", "schema": { "$ref": "#/definitions/OperationStatus" } @@ -2036,7 +2077,7 @@ } }, "delete": { - "description": "Deletes a closed list model from the application.", + "description": "Deletes a list entity model from a version of the application.", "operationId": "Model_DeleteClosedList", "parameters": [ { @@ -2048,7 +2089,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list model ID.", + "description": "The list entity model ID.", "required": true, "type": "string", "format": "uuid" @@ -2056,7 +2097,7 @@ ], "responses": { "200": { - "description": "Successfully delete Closed List from application.", + "description": "Successfully delete list entity from a version of application.", "schema": { "$ref": "#/definitions/OperationStatus" } @@ -2080,7 +2121,7 @@ }, "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { "get": { - "description": "Gets information about the prebuilt entity model.", + "description": "Gets information about a prebuilt entity model in a version of the application.", "operationId": "Model_GetPrebuilt", "parameters": [ { @@ -2122,7 +2163,7 @@ } }, "delete": { - "description": "Deletes a prebuilt entity extractor from the application.", + "description": "Deletes a prebuilt entity extractor from a version of the application.", "operationId": "Model_DeletePrebuilt", "parameters": [ { @@ -2166,7 +2207,7 @@ }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { "delete": { - "description": "Deletes a sublist of a specific closed list model.", + "description": "Deletes a sublist of a specific list entity model from a version of the application.", "operationId": "Model_DeleteSubList", "parameters": [ { @@ -2178,7 +2219,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list entity extractor ID.", + "description": "The list entity extractor ID.", "required": true, "type": "string", "format": "uuid" @@ -2188,7 +2229,8 @@ "in": "path", "description": "The sublist ID.", "required": true, - "type": "integer" + "type": "integer", + "format": "int64" } ], "responses": { @@ -2215,7 +2257,7 @@ } }, "put": { - "description": "Updates one of the closed list's sublists.", + "description": "Updates one of the list entity's sublists in a version of the application.", "operationId": "Model_UpdateSubList", "parameters": [ { @@ -2227,7 +2269,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list entity extractor ID.", + "description": "The list entity extractor ID.", "required": true, "type": "string", "format": "uuid" @@ -2237,7 +2279,8 @@ "in": "path", "description": "The sublist ID.", "required": true, - "type": "integer" + "type": "integer", + "format": "int64" }, { "name": "wordListBaseUpdateObject", @@ -2278,8 +2321,8 @@ }, "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { "get": { - "description": "Suggests examples that would improve the accuracy of the intent model.", - "operationId": "Model_GetIntentSuggestions", + "description": "Suggests example utterances that would improve the accuracy of the intent model in a version of the application.", + "operationId": "Model_ListIntentSuggestions", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -2296,7 +2339,7 @@ ], "responses": { "200": { - "description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm didn't find any relevant queries, an empty list is returned in the response.", + "description": "If there's no trained intent model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the intent model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.", "schema": { "$ref": "#/definitions/IntentsSuggestionExamples" } @@ -2320,8 +2363,8 @@ }, "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { "get": { - "description": "Get suggestion examples that would improve the accuracy of the entity model.", - "operationId": "Model_GetEntitySuggestions", + "description": "Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.", + "operationId": "Model_ListEntitySuggestions", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -2343,7 +2386,7 @@ ], "responses": { "200": { - "description": "If there's no trained model, nothing is returned in the response. If there's a trained model and the active learning algorithm finds any relevant queries, they are returned with the model predictions. If there's a trained model but the active learning algorithm didn't find any relevant queries, an empty list is returned in the response.", + "description": "If there's no trained entity model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the entity model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.", "schema": { "$ref": "#/definitions/EntitiesSuggestionExamples" } @@ -2377,7 +2420,7 @@ "schema": { "$ref": "#/definitions/ApplicationCreateObject" }, - "description": "A model containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is 0.1. Note: the culture cannot be changed after the app is created." + "description": "An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is \"0.1\". Note: the culture cannot be changed after the app is created." } ], "consumes": [ @@ -2408,7 +2451,7 @@ } }, "get": { - "description": "Lists all of the user applications.", + "description": "Lists all of the user's applications.", "operationId": "Apps_List", "parameters": [ { @@ -2444,13 +2487,13 @@ }, "/apps/import": { "post": { - "description": "Imports an application to LUIS, the application's structure should be included in the request body.", + "description": "Imports an application to LUIS, the application's structure is included in the request body.", "operationId": "Apps_Import", "parameters": [ { "name": "appName", "in": "query", - "description": "The application name to create. If not specified, the application name will be read from the imported object.", + "description": "The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.", "type": "string" }, { @@ -2577,7 +2620,7 @@ }, "/apps/cultures": { "get": { - "description": "Gets the supported application cultures.", + "description": "Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,\"en-us\" represents the U.S. variation of English.", "operationId": "Apps_ListSupportedCultures", "responses": { "200": { @@ -2605,7 +2648,7 @@ }, "/apps/{appId}/querylogs": { "get": { - "description": "Gets the query logs of the past month for the application.", + "description": "Gets the logs of the past month's endpoint queries for the application.", "operationId": "Apps_DownloadQueryLogs", "parameters": [ { @@ -2750,7 +2793,7 @@ }, "/apps/{appId}/versions/{versionId}/clone": { "post": { - "description": "Creates a new version using the current snapshot of the selected application version.", + "description": "Creates a new version from the selected version.", "operationId": "Versions_Clone", "parameters": [ { @@ -2762,6 +2805,7 @@ { "name": "versionCloneObject", "in": "body", + "required": true, "schema": { "$ref": "#/definitions/TaskUpdateObject" }, @@ -2773,7 +2817,7 @@ ], "responses": { "201": { - "description": "The version ID of the created task.", + "description": "The new version ID.", "schema": { "type": "string" } @@ -2848,7 +2892,7 @@ }, "/apps/{appId}/versions": { "get": { - "description": "Gets the application versions info.", + "description": "Gets a list of versions for this application ID.", "operationId": "Versions_List", "parameters": [ { @@ -2890,7 +2934,7 @@ }, "/apps/{appId}/versions/{versionId}/": { "get": { - "description": "Gets the version info.", + "description": "Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.", "operationId": "Versions_Get", "parameters": [ { @@ -3088,7 +3132,7 @@ ], "responses": { "200": { - "description": "A successful response provides an array of training status details for a LUIS app that you submitted for training. Each element in the response array provides training status for a model (intent or entity) in the LUIS app. Note: Training status is not provided for prebuilt entities because they are pretrained. The \"modelId\" property identifies which intent or entity the training status corresponds to. To get the name and type of each model, use the models API which has a request URL in this format: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: \"Success\", \"UpToDate\", \"InProgress\", \"Fail\". If the status is \"Fail\", the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled examples were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (\"Z\"), for example: \"2017-08-10T01:08:34Z\".", + "description": "A successful response provides an array of training status details for a LUIS app that you submitted for training. Each element in the response array provides training status for a model (intent or entity) in the LUIS app. Note: Training status is not provided for prebuilt entities because they are pretrained. The \"modelId\" property identifies which intent or entity the training status corresponds to. To get the name and type of each model, use the models API which has a request URL in this format: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: \"Success\", \"UpToDate\", \"InProgress\", \"Fail\". If the status is \"Fail\", the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled example utterances were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (\"Z\"), for example: \"2017-08-10T01:08:34Z\".", "schema": { "$ref": "#/definitions/ModelTrainingInfoList" } @@ -3164,7 +3208,7 @@ }, "/apps/{appId}/settings": { "get": { - "description": "Get the application settings.", + "description": "Get the application settings including 'UseAllTrainingData'.", "operationId": "Apps_GetSettings", "parameters": [ { @@ -3195,7 +3239,7 @@ } }, "put": { - "description": "Updates the application settings.", + "description": "Updates the application settings including 'UseAllTrainingData'.", "operationId": "Apps_UpdateSettings", "parameters": [ { @@ -3240,7 +3284,7 @@ }, "/apps/{appId}/publishsettings": { "get": { - "description": "Get the application publish settings.", + "description": "Get the application publish settings including 'UseAllTrainingData'.", "operationId": "Apps_GetPublishSettings", "parameters": [ { @@ -3271,7 +3315,7 @@ } }, "put": { - "description": "Updates the application publish settings.", + "description": "Updates the application publish settings including 'UseAllTrainingData'.", "operationId": "Apps_UpdatePublishSettings", "parameters": [ { @@ -3316,7 +3360,7 @@ }, "/apps/{appId}/versions/{versionId}/suggest": { "delete": { - "description": "Deleted an unlabelled utterance.", + "description": "Deleted an unlabelled utterance in a version of the application.", "operationId": "Versions_DeleteUnlabelledUtterance", "parameters": [ { @@ -3481,7 +3525,7 @@ } }, "put": { - "description": "Replaces the current users access list with the one sent in the body. If an empty list is sent, all access to other users will be removed.", + "description": "Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.", "operationId": "Permissions_Update", "parameters": [ { @@ -3494,7 +3538,7 @@ "schema": { "$ref": "#/definitions/CollaboratorsArray" }, - "description": "A model containing a list of user's email addresses." + "description": "A model containing a list of user email addresses." } ], "consumes": [ @@ -3559,7 +3603,7 @@ }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { "post": { - "description": "Adds a list to an existing closed list.", + "description": "Adds a sublist to an existing list entity in a version of the application.", "operationId": "Model_AddSubList", "parameters": [ { @@ -3571,7 +3615,7 @@ { "name": "clEntityId", "in": "path", - "description": "The closed list entity extractor ID.", + "description": "The list entity extractor ID.", "required": true, "type": "string", "format": "uuid" @@ -3591,9 +3635,10 @@ ], "responses": { "201": { - "description": "The ID of the newly created list.", + "description": "The ID of the newly created sublist.", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "default": { @@ -3615,7 +3660,7 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { "post": { - "description": "Adds a customizable prebuilt domain along with all of its models to this application.", + "description": "Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.", "operationId": "Model_AddCustomPrebuiltDomain", "parameters": [ { @@ -3639,7 +3684,7 @@ ], "responses": { "201": { - "description": "An array of the created custom prebuilt domain model Ids.", + "description": "An array of the created customizable prebuilt domain intent and entity model Ids.", "schema": { "$ref": "#/definitions/GuidList" } @@ -3663,7 +3708,7 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltintents": { "post": { - "description": "Adds a custom prebuilt intent model to the application.", + "description": "Adds a customizable prebuilt intent model to a version of the application.", "operationId": "Model_AddCustomPrebuiltIntent", "parameters": [ { @@ -3679,7 +3724,7 @@ "schema": { "$ref": "#/definitions/PrebuiltDomainModelCreateObject" }, - "description": "A model object containing the name of the custom prebuilt intent and the name of the domain to which this model belongs." + "description": "A model object containing the name of the customizable prebuilt intent and the name of the domain to which this model belongs." } ], "consumes": [ @@ -3687,7 +3732,7 @@ ], "responses": { "201": { - "description": "The ID of the created model.", + "description": "The ID of the created intent model.", "x-nullable": false, "schema": { "$ref": "#/definitions/GuidResponse" @@ -3710,7 +3755,7 @@ } }, "get": { - "description": "Gets custom prebuilt intents information of this application.", + "description": "Gets information about customizable prebuilt intents added to a version of the application.", "operationId": "Model_ListCustomPrebuiltIntents", "parameters": [ { @@ -3722,7 +3767,7 @@ ], "responses": { "200": { - "description": "Returns a list of all custom prebuilt intents and their representations.", + "description": "Returns a list of all customizable prebuilt intents and their representations in a version of the application.", "schema": { "$ref": "#/definitions/IntentClassifiersList" } @@ -3746,7 +3791,7 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltentities": { "post": { - "description": "Adds a custom prebuilt entity model to the application.", + "description": "Adds a prebuilt entity model to a version of the application.", "operationId": "Model_AddCustomPrebuiltEntity", "parameters": [ { @@ -3762,7 +3807,7 @@ "schema": { "$ref": "#/definitions/PrebuiltDomainModelCreateObject" }, - "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs." + "description": "A model object containing the name of the prebuilt entity and the name of the domain to which this model belongs." } ], "consumes": [ @@ -3770,7 +3815,7 @@ ], "responses": { "201": { - "description": "The ID of the created model.", + "description": "The ID of the created prebuilt model.", "x-nullable": false, "schema": { "$ref": "#/definitions/GuidResponse" @@ -3793,7 +3838,7 @@ } }, "get": { - "description": "Gets all custom prebuilt entities information of this application.", + "description": "Gets all prebuilt entities used in a version of the application.", "operationId": "Model_ListCustomPrebuiltEntities", "parameters": [ { @@ -3805,7 +3850,7 @@ ], "responses": { "200": { - "description": "Returns a list of all custom prebuilt entities and their representations.", + "description": "Returns a list of all prebuilt entities and their representations.", "schema": { "$ref": "#/definitions/EntityExtractorsList" } @@ -3829,7 +3874,7 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { "get": { - "description": "Gets all custom prebuilt models information of this application.", + "description": "Gets all prebuilt intent and entity model information used in a version of this application.", "operationId": "Model_ListCustomPrebuiltModels", "parameters": [ { @@ -3841,7 +3886,7 @@ ], "responses": { "200": { - "description": "Returns a list of all custom prebuilt models and their representations.", + "description": "Returns a list of all prebuilt models and their representations.", "schema": { "$ref": "#/definitions/CustomPrebuiltModelList" } @@ -3865,7 +3910,7 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { "delete": { - "description": "Deletes a prebuilt domain's models from the application.", + "description": "Deletes a prebuilt domain's models in a version of the application.", "operationId": "Model_DeleteCustomPrebuiltDomain", "parameters": [ { @@ -3934,7 +3979,7 @@ } }, "post": { - "description": "Adds a prebuilt domain along with its models as a new application.", + "description": "Adds a prebuilt domain along with its intent and entity models as a new application.", "operationId": "Apps_AddCustomPrebuiltDomain", "parameters": [ { @@ -3977,7 +4022,7 @@ }, "/apps/customprebuiltdomains/{culture}": { "get": { - "description": "Gets all the available custom prebuilt domains for a specific culture.", + "description": "Gets all the available prebuilt domains for a specific culture.", "operationId": "Apps_ListAvailableCustomPrebuiltDomainsForCulture", "parameters": [ { @@ -3990,7 +4035,7 @@ ], "responses": { "200": { - "description": "Returns a list of all domains and their intents/entities representation for a specific culture.", + "description": "Returns a list of all domains and their intents and entities for a specific culture.", "schema": { "$ref": "#/definitions/PrebuiltDomainsList" } @@ -4014,7 +4059,7 @@ }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { "get": { - "description": "Gets information about the hierarchical entity child model.", + "description": "Gets information about the child's model contained in an hierarchical entity child model in a version of the application.", "operationId": "Model_GetHierarchicalEntityChild", "parameters": [ { @@ -4059,7 +4104,7 @@ } }, "put": { - "description": "Renames a single child in an existing hierarchical entity model.", + "description": "Renames a single child in an existing hierarchical entity model in a version of the application.", "operationId": "Model_UpdateHierarchicalEntityChild", "parameters": [ { @@ -4121,7 +4166,7 @@ } }, "delete": { - "description": "Deletes a hierarchical entity extractor child from the application.", + "description": "Deletes a hierarchical entity extractor child in a version of the application.", "operationId": "Model_DeleteHierarchicalEntityChild", "parameters": [ { @@ -4168,7 +4213,7 @@ }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children": { "post": { - "description": "Creates a single child in an existing hierarchical entity model.", + "description": "Creates a single child in an existing hierarchical entity model in a version of the application.", "operationId": "Model_AddHierarchicalEntityChild", "parameters": [ { @@ -4225,7 +4270,7 @@ }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { "post": { - "description": "Creates a single child in an existing composite entity model.", + "description": "Creates a single child in an existing composite entity model in a version of the application.", "operationId": "Model_AddCompositeEntityChild", "parameters": [ { @@ -4282,7 +4327,7 @@ }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { "delete": { - "description": "Deletes a composite entity extractor child from the application.", + "description": "Deletes a composite entity extractor child from a version of the application.", "operationId": "Model_DeleteCompositeEntityChild", "parameters": [ { @@ -4329,8 +4374,8 @@ }, "/apps/{appId}/versions/{versionId}/regexentities": { "get": { - "summary": "Gets information about the regex entity models.", - "operationId": "Model_GetRegexEntityInfos", + "summary": "Gets information about the regular expression entity models in a version of the application.", + "operationId": "Model_ListRegexEntityInfos", "produces": [ "application/json" ], @@ -4350,7 +4395,7 @@ ], "responses": { "200": { - "description": "A list of regex entity model infos.", + "description": "A list of regular expression entity model infos.", "schema": { "$ref": "#/definitions/RegexEntityExtractorList" } @@ -4369,7 +4414,7 @@ } }, "post": { - "summary": "Adds a regex entity model to the application version.", + "summary": "Adds a regular expression entity model to a version of the application.", "operationId": "Model_CreateRegexEntityModel", "consumes": [ "application/json" @@ -4387,7 +4432,7 @@ { "name": "regexEntityExtractorCreateObj", "in": "body", - "description": "A model object containing the name and regex pattern for the new regex entity extractor.", + "description": "A model object containing the name and regex pattern for the new regular expression entity extractor.", "required": true, "schema": { "$ref": "#/definitions/RegexModelCreateObject" @@ -4418,8 +4463,8 @@ }, "/apps/{appId}/versions/{versionId}/patternanyentities": { "get": { - "summary": "Get information about the Pattern.Any entity models.", - "operationId": "Model_GetPatternAnyEntityInfos", + "summary": "Get information about the Pattern.Any entity models in a version of the application.", + "operationId": "Model_ListPatternAnyEntityInfos", "produces": [ "application/json" ], @@ -4458,7 +4503,7 @@ } }, "post": { - "summary": "Adds a pattern.any entity extractor to the application.", + "summary": "Adds a pattern.any entity extractor to a version of the application.", "operationId": "Model_CreatePatternAnyEntityModel", "consumes": [ "application/json" @@ -4507,8 +4552,8 @@ }, "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetEntityRoles", + "summary": "Get all roles for an entity in a version of the application", + "operationId": "Model_ListEntityRoles", "produces": [ "application/json" ], @@ -4549,7 +4594,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create an entity role in a version of the application.", "operationId": "Model_CreateEntityRole", "consumes": [ "application/json" @@ -4606,8 +4651,8 @@ }, "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetPrebuiltEntityRoles", + "summary": "Get a prebuilt entity's roles in a version of the application.", + "operationId": "Model_ListPrebuiltEntityRoles", "produces": [ "application/json" ], @@ -4648,7 +4693,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for a prebuilt entity in a version of the application.", "operationId": "Model_CreatePrebuiltEntityRole", "consumes": [ "application/json" @@ -4705,8 +4750,8 @@ }, "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetClosedListEntityRoles", + "summary": "Get all roles for a list entity in a version of the application.", + "operationId": "Model_ListClosedListEntityRoles", "produces": [ "application/json" ], @@ -4747,7 +4792,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for a list entity in a version of the application.", "operationId": "Model_CreateClosedListEntityRole", "consumes": [ "application/json" @@ -4804,8 +4849,8 @@ }, "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetRegexEntityRoles", + "summary": "Get all roles for a regular expression entity in a version of the application.", + "operationId": "Model_ListRegexEntityRoles", "produces": [ "application/json" ], @@ -4846,7 +4891,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for an regular expression entity in a version of the application.", "operationId": "Model_CreateRegexEntityRole", "consumes": [ "application/json" @@ -4903,8 +4948,8 @@ }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetCompositeEntityRoles", + "summary": "Get all roles for a composite entity in a version of the application", + "operationId": "Model_ListCompositeEntityRoles", "produces": [ "application/json" ], @@ -4940,7 +4985,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for a composite entity in a version of the application.", "operationId": "Model_CreateCompositeEntityRole", "consumes": [ "application/json" @@ -4992,8 +5037,8 @@ }, "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetPatternAnyEntityRoles", + "summary": "Get all roles for a Pattern.any entity in a version of the application", + "operationId": "Model_ListPatternAnyEntityRoles", "produces": [ "application/json" ], @@ -5034,7 +5079,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for an Pattern.any entity in a version of the application.", "operationId": "Model_CreatePatternAnyEntityRole", "consumes": [ "application/json" @@ -5091,8 +5136,8 @@ }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetHierarchicalEntityRoles", + "summary": "Get all roles for a hierarchical entity in a version of the application", + "operationId": "Model_ListHierarchicalEntityRoles", "produces": [ "application/json" ], @@ -5128,7 +5173,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for an hierarchical entity in a version of the application.", "operationId": "Model_CreateHierarchicalEntityRole", "consumes": [ "application/json" @@ -5180,8 +5225,8 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles": { "get": { - "summary": "Get All Entity Roles for a given entity", - "operationId": "Model_GetCustomPrebuiltEntityRoles", + "summary": "Get all roles for a prebuilt entity in a version of the application", + "operationId": "Model_ListCustomPrebuiltEntityRoles", "produces": [ "application/json" ], @@ -5222,7 +5267,7 @@ } }, "post": { - "summary": "Create an entity role for an entity in the application.", + "summary": "Create a role for a prebuilt entity in a version of the application.", "operationId": "Model_CreateCustomPrebuiltEntityRole", "consumes": [ "application/json" @@ -5279,7 +5324,7 @@ }, "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist": { "get": { - "summary": "Get the explicit list of the pattern.any entity.", + "summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.", "operationId": "Model_GetExplicitList", "produces": [ "application/json" @@ -5321,7 +5366,7 @@ } }, "post": { - "summary": "Add a new item to the explicit list for the Pattern.Any entity.", + "summary": "Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.", "operationId": "Model_AddExplicitListItem", "consumes": [ "application/json" @@ -5377,7 +5422,7 @@ }, "/apps/{appId}/versions/{versionId}/regexentities/{regexEntityId}": { "get": { - "summary": "Gets information of a regex entity model.", + "summary": "Gets information about a regular expression entity in a version of the application.", "operationId": "Model_GetRegexEntityEntityInfo", "produces": [ "application/json" @@ -5392,7 +5437,7 @@ { "name": "regexEntityId", "in": "path", - "description": "The regex entity model ID.", + "description": "The regular expression entity model ID.", "required": true, "type": "string", "format": "uuid" @@ -5400,7 +5445,7 @@ ], "responses": { "200": { - "description": "A regex entity model info.", + "description": "A regular expression entity model info.", "schema": { "$ref": "#/definitions/RegexEntityExtractor" } @@ -5419,7 +5464,7 @@ } }, "put": { - "summary": "Updates the regex entity model .", + "summary": "Updates the regular expression entity in a version of the application.", "operationId": "Model_UpdateRegexEntityModel", "consumes": [ "application/json" @@ -5437,7 +5482,7 @@ { "name": "regexEntityId", "in": "path", - "description": "The regex entity extractor ID.", + "description": "The regular expression entity extractor ID.", "required": true, "type": "string", "format": "uuid" @@ -5454,7 +5499,7 @@ ], "responses": { "200": { - "description": "Successfully updated the regex entity extractor.", + "description": "Successfully updated the regular expression entity extractor.", "schema": { "$ref": "#/definitions/OperationStatus" } @@ -5473,7 +5518,7 @@ } }, "delete": { - "summary": "Deletes a regex entity model from the application.", + "summary": "Deletes a regular expression entity from a version of the application.", "operationId": "Model_DeleteRegexEntityModel", "produces": [ "application/json" @@ -5488,7 +5533,7 @@ { "name": "regexEntityId", "in": "path", - "description": "The regex entity extractor ID.", + "description": "The regular expression entity extractor ID.", "required": true, "type": "string", "format": "uuid" @@ -5517,7 +5562,7 @@ }, "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}": { "get": { - "summary": "Gets information about the application version's Pattern.Any model.", + "summary": "Gets information about the Pattern.Any model in a version of the application.", "operationId": "Model_GetPatternAnyEntityInfo", "produces": [ "application/json" @@ -5540,7 +5585,7 @@ ], "responses": { "200": { - "description": "A regex entity model info.", + "description": "A regular expression entity model info.", "schema": { "$ref": "#/definitions/PatternAnyEntityExtractor" } @@ -5559,7 +5604,7 @@ } }, "put": { - "summary": "Updates the name and explicit list of a Pattern.Any entity model.", + "summary": "Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.", "operationId": "Model_UpdatePatternAnyEntityModel", "consumes": [ "application/json" @@ -5613,7 +5658,7 @@ } }, "delete": { - "summary": "Deletes a Pattern.Any entity extractor from the application.", + "summary": "Deletes a Pattern.Any entity extractor from a version of the application.", "operationId": "Model_DeletePatternAnyEntityModel", "produces": [ "application/json" @@ -5657,7 +5702,7 @@ }, "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given entity in a version of the application", "operationId": "Model_GetEntityRole", "produces": [ "application/json" @@ -5707,7 +5752,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given entity in a version of the application.", "operationId": "Model_UpdateEntityRole", "consumes": [ "application/json" @@ -5769,7 +5814,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete an entity role in a version of the application.", "operationId": "Model_DeleteEntityRole", "produces": [ "application/json" @@ -5821,7 +5866,7 @@ }, "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given prebuilt entity in a version of the application", "operationId": "Model_GetPrebuiltEntityRole", "produces": [ "application/json" @@ -5871,7 +5916,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given prebuilt entity in a version of the application", "operationId": "Model_UpdatePrebuiltEntityRole", "consumes": [ "application/json" @@ -5933,7 +5978,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role in a prebuilt entity in a version of the application.", "operationId": "Model_DeletePrebuiltEntityRole", "produces": [ "application/json" @@ -5985,7 +6030,7 @@ }, "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given list entity in a version of the application.", "operationId": "Model_GetClosedListEntityRole", "produces": [ "application/json" @@ -6035,7 +6080,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given list entity in a version of the application.", "operationId": "Model_UpdateClosedListEntityRole", "consumes": [ "application/json" @@ -6097,7 +6142,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role for a given list entity in a version of the application.", "operationId": "Model_DeleteClosedListEntityRole", "produces": [ "application/json" @@ -6149,7 +6194,7 @@ }, "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given regular expression entity in a version of the application.", "operationId": "Model_GetRegexEntityRole", "produces": [ "application/json" @@ -6199,7 +6244,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given regular expression entity in a version of the application", "operationId": "Model_UpdateRegexEntityRole", "consumes": [ "application/json" @@ -6261,7 +6306,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role for a given regular expression in a version of the application.", "operationId": "Model_DeleteRegexEntityRole", "produces": [ "application/json" @@ -6313,7 +6358,7 @@ }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given composite entity in a version of the application", "operationId": "Model_GetCompositeEntityRole", "produces": [ "application/json" @@ -6358,7 +6403,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given composite entity in a version of the application", "operationId": "Model_UpdateCompositeEntityRole", "consumes": [ "application/json" @@ -6415,7 +6460,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role for a given composite entity in a version of the application.", "operationId": "Model_DeleteCompositeEntityRole", "produces": [ "application/json" @@ -6462,7 +6507,7 @@ }, "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given Pattern.any entity in a version of the application.", "operationId": "Model_GetPatternAnyEntityRole", "produces": [ "application/json" @@ -6512,7 +6557,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given Pattern.any entity in a version of the application.", "operationId": "Model_UpdatePatternAnyEntityRole", "consumes": [ "application/json" @@ -6574,7 +6619,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role for a given Pattern.any entity in a version of the application.", "operationId": "Model_DeletePatternAnyEntityRole", "produces": [ "application/json" @@ -6626,7 +6671,7 @@ }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given hierarchical entity in a version of the application.", "operationId": "Model_GetHierarchicalEntityRole", "produces": [ "application/json" @@ -6671,7 +6716,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given hierarchical entity in a version of the application.", "operationId": "Model_UpdateHierarchicalEntityRole", "consumes": [ "application/json" @@ -6728,7 +6773,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role for a given hierarchical role in a version of the application.", "operationId": "Model_DeleteHierarchicalEntityRole", "produces": [ "application/json" @@ -6775,7 +6820,7 @@ }, "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles/{roleId}": { "get": { - "summary": "Get one entity role for a given entity", + "summary": "Get one role for a given prebuilt entity in a version of the application.", "operationId": "Model_GetCustomEntityRole", "produces": [ "application/json" @@ -6825,7 +6870,7 @@ } }, "put": { - "summary": "Update an entity role for a given entity", + "summary": "Update a role for a given prebuilt entity in a version of the application.", "operationId": "Model_UpdateCustomPrebuiltEntityRole", "consumes": [ "application/json" @@ -6887,7 +6932,7 @@ } }, "delete": { - "summary": "Delete an entity role.", + "summary": "Delete a role for a given prebuilt entity in a version of the application.", "operationId": "Model_DeleteCustomEntityRole", "produces": [ "application/json" @@ -6939,7 +6984,7 @@ }, "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist/{itemId}": { "get": { - "summary": "Get the explicit list of the pattern.any entity.", + "summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.", "operationId": "Model_GetExplicitListItem", "produces": [ "application/json" @@ -6989,7 +7034,7 @@ } }, "put": { - "summary": "Updates an explicit list item for a Pattern.Any entity.", + "summary": "Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.", "operationId": "Model_UpdateExplicitListItem", "consumes": [ "application/json" @@ -7051,7 +7096,7 @@ } }, "delete": { - "summary": "Delete the explicit list item from the Pattern.any explicit list.", + "summary": "Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.", "operationId": "Model_DeleteExplicitListItem", "produces": [ "application/json" @@ -7103,7 +7148,7 @@ }, "/apps/{appId}/versions/{versionId}/patternrule": { "post": { - "summary": "Adds one pattern to the specified application.", + "summary": "Adds a pattern to a version of the application.", "operationId": "Pattern_AddPattern", "consumes": [ "application/json" @@ -7151,8 +7196,8 @@ }, "/apps/{appId}/versions/{versionId}/patternrules": { "get": { - "summary": "Returns an application version's patterns.", - "operationId": "Pattern_GetPatterns", + "summary": "Gets patterns in a version of the application.", + "operationId": "Pattern_ListPatterns", "produces": [ "application/json" ], @@ -7191,7 +7236,7 @@ } }, "put": { - "summary": "Updates patterns", + "summary": "Updates patterns in a version of the application.", "operationId": "Pattern_UpdatePatterns", "consumes": [ "application/json" @@ -7240,7 +7285,7 @@ } }, "post": { - "summary": "Adds a batch of patterns to the specified application.", + "summary": "Adds a batch of patterns in a version of the application.", "operationId": "Pattern_BatchAddPatterns", "consumes": [ "application/json" @@ -7289,7 +7334,7 @@ } }, "delete": { - "summary": "Deletes the patterns with the specified IDs.", + "summary": "Deletes a list of patterns in a version of the application.", "operationId": "Pattern_DeletePatterns", "consumes": [ "application/json" @@ -7341,7 +7386,7 @@ }, "/apps/{appId}/versions/{versionId}/patternrules/{patternId}": { "put": { - "summary": "Updates a pattern", + "summary": "Updates a pattern in a version of the application.", "operationId": "Pattern_UpdatePattern", "consumes": [ "application/json" @@ -7395,7 +7440,7 @@ } }, "delete": { - "summary": "Deletes the pattern with the specified ID.", + "summary": "Deletes the pattern with the specified ID from a version of the application..", "operationId": "Pattern_DeletePattern", "produces": [ "application/json" @@ -7439,8 +7484,8 @@ }, "/apps/{appId}/versions/{versionId}/intents/{intentId}/patternrules": { "get": { - "summary": "Returns patterns to be retrieved for the specific intent.", - "operationId": "Pattern_GetIntentPatterns", + "summary": "Returns patterns for the specific intent in a version of the application.", + "operationId": "Pattern_ListIntentPatterns", "produces": [ "application/json" ], @@ -7484,7 +7529,7 @@ }, "/apps/{appId}/versions/{versionId}/settings": { "get": { - "description": "Gets the application version settings.", + "description": "Gets the settings in a version of the application.", "operationId": "Settings_List", "parameters": [ { @@ -7521,7 +7566,7 @@ } }, "put": { - "description": "Updates the application version settings.", + "description": "Updates the settings in a version of the application.", "operationId": "Settings_Update", "parameters": [ { @@ -7535,7 +7580,10 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/AppVersionSettingObject" + "type": "array", + "items": { + "$ref": "#/definitions/AppVersionSettingObject" + } }, "description": "A list of the updated application version settings." } @@ -7569,9 +7617,9 @@ }, "/apps/{appId}/azureaccounts": { "post": { - "description": "Assigns an azure account to the application.", + "description": "Assigns an Azure account to the application.", "operationId": "AzureAccounts_AssignToApp", - "summary": "apps - Assign a LUIS azure account to an application", + "summary": "apps - Assign a LUIS Azure account to an application", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -7585,7 +7633,7 @@ "schema": { "$ref": "#/definitions/AzureAccountInfoObject" }, - "description": "The azure account information object." + "description": "The Azure account information object." } ], "consumes": [ @@ -7615,9 +7663,9 @@ } }, "get": { - "description": "Gets the LUIS azure accounts assigned to the application for the user using his ARM token.", + "description": "Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.", "operationId": "AzureAccounts_GetAssigned", - "summary": "apps - Get LUIS azure accounts assigned to the application", + "summary": "apps - Get LUIS Azure accounts assigned to the application", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -7650,9 +7698,9 @@ } }, "delete": { - "description": "Removes assigned azure account from the application.", + "description": "Removes assigned Azure account from the application.", "operationId": "AzureAccounts_RemoveFromApp", - "summary": "apps - Removes an assigned LUIS azure account from an application", + "summary": "apps - Removes an assigned LUIS Azure account from an application", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -7666,7 +7714,7 @@ "schema": { "$ref": "#/definitions/AzureAccountInfoObject" }, - "description": "The azure account information object." + "description": "The Azure account information object." } ], "consumes": [ @@ -7698,9 +7746,9 @@ }, "/azureaccounts": { "get": { - "description": "Gets the LUIS azure accounts for the user using his ARM token.", - "operationId": "AzureAccounts_GetUserLUISAccounts", - "summary": "user - Get LUIS azure accounts", + "description": "Gets the LUIS Azure accounts for the user using his ARM token.", + "operationId": "AzureAccounts_ListUserLUISAccounts", + "summary": "user - Get LUIS Azure accounts", "parameters": [ { "$ref": "#/parameters/BearerAuthPath" @@ -7708,7 +7756,7 @@ ], "responses": { "200": { - "description": "A list of azure account information objects.", + "description": "A list of Azure account information objects.", "schema": { "$ref": "#/definitions/AzureAccountInfoList" } @@ -7732,7 +7780,7 @@ }, "/package/{appId}/slot/{slotName}/gzip": { "get": { - "description": "Packages published LUIS application as GZip.", + "description": "Packages a published LUIS application as a GZip file to be used in the LUIS container.", "operationId": "Apps_PackagePublishedApplicationAsGzip", "summary": "package - Gets published LUIS application package in binary stream GZip format", "parameters": [ @@ -7770,7 +7818,7 @@ }, "/package/{appId}/versions/{versionId}/gzip": { "get": { - "description": "Packages trained LUIS application as GZip.", + "description": "Packages trained LUIS application as GZip file to be used in the LUIS container.", "operationId": "Apps_PackageTrainedApplicationAsGzip", "summary": "package - Gets trained LUIS application package in binary stream GZip format", "parameters": [ @@ -7904,7 +7952,7 @@ } }, "HierarchicalEntityModel": { - "description": "A Hierarchical Entity Extractor.", + "description": "A hierarchical entity extractor.", "type": "object", "properties": { "children": { @@ -7921,7 +7969,7 @@ } }, "CompositeEntityModel": { - "description": "A composite entity.", + "description": "A composite entity extractor.", "type": "object", "properties": { "children": { @@ -7967,7 +8015,8 @@ "public": { "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", "type": "boolean", - "x-nullable": false + "x-nullable": false, + "x-ms-client-name": "isPublic" } } }, @@ -7993,15 +8042,15 @@ } }, "ExampleLabelObject": { - "description": "A labeled example.", + "description": "A labeled example utterance.", "type": "object", "properties": { "text": { - "description": "The sample's utterance.", + "description": "The example utterance.", "type": "string" }, "entityLabels": { - "description": "The identified entities within the utterance.", + "description": "The identified entities within the example utterance.", "items": { "type": "object", "$ref": "#/definitions/EntityLabelObject" @@ -8009,7 +8058,7 @@ "type": "array" }, "intentName": { - "description": "The identified intent representing the utterance.", + "description": "The identified intent representing the example utterance.", "type": "string" } } @@ -8027,14 +8076,14 @@ "type": "string" }, "isExchangeable": { - "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.", "default": true, "type": "boolean" } } }, "SubClosedList": { - "description": "Sublist of items for a Closed list.", + "description": "Sublist of items for a list entity.", "type": "object", "properties": { "canonicalForm": { @@ -8051,7 +8100,7 @@ } }, "SubClosedListResponse": { - "description": "Sublist of items for a Closed list.", + "description": "Sublist of items for a list entity.", "type": "object", "allOf": [ { @@ -8125,15 +8174,15 @@ } }, "ClosedList": { - "description": "Exported Model - A Closed List.", + "description": "Exported Model - A list entity.", "type": "object", "properties": { "name": { - "description": "Name of the closed list feature.", + "description": "Name of the list entity.", "type": "string" }, "subLists": { - "description": "Sublists for the feature.", + "description": "Sublists for the list entity.", "items": { "type": "object", "$ref": "#/definitions/SubClosedList" @@ -8149,7 +8198,7 @@ } }, "ClosedListModelPatchObject": { - "description": "Object model for adding a batch of sublists to an existing closedlist.", + "description": "Object model for adding a batch of sublists to an existing list entity.", "type": "object", "properties": { "subLists": { @@ -8179,7 +8228,7 @@ "type": "string" }, "mode": { - "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.", "type": "boolean" } } @@ -8209,7 +8258,7 @@ } }, "WordListObject": { - "description": "Sublist of items for a Closed list.", + "description": "Sublist of items for a list entity.", "type": "object", "properties": { "canonicalForm": { @@ -8226,7 +8275,7 @@ } }, "WordListBaseUpdateObject": { - "description": "Object model for updating one of the closed list's sublists.", + "description": "Object model for updating one of the list entity's sublists.", "type": "object", "properties": { "canonicalForm": { @@ -8275,7 +8324,7 @@ } }, "ClosedListModelUpdateObject": { - "description": "Object model for updating a closed list.", + "description": "Object model for updating a list entity.", "type": "object", "properties": { "subLists": { @@ -8287,13 +8336,13 @@ "type": "array" }, "name": { - "description": "The new name of the closed list feature.", + "description": "The new name of the list entity.", "type": "string" } } }, "ClosedListModelCreateObject": { - "description": "Object model for creating a closed list.", + "description": "Object model for creating a list entity.", "type": "object", "properties": { "subLists": { @@ -8305,7 +8354,7 @@ "type": "array" }, "name": { - "description": "Name of the closed list feature.", + "description": "Name of the list entity.", "type": "string" } } @@ -8513,7 +8562,7 @@ "type": "array" }, "closedLists": { - "description": "List of closed lists.", + "description": "List of list entities.", "items": { "type": "object", "$ref": "#/definitions/ClosedList" @@ -8577,7 +8626,7 @@ "type": "array" }, "utterances": { - "description": "List of sample utterances.", + "description": "List of example utterances.", "items": { "type": "object", "$ref": "#/definitions/JSONUtterance" @@ -8617,7 +8666,7 @@ }, "text": { "type": "string", - "description": "The utterance. E.g.: what's the weather like in seattle?" + "description": "The utterance. For example, \"What's the weather like in seattle?\"" }, "tokenizedText": { "type": "array", @@ -8666,11 +8715,11 @@ "properties": { "text": { "type": "string", - "description": "The utterance. E.g.: what's the weather like in seattle?" + "description": "The utterance. For example, \"What's the weather like in seattle?\"" }, "tokenizedText": { "type": "array", - "description": "The utterance tokenized.", + "description": "The tokenized utterance.", "items": { "type": "string" } @@ -8704,7 +8753,7 @@ "properties": { "text": { "type": "string", - "description": "The utterance. E.g.: what's the weather like in seattle?" + "description": "The utterance. For example, \"What's the weather like in seattle?\"" }, "tokenizedText": { "type": "array", @@ -8925,11 +8974,11 @@ "Hierarchical Entity Extractor", "Hierarchical Child Entity Extractor", "Composite Entity Extractor", - "Closed List Entity Extractor", + "List Entity Extractor", "Prebuilt Entity Extractor", "Intent Classifier", "Pattern.Any Entity Extractor", - "Regex Entity Extractor" + "Regular Expression Entity Extractor" ] }, "HierarchicalEntityExtractor": { @@ -8991,9 +9040,9 @@ } }, "ClosedListEntityExtractor": { - "description": "Closed List Entity Extractor.", + "description": "List Entity Extractor.", "type": "object", - "x-ms-discriminator-value": "Closed List Entity Extractor", + "x-ms-discriminator-value": "List Entity Extractor", "allOf": [ { "$ref": "#/definitions/ModelInfo" @@ -9004,7 +9053,7 @@ ], "properties": { "subLists": { - "description": "List of sub-lists.", + "description": "List of sublists.", "type": "array", "items": { "$ref": "#/definitions/SubClosedListResponse" @@ -9013,7 +9062,7 @@ } }, "ClosedListEntityExtractorsList": { - "description": "List of Closed List Entity Extractors.", + "description": "List of List Entity Extractors.", "type": "array", "items": { "$ref": "#/definitions/ClosedListEntityExtractor" @@ -9232,11 +9281,11 @@ } }, "LabelExampleResponse": { - "description": "Response when adding a labeled example.", + "description": "Response when adding a labeled example utterance.", "type": "object", "properties": { "UtteranceText": { - "description": "The sample's utterance.", + "description": "The example utterance.", "type": "string" }, "ExampleId": { @@ -9246,7 +9295,7 @@ } }, "BatchLabelExample": { - "description": "Response when adding a batch of labeled examples.", + "description": "Response when adding a batch of labeled example utterances.", "type": "object", "properties": { "value": { @@ -9261,7 +9310,7 @@ } }, "BatchLabelExampleResponse": { - "description": "Response when adding a batch of labeled examples.", + "description": "Response when adding a batch of labeled example utterances.", "type": "array", "items": { "$ref": "#/definitions/BatchLabelExample" @@ -9285,15 +9334,15 @@ "type": "string" }, "culture": { - "description": "The culture of the application. E.g.: en-us.", + "description": "The culture of the application. For example, \"en-us\".", "type": "string" }, "usageScenario": { - "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", + "description": "Defines the scenario for the new application. Optional. For example, IoT.", "type": "string" }, "domain": { - "description": "The domain for the new application. Optional. E.g.: Comics.", + "description": "The domain for the new application. Optional. For example, Comics.", "type": "string" }, "versionsCount": { @@ -9423,7 +9472,7 @@ "format": "uuid" }, "public": { - "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys for billing purposes.", "type": "boolean", "x-nullable": false, "x-ms-client-name": "isPublic" @@ -9444,19 +9493,19 @@ "format": "uuid" }, "sentimentAnalysis": { - "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response", + "description": "Setting sentiment analysis as true returns the sentiment of the input utterance along with the response", "type": "boolean", "x-nullable": false, "x-ms-client-name": "IsSentimentAnalysisEnabled" }, "speech": { - "description": "Setting speech as public enables speech priming in your app", + "description": "Enables speech priming in your app", "type": "boolean", "x-nullable": false, "x-ms-client-name": "IsSpeechEnabled" }, "spellChecker": { - "description": "Setting spell checker as public enables spell checking the input utterance.", + "description": "Enables spell checking of the utterance.", "type": "boolean", "x-nullable": false, "x-ms-client-name": "IsSpellCheckerEnabled" @@ -9718,11 +9767,11 @@ } }, "RegexModelCreateObject": { - "description": "Model object for creating a regex entity model.", + "description": "Model object for creating a regular expression entity model.", "type": "object", "properties": { "regexPattern": { - "description": "The regex entity pattern.", + "description": "The regular expression entity pattern.", "type": "string" }, "name": { @@ -9749,7 +9798,7 @@ } }, "ExplicitListItemCreateObject": { - "description": "Object model for creating an explicit list item.", + "description": "Object model for creating an explicit (exception) list item.", "type": "object", "properties": { "explicitListItem": { @@ -9759,11 +9808,11 @@ } }, "RegexModelUpdateObject": { - "description": "Model object for updating a regex entity model.", + "description": "Model object for updating a regular expression entity model.", "type": "object", "properties": { "regexPattern": { - "description": "The regex entity pattern.", + "description": "The regular expression entity pattern.", "type": "string" }, "name": { @@ -9800,7 +9849,7 @@ } }, "ExplicitListItemUpdateObject": { - "description": "Model object for updating an explicit list item.", + "description": "Model object for updating an explicit (exception) list item.", "type": "object", "properties": { "explicitListItem": { @@ -9843,7 +9892,7 @@ } }, "RegexEntityExtractor": { - "description": "Regex Entity Extractor.", + "description": "Regular Expression Entity Extractor.", "type": "object", "x-ms-discriminator-value": "Regex Entity Extractor", "allOf": [ @@ -9856,13 +9905,13 @@ ], "properties": { "regexPattern": { - "description": "The Regex entity pattern.", + "description": "The Regular Expression entity pattern.", "type": "string" } } }, "RegexEntityExtractorList": { - "description": "List of Regex Entity Extractors.", + "description": "List of Regular Expression Entity Extractors.", "type": "array", "items": { "$ref": "#/definitions/RegexEntityExtractor" @@ -9916,7 +9965,7 @@ } }, "ExplicitListItem": { - "description": "Explicit list item", + "description": "Explicit (exception) list item", "type": "object", "properties": { "id": { @@ -9931,7 +9980,7 @@ } }, "ExplicitListItemList": { - "description": "List of explicit list items", + "description": "List of explicit (exception) list items", "type": "array", "items": { "$ref": "#/definitions/ExplicitListItem" @@ -9969,14 +10018,14 @@ } }, "ExamplesPerModelResponseObject":{ - "description": "A list of examples per model.", + "description": "A list of example utterances per model.", "type": "array", "items": { "$ref": "#/definitions/LabelTextObject" } }, "LabelTextObject":{ - "description": "An object containing the example's text.", + "description": "An object containing the example utterance's text.", "type": "object", "properties": { "id": { @@ -10079,7 +10128,7 @@ } }, "AzureAccountInfoObject": { - "description": "Defines the azure account information object.", + "description": "Defines the Azure account information object.", "type": "object", "required": [ "azureSubscriptionId", @@ -10088,15 +10137,15 @@ ], "properties": { "azureSubscriptionId": { - "description": "The id for the azure subscription.", + "description": "The id for the Azure subscription.", "type": "string" }, "resourceGroup": { - "description": "The azure resource group name.", + "description": "The Azure resource group name.", "type": "string" }, "accountName": { - "description": "The azure account name.", + "description": "The Azure account name.", "type": "string" } } @@ -10153,7 +10202,6 @@ "description": "The publishing slot name.", "required": true, "type": "string", - "format": "uuid", "x-ms-parameter-location": "method" }, "SkipInPath": { @@ -10183,19 +10231,10 @@ "default": false, "x-ms-parameter-location": "method" }, - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, "BearerAuthPath": { "name": "Authorization", "in": "header", - "description": "The bearer authorization header to use; containing the user's ARM token used to validate azure accounts information.", + "description": "The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.", "required": true, "type": "string", "x-ms-parameter-location": "method"