diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Endpoint API.swagger.json b/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Endpoint API.swagger.json index 0570583550d5..d3f459ed7e4d 100644 --- a/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Endpoint API.swagger.json +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Endpoint API.swagger.json @@ -9,7 +9,7 @@ "parameters": [ { "name": "AzureRegion", - "description": "Supported Azure regions for Cognitive Services endpoints", + "description": "Supported Azure regions for Cognitive Services endpoints.", "x-ms-parameter-location": "client", "required": true, "type": "string", @@ -36,156 +36,110 @@ "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" - }, - "apiKeyQuery": { - "type": "apiKey", - "name": "subscription-key", - "in": "query" } }, - "security": [ - { - "apiKeyHeader": [] - }, - { - "apiKeyQuery": [] - } - ], "paths": { "/{appId}": { + "parameters": [ + { + "name": "appId", + "in": "path", + "description": "Format - guid. The application ID.", + "required": true, + "type": "string" + } + ], "get": { - "description": "Gets the published endpoint predictions for the given query", - "operationId": "v2.0 Response - Get predictions from endpoint", + "description": "Gets the published endpoint predictions for the given query.", + "operationId": "Prediction_GetPredictionsFromEndpointViaGet", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID", + "name": "subscription-key", + "in": "query", + "description": "Either Subscription Key or Programmatic Key.", "required": true, "type": "string" }, { "name": "q", "in": "query", - "description": "The query to predict", + "description": "The query to predict.", "required": true, "type": "string" }, { "name": "timezoneOffset", "in": "query", - "description": "The timezone offset for the location of the request", + "description": "The timezone offset for the location of the request.", "type": "number" }, { "name": "verbose", "in": "query", - "description": "If true will return all intents instead of just the topscoring intent", + "description": "If true will return all intents instead of just the topscoring intent.", "type": "boolean" }, { "name": "spellCheck", "in": "query", - "description": "Enable spell checking", + "description": "Enable spell checking.", "type": "boolean" }, { "name": "staging", "in": "query", - "description": "Use staging endpoint", + "description": "Use staging endpoint.", "type": "boolean" } ], "responses": { "200": { - "description": "A JSON object containing the predictions", - "examples": { - "application/json": { - "query": "forward to frank 30 dollars through HSBC", - "topScoringIntent": { - "intent": "give", - "score": 0.3964121 - }, - "entities": [ - { - "entity": "30", - "type": "builtin.number", - "startIndex": 17, - "endIndex": 18, - "resolution": { - "value": "30" - } - }, - { - "entity": "frank", - "type": "frank", - "startIndex": 11, - "endIndex": 15, - "score": 0.935219169 - }, - { - "entity": "30 dollars", - "type": "builtin.currency", - "startIndex": 17, - "endIndex": 26, - "resolution": { - "unit": "Dollar", - "value": "30" - } - }, - { - "entity": "hsbc", - "type": "Bank", - "startIndex": 36, - "endIndex": 39, - "resolution": { - "values": [ - "BankeName" - ] - } - } - ] - } + "description": "A JSON object containing the predictions.", + "schema": { + "$ref": "#/definitions/LuisResult" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Predictions From Endpoint Via Get request": { + "$ref": "./examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json" + } + } }, "post": { - "description": "Gets the published endpoint prediction for the given long query", - "operationId": "v2.0 Response - Get predictions from endpoint (post)", - "parameters": [ + "description": "Gets the published endpoint prediction for the given long query.", + "operationId": "Prediction_GetPredictionsFromEndpointViaPost", + "security": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID", - "required": true, - "type": "string" - }, + "apiKeyHeader": [] + } + ], + "parameters": [ { "name": "timezoneOffset", "in": "query", - "description": "The timezone offset for the location of the request", + "description": "The timezone offset for the location of the request.", "type": "number" }, { "name": "verbose", "in": "query", - "description": "If true will return all intents instead of just the topscoring intent", + "description": "If true will return all intents instead of just the topscoring intent.", "type": "boolean" }, { "name": "spellCheck", "in": "query", - "description": "Enable spell checking", + "description": "Enable spell checking.", "type": "boolean" }, { "name": "staging", "in": "query", - "description": "Use staging endpoint", + "description": "Use staging endpoint.", "type": "boolean" }, { @@ -194,7 +148,7 @@ "schema": { "$ref": "#/definitions/Q" }, - "description": "The query to predict" + "description": "The query to predict." } ], "consumes": [ @@ -202,60 +156,20 @@ ], "responses": { "200": { - "description": "A JSON object containing the prediction", - "examples": { - "application/json": { - "query": "forward to frank 30 dollars through HSBC", - "topScoringIntent": { - "intent": "give", - "score": 0.3964121 - }, - "entities": [ - { - "entity": "30", - "type": "builtin.number", - "startIndex": 17, - "endIndex": 18, - "resolution": { - "value": "30" - } - }, - { - "entity": "frank", - "type": "frank", - "startIndex": 11, - "endIndex": 15, - "score": 0.935219169 - }, - { - "entity": "30 dollars", - "type": "builtin.currency", - "startIndex": 17, - "endIndex": 26, - "resolution": { - "unit": "Dollar", - "value": "30" - } - }, - { - "entity": "hsbc", - "type": "Bank", - "startIndex": 36, - "endIndex": 39, - "resolution": { - "values": [ - "BankeName" - ] - } - } - ] - } + "description": "A JSON object containing the prediction.", + "schema": { + "$ref": "#/definitions/LuisResult" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples":{ + "Successful Get Predictions From Endpoint Via Post request": { + "$ref": "./examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json" + } + } } } }, @@ -263,6 +177,132 @@ "Q": { "type": "string", "example": "\"forward to frank 30 dollars through HSBC\"" + }, + "LuisResult": { + "type": "object", + "properties": { + "query": { + "type": "string", + "x-nullable": true + }, + "topScoringIntent": { + "$ref": "#/definitions/IntentModel", + "x-nullable": true + }, + "intents": { + "type": "array", + "x-nullable": true, + "items": { + "$ref": "#/definitions/IntentModel" + } + }, + "entities": { + "type": "array", + "x-nullable": true, + "items": { + "$ref": "#/definitions/EntityModel" + } + }, + "compositeEntities": { + "type": "array", + "x-nullable": true, + "description": "The composite entities extracted from the utterance.", + "items": { + "$ref": "#/definitions/CompositeEntityModel" + } + } + } + }, + "CompositeEntityModel": { + "description": "LUIS Composite Entity.", + "type": "object", + "properties": { + "parentType": { + "type": "string", + "description": "Type/name of parent entity." + }, + "value": { + "type": "string", + "description": "Value for composite entity extracted by LUIS." + }, + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/CompositeChildModel" + } + } + }, + "required": [ + "parentType", + "value", + "children" + ] + }, + "CompositeChildModel": { + "description": "Child entity in LUIS composite entity.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of child entity." + }, + "value": { + "type": "string", + "description": "Value extracted by LUIS." + } + }, + "required": [ + "type", + "value" + ] + }, + "IntentModel": { + "description": "Intent returned from LUIS.", + "type": "object", + "properties": { + "intent": { + "type": "string" + }, + "score": { + "type": "number" + } + } + }, + "EntityModel": { + + "properties":{ + "entity": { + "type": "string" + }, + "type": { + "type": "string" + }, + "startIndex": { + "type": "number" + }, + "endIndex": { + "type": "number" + } + } + }, + "SimpleOrCompositeEntity": { + "allOf": [ + { + "$ref": "#/definitions/EntityModel" + } + , + { + "type": "object", + "required": [ + "score" + ], + "properties": { + "score": { + "type": "number" + } + } + } + ] } - } + } } \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Programmatic APIs v2.0.swagger.json b/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Programmatic APIs v2.0.swagger.json index fba1e0adf4e9..18fe67f2ec34 100644 --- a/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Programmatic APIs v2.0.swagger.json +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/LUIS Programmatic APIs v2.0.swagger.json @@ -36,41 +36,27 @@ "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" - }, - "apiKeyQuery": { - "type": "apiKey", - "name": "subscription-key", - "in": "query" } }, "security": [ { "apiKeyHeader": [] - }, - { - "apiKeyQuery": [] } ], "paths": { "/apps/{appId}/versions/{versionId}/patterns": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Creates a new pattern feature.", - "operationId": "features - Create pattern feature", + "operationId": "Features_CreatePatternFeature", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, { "name": "patternCreateObject", "in": "body", @@ -86,107 +72,74 @@ "responses": { "201": { "description": "The ID of the created feature.", - "examples": { - "application/json": "83147" + "schema": { + "$ref": "#/definitions/FeatureIDResponse" } }, - "400": { - "description": "If the REGEX pattern is too complex.", - "examples": { - "application/json": { - "error": { - "code": "BadArgument", - "message": "Regex is too complex" - } - } + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Pattern Feature request": { + "$ref": "./examples/features/SuccessfulCreatePatternFeatureRequest.json" + } + } }, "get": { "description": "Gets all application version pattern features.", - "operationId": "features - Get application version pattern features", + "operationId": "Features_GetApplicationVersionPatternFeatures", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A JSON object containing a list of all pattern features.", - "examples": { - "application/json": "[ { \"id\": 89178, \"name\": \"EmailPattern\", \"pattern\": \"\\\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\\\.[A-Z]{2,}\\\\b\", \"isActive\": true }]" + "schema": { + "$ref": "#/definitions/PatternFeatureInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Pattern Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/phraselists": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Creates a new phraselist feature.", - "operationId": "features - Create phraselist feature", + "operationId": "Features_CreatePhraselistFeature", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, { "name": "phraselistCreateObject", "in": "body", @@ -202,234 +155,149 @@ "responses": { "201": { "description": "The ID of the created feature.", - "examples": { - "application/json": "1823" + "schema": { + "$ref": "#/definitions/FeatureIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Phraselist Feature request": { + "$ref": "./examples/features/SuccessfulCreatePhraselistFeatureRequest.json" + } + } }, "get": { "description": "Gets all application phraselist features.", - "operationId": "features - Get application version phraselist features", + "operationId": "Features_GetApplicationVersionPhraselistFeatures", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A JSON object containing a list of all phraselist features.", - "examples": { - "application/json": "[ { \"id\": 321421, \"name\": \"Cities\", \"phrases\": \"Seattle,New York,Paris,Moscow,Beijin\", \"isExchangeable\": true, \"isActive\": true }, { \"id\": 97832, \"name\": \"DaysOfWeek\", \"phrases\": \"monday,tuesday,wednesday,thursday,friday,saturday,sunday\", \"isExchangeable\": true, \"isActive\": true }]" + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Phraselist Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/features": { "get": { "description": "Gets all application version features.", - "operationId": "features - Get application version features", + "operationId": "Features_GetApplicationVersionFeatures", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A JSON object containing a list of all phraselist features and a list of all pattern featuers in the application.", - "examples": { - "application/json": { - "phraselistFeatures": [ - { - "id": 5341, - "name": "Cities", - "phrases": "Seattle,New York,Paris,Moscow,Beijin", - "isExchangeable": true, - "isActive": true - }, - { - "id": 74598, - "name": "DaysOfWeek", - "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", - "isExchangeable": true, - "isActive": true - } - ], - "patternFeatures": [ - { - "id": 81231, - "name": "EmailPattern", - "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", - "isActive": true - } - ] - } + "schema": { + "$ref": "#/definitions/FeaturesResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern feature ID.", + "required": true, + "type": "integer" + } + ], "get": { "description": "Gets pattern feature info.", - "operationId": "features - Get pattern feature info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "patternId", - "in": "path", - "description": "The pattern feature ID.", - "required": true, - "type": "integer" - } - ], + "operationId": "Features_GetPatternFeatureInfo", "responses": { "200": { "description": "A JSON object containing the pattern feature info.", - "examples": { - "application/json": { - "id": 7892, - "name": "EmailPattern", - "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", - "isActive": true - } + "schema": { + "$ref": "#/definitions/PatternFeatureInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Pattern Feature Info request": { + "$ref": "./examples/features/SuccessfulGetPatternFeatureInfoRequest.json" + } + } }, "put": { "description": "Updates the pattern, the name and the state of the pattern feature.", - "operationId": "features - Update pattern feature", + "operationId": "Features_UpdatePatternFeature", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "patternId", - "in": "path", - "description": "The ID of the feature to be updated.", - "required": true, - "type": "integer" - }, { "name": "patternUpdateObject", "in": "body", @@ -445,112 +313,77 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes a pattern feature from an application version.", - "operationId": "features - Delete pattern feature", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "patternId", - "in": "path", - "description": "The ID of the pattern feature to be deleted.", - "required": true, - "type": "integer" - } - ], + "operationId": "Features_DeletePatternFeature", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be deleted.", + "required": true, + "type": "integer" + } + ], "get": { "description": "Gets phraselist feature info.", - "operationId": "features - Get phraselist feature info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "phraselistId", - "in": "path", - "description": "The phraselist feature ID.", - "required": true, - "type": "integer" - } - ], + "operationId": "Features_GetPhraselistFeatureInfo", "responses": { "200": { "description": "A JSON object containing the phraselist feature info.", - "examples": { - "application/json": { - "id": 178384, - "name": "DaysOfWeek", - "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", - "isExchangeable": true, - "isActive": true - } + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json" + } + } }, "put": { "description": "Updates the phrases, the state and the name of the phraselist feature.", - "operationId": "features - Update phraselist feature", + "operationId": "Features_UpdatePhraselistFeature", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "phraselistId", - "in": "path", - "description": "The ID of the feature to be updated.", - "required": true, - "type": "integer" - }, { "name": "phraselistUpdateObject", "in": "body", @@ -566,38 +399,27 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes a phraselist feature from an application.", - "operationId": "features - Delete phraselist feature", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "operationId": "Features_DeletePhraselistFeature", + "responses": { + "200": { + "description": "" }, - { - "name": "versionId", - "in": "path", - "description": "The version ID of the task.", - "required": true, - "type": "string" - }, - { - "name": "phraselistId", - "in": "path", - "description": "The ID of the feature to be deleted.", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "" + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -605,21 +427,13 @@ "/apps/{appId}/versions/{versionId}/example": { "post": { "description": "Adds a labeled example to the application.", - "operationId": "examples - Add label", + "operationId": "Examples_AddLabel", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "exampleLabelObject", @@ -636,38 +450,41 @@ "responses": { "201": { "description": "The ID of the created example.", - "examples": { - "application/json": { - "UtteranceText": "book me a flight from cairo to redmond next thursday", - "ExampleId": -11 - } + "schema": { + "$ref": "#/definitions/LabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Add Label request": { + "$ref": "./examples/examples/SuccessfulAddLabelRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/examples": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a batch of labeled examples to the specified application.", - "operationId": "examples - Batch add labels", + "operationId": "Examples_BatchAddLabels", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, + { "name": "exampleLabelObjectArray", "in": "body", @@ -683,95 +500,71 @@ "responses": { "201": { "description": "A string array determining which labels were added successfully.", - "examples": { - "application/json": "[ { \"value\": { \"UtteranceText\": \"book me a flight from cairo to redmond next thursday\", \"ExampleId\": -11 }, \"hasError\": false }, { \"value\": { \"UtteranceText\": \"what's the weather like in seattle?\", \"ExampleId\": -12 }, \"hasError\": false }]" + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Batch Add Labels request": { + "$ref": "./examples/examples/SuccessfulBatchAddLabelsRequest.json" + } + } }, "get": { "description": "Returns examples to be reviewed.", - "operationId": "examples - Review labeled examples", + "operationId": "Examples_ReviewLabeledExamples", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of predictions and label pairs for every example in the application.", - "examples": { - "application/json": "[ { \"id\": -12, \"text\": \"what's the weather like in seattle?\", \"tokenizedText\": [ \"what\", \"'\", \"s\", \"the\", \"weather\", \"like\", \"in\", \"seattle\", \"?\" ], \"intentLabel\": \"GetWeather\", \"entityLabels\": [ { \"entityName\": \"Location\", \"startTokenIndex\": 7, \"endTokenIndex\": 7 } ], \"intentPredictions\": [ { \"name\": \"GetWeather\", \"score\": 1 }, { \"name\": \"None\", \"score\": 0.21 }, { \"name\": \"BookFlight\", \"score\": 0 } ], \"entityPredictions\": [ { \"entityName\": \"Location\", \"startIndex\": 7, \"endIndex\": 7, \"phrase\": \"seattle\" } ] }, { \"id\": -11, \"text\": \"book me a flight from cairo to redmond next thursday\", \"tokenizedText\": [ \"book\", \"me\", \"a\", \"flight\", \"from\", \"cairo\", \"to\", \"redmond\", \"next\", \"thursday\" ], \"intentLabel\": \"BookFlight\", \"entityLabels\": [ { \"entityName\": \"Location::To\", \"startTokenIndex\": 7, \"endTokenIndex\": 7 }, { \"entityName\": \"Location::From\", \"startTokenIndex\": 5, \"endTokenIndex\": 5 } ], \"intentPredictions\": [ { \"name\": \"BookFlight\", \"score\": 0.93 }, { \"name\": \"None\", \"score\": 0.41 }, { \"name\": \"GetWeather\", \"score\": 0 } ], \"entityPredictions\": [ { \"entityName\": \"datetime\", \"startIndex\": 8, \"endIndex\": 9, \"phrase\": \"next thursday\" } ] }, { \"id\": -10, \"text\": \"what's the weather like in paris?\", \"tokenizedText\": [ \"what\", \"'\", \"s\", \"the\", \"weather\", \"like\", \"in\", \"paris\", \"?\" ], \"intentLabel\": \"GetWeather\", \"entityLabels\": [ { \"entityName\": \"Location\", \"startTokenIndex\": 7, \"endTokenIndex\": 7 } ], \"intentPredictions\": [ { \"name\": \"GetWeather\", \"score\": 1 }, { \"name\": \"None\", \"score\": 0.18 }, { \"name\": \"BookFlight\", \"score\": 0 } ], \"entityPredictions\": [ { \"entityName\": \"Location\", \"startIndex\": 7, \"endIndex\": 7, \"phrase\": \"paris\" } ] }, { \"id\": -9, \"text\": \"book me a flight from redmond to new york next saturday\", \"tokenizedText\": [ \"book\", \"me\", \"a\", \"flight\", \"from\", \"redmond\", \"to\", \"new\", \"york\", \"next\", \"saturday\" ], \"intentLabel\": \"BookFlight\", \"entityLabels\": [ { \"entityName\": \"Location::To\", \"startTokenIndex\": 7, \"endTokenIndex\": 8 }, { \"entityName\": \"Location::From\", \"startTokenIndex\": 5, \"endTokenIndex\": 5 } ], \"intentPredictions\": [ { \"name\": \"BookFlight\", \"score\": 1 }, { \"name\": \"None\", \"score\": 0.16 }, { \"name\": \"GetWeather\", \"score\": 0 } ], \"entityPredictions\": [ { \"entityName\": \"Location::From\", \"startIndex\": 5, \"endIndex\": 5, \"phrase\": \"redmond\" }, { \"entityName\": \"Location::To\", \"startIndex\": 7, \"endIndex\": 8, \"phrase\": \"new york\" }, { \"entityName\": \"datetime\", \"startIndex\": 9, \"endIndex\": 10, \"phrase\": \"next saturday\" } ] }]" + "schema": { + "$ref": "#/definitions/LabeledUtterances" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Review Labeled Examples request": { + "$ref": "./examples/examples/SuccessfulReviewLabeledExamplesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { "delete": { "description": "Deletes the label with the specified ID.", - "operationId": "examples - Delete example labels", + "operationId": "Examples_DeleteExampleLabels", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "exampleId", @@ -784,29 +577,29 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/intents": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds an intent classifier to the application.", - "operationId": "models - Create intent classifier", + "operationId": "Model_CreateIntentClassifier", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "modelCreateObject", "in": "body", @@ -822,96 +615,68 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8\"" + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Intent Classifier request": { + "$ref": "./examples/model/SuccessfulCreateIntentClassifierRequest.json" + } + } }, "get": { "description": "Gets information about the intent models.", - "operationId": "models - Get application version intent infos", + "operationId": "Model_GetApplicationVersionIntentInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of intent model infos.", - "examples": { - "application/json": "[ { \"id\": \"227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8\", \"name\": \"BookFlight\", \"typeId\": 0, \"readableType\": \"Intent Classifier\" }, { \"id\": \"8285a9ee-6bc0-4409-87f4-82d539f70529\", \"name\": \"None\", \"typeId\": 0, \"readableType\": \"Intent Classifier\" }, { \"id\": \"9500536f-ffec-4fab-93ad-6268abb0f73c\", \"name\": \"$Camera.CapturePhoto\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CapturePhoto\" },]" + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Intent Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/entities": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds an entity extractor to the application.", - "operationId": "models - Create entity extractor", + "operationId": "Model_CreateEntityExtractor", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "modelCreateObject", "in": "body", @@ -927,96 +692,74 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"3d73462d-98f0-4dcd-8d30-fab9e65f2e73\"" + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateEntityExtractorRequest.json" + } + } }, "get": { "description": "Gets information about the entity models.", - "operationId": "models - Get application version entity infos", + "operationId": "Model_GetApplicationVersionEntityInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of entity model infos.", - "examples": { - "application/json": "[ { \"id\": \"3d73462d-98f0-4dcd-8d30-fab9e65f2e73\", \"name\": \"DayOfWeek\", \"typeId\": 1, \"readableType\": \"Entity Extractor\" }, { \"id\": \"b8e31be4-300f-455e-894b-6f079abca0a2\", \"name\": \"$Camera.AppName\", \"typeId\": 1, \"readableType\": \"Entity Extractor\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"AppName\" }]" + "schema": { + "$ref": "#/definitions/EntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a hierarchical entity extractor to the application version.", - "operationId": "models - Create hierarchical entity extractor", + "operationId": "Model_CreateHierarchicalEntityExtractor", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "hierarchicalModelCreateObject", "in": "body", @@ -1032,96 +775,74 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"fe559c31-9778-42ea-ba45-94e0bd7cf767\"" + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Hierarchical Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json" + } + } }, "get": { "description": "Gets information about the hierarchical entity models.", - "operationId": "models - Get application version hierarchical entity infos", + "operationId": "Model_GetApplicationVersionHierarchicalEntityInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of hierarchical entity model infos.", - "examples": { - "application/json": "[ { \"id\": \"fe559c31-9778-42ea-ba45-94e0bd7cf767\", \"name\": \"Location\", \"typeId\": 3, \"readableType\": \"Hierarchical Entity Extractor\", \"children\": [ { \"id\": \"ec076676-d8d9-42fa-a44e-87989c0a2f82\", \"name\": \"From\" }, { \"id\": \"63ebd752-4e81-4ce7-a698-b59b82bf5519\", \"name\": \"To\" } ] }]" + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Hierarchical Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/compositeentities": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a composite entity extractor to the application.", - "operationId": "models - Create composite entity extractor", + "operationId": "Model_CreateCompositeEntityExtractor", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "hierarchicalModelCreateObject", "in": "body", @@ -1137,96 +858,74 @@ "responses": { "201": { "description": "The ID of the created Model.", - "examples": { - "application/json": "\"bc1bae43-7904-48ad-a165-88b1910174f9\"" + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Composite Entity Extractor": { + "$ref": "./examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json" + } + } }, "get": { "description": "Gets information about the composite entity models.", - "operationId": "models - Get application version composite entity infos", + "operationId": "Model_GetApplicationVersionCompositeEntityInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/SkipInPath" }, { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] - }, - { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of composite entity model infos.", - "examples": { - "application/json": "[ { \"id\": \"bc1bae43-7904-48ad-a165-88b1910174f9\", \"name\": \"Reservation\", \"typeId\": 4, \"readableType\": \"Composite Entity Extractor\", \"children\": [ { \"id\": \"63ebd752-4e81-4ce7-a698-b59b82bf5519\", \"name\": \"Location::To\" }, { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\" } ] }]" + "schema": { + "$ref": "#/definitions/CompositeEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Composite Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/closedlists": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a closed list model to the application.", - "operationId": "models - Create closed list entity model", + "operationId": "Model_CreateClosedListEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "closedListModelCreateObject", "in": "body", @@ -1242,96 +941,74 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"8713b104-78ec-4c4f-9f96-f2e53562cc16\"" + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Closed List Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityModelRequest.json" + } + } }, "get": { "description": "Gets information about the closedlist models.", - "operationId": "models - Get application version closed list infos", + "operationId": "Model_GetApplicationVersionClosedListInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of closedlist entity model infos.", - "examples": { - "application/json": "[ { \"id\": \"8713b104-78ec-4c4f-9f96-f2e53562cc16\", \"name\": \"States\", \"typeId\": 5, \"readableType\": \"Closed List Entity Extractor\", \"subLists\": [ { \"id\": 1, \"canonicalForm\": \"new york\", \"list\": [ \"ny\", \"new york\" ] }, { \"id\": 2, \"canonicalForm\": \"washington\", \"list\": [ \"washington\", \"wa\" ] }, { \"id\": 3, \"canonicalForm\": \"california\", \"list\": [ \"california\", \"ca\", \"calif.\", \"cal.\" ] } ] }]" + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Closed List Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/prebuilts": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a list of prebuilt entity extractors to the application.", - "operationId": "models - Add prebuilt entity extractors", + "operationId": "Model_AddPrebuiltEntityExtractors", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "prebuiltExtractorNames", "in": "body", @@ -1349,6 +1026,15 @@ "description": "An array of the created prebuilt extractor infos.", "examples": { "application/json": "[ { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\", \"typeId\": 2, \"readableType\": \"Prebuilt Entity Extractor\" }]" + }, + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -1358,231 +1044,159 @@ }, "get": { "description": "Gets information about the prebuilt entity models.", - "operationId": "models - Get application version prebuilt infos", + "operationId": "Model_GetApplicationVersionPrebuiltInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of prebuilt entity models infos.", - "examples": { - "application/json": "[ { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\", \"typeId\": 2, \"readableType\": \"Prebuilt Entity Extractor\" }]" + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/listprebuilts": { "get": { "description": "Gets all the available prebuilt entity extractors for the application.", - "operationId": "models - Get available prebuilt entity extractors", + "operationId": "Model_GetAvailablePrebuiltEntityExtractors", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "responses": { "200": { "description": "A list of the possible prebuilt entity extractors.", - "examples": { - "application/json": "[ { \"name\": \"geography\", \"description\": \"Continents, Countries, Cities, Post codes, and other points of interest\", \"examples\": \"Antarctica, Portugal, Dubai, Sanjiang County, Lake Pontchartrain, CB3 0DS\" }, { \"name\": \"datetime\", \"description\": \"Dates and times, resolved to a canonical form\", \"examples\": \"June 23, 1976, Jul 11 2012, 7 AM, 6:49 PM, tomorrow at 7 AM\" }, { \"name\": \"email\", \"description\": \"Email Addresses\", \"examples\": \"user@site.net, user_name@mysite.com.eg\" }, { \"name\": \"url\", \"description\": \"Websites URLs\", \"examples\": \"www.website.com, http://website.net?name=my_name&age=10, https://www.mywebsite.net.eg/page\" }, { \"name\": \"phoneNumber\", \"description\": \"US phone numbers\", \"examples\": \"123-456-7890, +1 123 456 789, (123)456-789\" }]" + "schema": { + "$ref": "#/definitions/AvailablePrebuiltEntityModels" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Available Prebuilt Entity Extractors request": { + "$ref": "./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/models": { "get": { "description": "Gets information about the application version models.", - "operationId": "models - Get application version model infos", + "operationId": "Model_GetApplicationVersionModelInfos", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of application models infos.", - "examples": { - "application/json": "[ { \"id\": \"227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8\", \"name\": \"BookFlight\", \"typeId\": 0, \"readableType\": \"Intent Classifier\" }, { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\", \"typeId\": 2, \"readableType\": \"Prebuilt Entity Extractor\" }, { \"id\": \"3d73462d-98f0-4dcd-8d30-fab9e65f2e73\", \"name\": \"DayOfWeek\", \"typeId\": 1, \"readableType\": \"Entity Extractor\" }, { \"id\": \"fe559c31-9778-42ea-ba45-94e0bd7cf767\", \"name\": \"Location\", \"typeId\": 3, \"readableType\": \"Hierarchical Entity Extractor\", \"children\": [ { \"id\": \"ec076676-d8d9-42fa-a44e-87989c0a2f82\", \"name\": \"From\" }, { \"id\": \"63ebd752-4e81-4ce7-a698-b59b82bf5519\", \"name\": \"To\" } ] }, { \"id\": \"8285a9ee-6bc0-4409-87f4-82d539f70529\", \"name\": \"None\", \"typeId\": 0, \"readableType\": \"Intent Classifier\" }, { \"id\": \"bc1bae43-7904-48ad-a165-88b1910174f9\", \"name\": \"Reservation\", \"typeId\": 4, \"readableType\": \"Composite Entity Extractor\", \"children\": [ { \"id\": \"63ebd752-4e81-4ce7-a698-b59b82bf5519\", \"name\": \"Location::To\" }, { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\" } ] }, { \"id\": \"8713b104-78ec-4c4f-9f96-f2e53562cc16\", \"name\": \"States\", \"typeId\": 5, \"readableType\": \"Closed List Entity Extractor\", \"subLists\": [ { \"id\": 1, \"canonicalForm\": \"new york\", \"list\": [ \"ny\", \"new york\" ] }, { \"id\": 2, \"canonicalForm\": \"washington\", \"list\": [ \"washington\", \"wa\" ] }, { \"id\": 3, \"canonicalForm\": \"california\", \"list\": [ \"california\", \"ca\", \"calif.\", \"cal.\" ] } ] }, { \"id\": \"b8e31be4-300f-455e-894b-6f079abca0a2\", \"name\": \"$Camera.AppName\", \"typeId\": 1, \"readableType\": \"Entity Extractor\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"AppName\" }, { \"id\": \"9500536f-ffec-4fab-93ad-6268abb0f73c\", \"name\": \"$Camera.CapturePhoto\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CapturePhoto\" }]" + "schema": { + "$ref": "#/definitions/ModelsResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Model Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/intents/{intentId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + } + ], "get": { "description": "Gets information about the intent model.", - "operationId": "models - Get intent info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "intentId", - "in": "path", - "description": "Format - guid. The intent classifier ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetIntentInfo", "responses": { "200": { "description": "An intent model info.", - "examples": { - "application/json": { - "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", - "name": "None", - "typeId": 0, - "readableType": "Intent Classifier" - } + "schema": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Intent Info request": { + "$ref": "./examples/model/SuccessfulGetIntentInfoRequest.json" + } + } }, "put": { "description": "Updates the name of an intent classifier.", - "operationId": "models - Rename intent model", + "operationId": "Model_RenameIntentModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "intentId", - "in": "path", - "description": "Format - guid. The intent classifier ID.", - "required": true, - "type": "string" - }, { "name": "modelUpdateObject", "in": "body", @@ -1598,111 +1212,77 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes an intent classifier from the application.", - "operationId": "models - Delete intent model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "intentId", - "in": "path", - "description": "Format - guid. The intent classifier ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeleteIntentModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/entities/{entityId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "Format - guid. The entity extractor ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets information about the entity model.", - "operationId": "models - Get entity info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "entityId", - "in": "path", - "description": "Format - guid. The entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetEntityInfo", "responses": { "200": { "description": "An entity model info.", - "examples": { - "application/json": { - "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", - "name": "DayOfWeek", - "typeId": 1, - "readableType": "Entity Extractor" - } + "schema": { + "$ref": "#/definitions/EntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Entity Info request": { + "$ref": "./examples/model/SuccessfulGetEntityInfoRequest.json" + } + } }, "put": { "description": "Updates the name of an entity extractor.", - "operationId": "models - Rename entity model", + "operationId": "Model_RenameEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "entityId", - "in": "path", - "description": "Format - guid. The entity extractor ID.", - "required": true, - "type": "string" - }, { "name": "modelUpdateObject", "in": "body", @@ -1718,121 +1298,73 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes an entity extractor from the application.", - "operationId": "models - Delete entity model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "entityId", - "in": "path", - "description": "Format - guid. The entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeleteEntityModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], "get": { "description": "Gets information about the hierarchical entity model.", - "operationId": "models - Get hierarchical entity info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetHierarchicalEntityInfo", "responses": { "200": { "description": "A hierarchical entity model info.", - "examples": { - "application/json": { - "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", - "name": "Location", - "typeId": 3, - "readableType": "Hierarchical Entity Extractor", - "children": [ - { - "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", - "name": "From" - }, - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "To" - } - ] - } + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json" + } + } }, "put": { "description": "Updates the name and children of a hierarchical entity model.", - "operationId": "models - Update hierarchical entity model", + "operationId": "Model_UpdateHierarchicalEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" - }, { "name": "hierarchicalModelUpdateObject", "in": "body", @@ -1848,121 +1380,73 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes a hierarchical entity extractor from the application version.", - "operationId": "models - Delete hierarchical entity model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeleteHierarchicalEntityModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], "get": { "description": "Gets information about the composite entity model.", - "operationId": "models - Get composite entity info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The composite entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetCompositeEntityInfo", "responses": { "200": { "description": "The composite entity model info.", - "examples": { - "application/json": { - "id": "bc1bae43-7904-48ad-a165-88b1910174f9", - "name": "Reservation", - "typeId": 4, - "readableType": "Composite Entity Extractor", - "children": [ - { - "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", - "name": "Location::To" - }, - { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime" - } - ] - } + "schema": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Composite Entity Info request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityInfoRequest.json" + } + } }, "put": { "description": "Updates the composite entity extractor.", - "operationId": "models - Update composite entity model", + "operationId": "Model_UpdateCompositeEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The composite entity extractor ID.", - "required": true, - "type": "string" - }, { "name": "hierarchicalModelUpdateObject", "in": "body", @@ -1978,139 +1462,77 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes a composite entity extractor from the application.", - "operationId": "models - Delete composite entity model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The composite entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeleteCompositeEntityModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "Format - guid. The closed list model ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets information of a closed list model.", - "operationId": "models - Get closed list entity info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "clEntityId", - "in": "path", - "description": "Format - guid. The closed list model ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetClosedListEntityInfo", "responses": { "200": { "description": "The closed list model info.", - "examples": { - "application/json": { - "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", - "name": "States", - "typeId": 5, - "readableType": "Closed List Entity Extractor", - "subLists": [ - { - "id": 1, - "canonicalForm": "new york", - "list": [ - "ny", - "new york" - ] - }, - { - "id": 2, - "canonicalForm": "washington", - "list": [ - "washington", - "wa" - ] - }, - { - "id": 3, - "canonicalForm": "california", - "list": [ - "california", - "ca", - "calif.", - "cal." - ] - } - ] - } + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityInfoRequest.json" + } + } }, "put": { "description": "Updates the closed list model.", - "operationId": "models - Update closed list entity model", + "operationId": "Model_UpdateClosedListEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "clEntityId", - "in": "path", - "description": "Format - guid. The closed list entity extractor ID.", - "required": true, - "type": "string" - }, { "name": "closedListModelUpdateObject", "in": "body", @@ -2126,34 +1548,19 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "patch": { "description": "Adds a batch of sublists to an existing closedlist.", - "operationId": "models - Patch closed list entity model", + "operationId": "Model_PatchClosedListEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "clEntityId", - "in": "path", - "description": "Format - guid. The closed list entity extractor ID.", - "required": true, - "type": "string" - }, { "name": "closedListModelPatchObject", "in": "body", @@ -2169,191 +1576,131 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes a closed list model from the application.", - "operationId": "models - Delete closed list entity model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "clEntityId", - "in": "path", - "description": "Format - guid. The closed list entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeleteClosedListEntityModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "Format - guid. The prebuilt entity extractor ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets information about the prebuilt entity model.", - "operationId": "models - Get prebuilt info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "prebuiltId", - "in": "path", - "description": "Format - guid. The prebuilt entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetPrebuiltInfo", "responses": { "200": { "description": "A prebuilt entity models info.", - "examples": { - "application/json": { - "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", - "name": "datetime", - "typeId": 2, - "readableType": "Prebuilt Entity Extractor" - } + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltInfoRequest.json" + } + } }, "delete": { "description": "Deletes a prebuilt entity extractor from the application.", - "operationId": "models - Delete prebuilt model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "prebuiltId", - "in": "path", - "description": "Format - guid. The prebuilt entity extractor ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeletePrebuiltModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "Format - guid. The closed list entity extractor ID.", + "required": true, + "type": "string" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer" + } + ], "delete": { "description": "Deletes a sublist of a specific closed list model.", - "operationId": "models - Delete sub list", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "clEntityId", - "in": "path", - "description": "Format - guid. The closed list entity extractor ID.", - "required": true, - "type": "string" - }, - { - "name": "subListId", - "in": "path", - "description": "The sublist ID.", - "required": true, - "type": "integer" - } - ], + "operationId": "Model_DeleteSubList", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "put": { "description": "Updates one of the closed list's sublists", - "operationId": "models - Update closed list's sublist", + "operationId": "Model_UpdateSubList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "clEntityId", - "in": "path", - "description": "Format - guid. The closedlist ID.", - "required": true, - "type": "string" - }, - { - "name": "subListId", - "in": "path", - "description": "Format - long. The sublist ID", - "required": true, - "type": "string" - }, { "name": "wordListBaseUpdateObject", "in": "body", @@ -2369,6 +1716,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2376,43 +1729,19 @@ "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { "get": { "description": "Suggests examples that would improve the accuracy of the intent model.", - "operationId": "models - Suggest endpoint queries for intents", + "operationId": "Model_SuggestEndpointQueriesForIntents", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { - "name": "intentId", - "in": "path", - "description": "Format - guid. The target intent classifier model to enhance.", - "required": true, - "type": "string" + "$ref": "#/parameters/IntentIdInPath" }, { - "name": "take", - "in": "query", - "description": "Maximum number of queries to be returned. Default is set to 10. Maximum is 500.", - "type": "integer", - "default": 10, - "x-nullable": "false", - "x-ms-enum": { - "name": "QueryReturnNumberParameter", - "modelAsString": false - }, - "enum": [ - 10 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { @@ -2421,6 +1750,12 @@ "examples": { "application/json": "[ { \"text\": \"hello, world!\", \"tokenizedText\": [ \"hello\", \",\", \"world\", \"!\" ], \"intentPredictions\": [ { \"name\": \"None\", \"score\": 0.63 }, { \"name\": \"GetWeather\", \"score\": 0 }, { \"name\": \"BookFlight\", \"score\": 0 } ], \"entityPredictions\": [] }]" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2431,21 +1766,13 @@ "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { "get": { "description": "Suggests examples that would improve the accuracy of the entity model.", - "operationId": "models - Suggest endpoint queries for entities", + "operationId": "Model_SuggestEndpointQueriesForEntities", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "entityId", @@ -2455,19 +1782,7 @@ "type": "string" }, { - "name": "take", - "in": "query", - "description": "Maximum number of queries to be returned. Default is set to 10. Maximum is 500.", - "type": "integer", - "default": 10, - "x-nullable": "false", - "x-ms-enum": { - "name": "QueryReturnNumberParameter", - "modelAsString": false - }, - "enum": [ - 10 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { @@ -2476,6 +1791,12 @@ "examples": { "application/json": "[ { \"text\": \"hello, world!\", \"tokenizedText\": [ \"hello\", \",\", \"world\", \"!\" ], \"intentPredictions\": [ { \"name\": \"None\", \"score\": 0.63 }, { \"name\": \"BookFlight\", \"score\": 0 }, { \"name\": \"GetWeather\", \"score\": 0 } ], \"entityPredictions\": [] }]" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2486,7 +1807,7 @@ "/apps/": { "post": { "description": "Creates a new LUIS app.", - "operationId": "apps - Add application", + "operationId": "Apps_AddApplication", "parameters": [ { "name": "applicationCreateObject", @@ -2505,6 +1826,15 @@ "description": "The ID of the created application.", "examples": { "application/json": "\"363187f1-c573-46b3-bc4c-ae01d686e68e\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -2514,56 +1844,43 @@ }, "get": { "description": "Lists all of the user applications.", - "operationId": "apps - Get user applications", + "operationId": "Apps_GetApplicationsList", "parameters": [ { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { "200": { "description": "A list of the user applications.", - "examples": { - "application/json": "[ { \"id\": \"363187f1-c573-46b3-bc4c-ae01d686e68e\", \"name\": \"MyFirstDummyApp\", \"description\": \"This is my first dummy application\", \"culture\": \"en-us\", \"usageScenario\": \"IoT\", \"domain\": \"Comics\", \"versionsCount\": 3, \"createdDateTime\": \"2017-01-31T16:15:54Z\", \"endpoints\": { \"PRODUCTION\": { \"versionId\": \"0.1\", \"isStaging\": false, \"endpointUrl\": \"DummyUrl\", \"assignedEndpointKey\": \"\", \"endpointRegion\":\"westus\", \"publishedDateTime\": \"2017-02-19T17:09:14Z\" } }, \"endpointHitsCount\": 0 }]" + "schema": { + "$ref": "#/definitions/ApplicationsInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Applications List request": { + "$ref": "./examples/apps/SuccessfulGetApplicationsListRequest.json" + } + } } }, "/apps/import": { "post": { "description": "Imports an application to LUIS, the application's JSON should be included in in the request body.", - "operationId": "apps - Import application", + "operationId": "Apps_ImportApplication", "parameters": [ { "name": "appName", @@ -2588,6 +1905,15 @@ "description": "The ID of the imported application.", "examples": { "application/json": "\"f8c64e2a-8635-4a09-8f78-39d7adc76ec5\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -2599,98 +1925,136 @@ "/apps/assistants": { "get": { "description": "Gets the endpoint URLs for the prebuilt Cortana applications.", - "operationId": "apps - Get personal assistant applications", + "operationId": "Apps_GetPersonalAssistantApplications", "responses": { "200": { - "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", - "examples": { - "application/json": { - "endpointKeys": [], - "endpointUrls": { - "English": "EnglishDummyURL", - "Chinese": "ChineseDummyURL", - "French": "FrenchDummyURL", - "Spanish": "SpanishDummyURL", - "Italian": "ItalianDummyURL" - } - } + "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", + "schema": { + "$ref": "#/definitions/PersonalAssistantsResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Personal Assistant Applications": { + "$ref": "./examples/apps/SuccessfulGetPersonalAssistantApplications.json" + } + } } }, "/apps/domains": { "get": { "description": "Gets the available application domains.", - "operationId": "apps - Get application domains", + "operationId": "Apps_GetApplicationDomains", "responses": { "200": { "description": "A list object containing the available application domains.", - "examples": { - "application/json": "[ \"Booking & Reference\", \"Business\", \"Comics\", \"Communication\", \"Education\", \"Entertainment\", \"Finance\", \"Food & Nutrition\", \"Gaming\", \"Health & Fitness\", \"Home Automation\", \"Media & Video\", \"Medical\", \"Music & Audio\", \"Navigation & Maps\", \"News & Magazines\", \"Personalization\", \"Productivity\", \"Real Estate\", \"Scheduler\", \"Shopping\", \"Social Network\", \"Sports\", \"Telecom\", \"Tools\", \"Transportation\", \"Translation\", \"Travel & Local\", \"Weather\", \"Others\"]" + "schema": { + "$ref": "#/definitions/AvailableDomains" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Domains request": { + "$ref": "./examples/apps/SuccessfulGetApplicationDomainsRequest.json" + } + } } }, "/apps/usagescenarios": { "get": { "description": "Gets the application available usage scenarios.", - "operationId": "apps - Get application usage scenarios", + "operationId": "Apps_GetApplicationUsageScenarios", "responses": { "200": { "description": "A list object containing the available application usage scenarios.", - "examples": { - "application/json": "[ \"IoT\", \"Bot\", \"Mobile Application\", \"Other\"]" + "schema": { + "$ref": "#/definitions/ApplicationUsageScenarios" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Usage Scenarios request": { + "$ref": "./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json" + } + } } }, "/apps/cultures": { "get": { "description": "Gets the supported application cultures.", - "operationId": "apps - Get application cultures", + "operationId": "Apps_GetApplicationCultures", "responses": { "200": { "description": "A list object containing the supported application cultures.", - "examples": { - "application/json": "[ { \"name\": \"English\", \"code\": \"en-us\" }, { \"name\": \"Chinese\", \"code\": \"zh-cn\" }, { \"name\": \"French\", \"code\": \"fr-fr\" }, { \"name\": \"Spanish\", \"code\": \"es-es\" }, { \"name\": \"Italian\", \"code\": \"it-it\" }, { \"name\": \"German\", \"code\": \"de-de\" }, { \"name\": \"Japanese\", \"code\": \"ja-jp\" }, { \"name\": \"BRPortuguese\", \"code\": \"pt-br\" }]" + "schema": { + "$ref": "#/definitions/AvailableCultures" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Cultures request": { + "$ref": "./examples/apps/SuccessfulGetApplicationCulturesRequest.json" + } + } } }, "/apps/{appId}/querylogs": { "get": { "description": "Gets the query logs of the past month for the application.", - "operationId": "apps - Download application query logs", + "operationId": "Apps_DownloadApplicationQueryLogs", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "responses": { "200": { "description": "A CSV file containing the query logs for the past month.", - "examples": { - "application/octet-stream": "\"Query\",\"UTC DateTime\",\"Response\"\"hello, world!\",01/31/2017 17:17:41,\"{ \"\"query\"\": \"\"Hello, World!\"\", \"\"topScoringIntent\"\": { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, \"\"intents\"\": [ { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, { \"\"intent\"\": \"\"BookFlight\"\", \"\"score\"\": 0.002136109 }, { \"\"intent\"\": \"\"GetWeather\"\", \"\"score\"\": 0.00142168161 } ], \"\"entities\"\": []}\"" + "schema": { + "type": "file", + "description": "The query logs of an application for the past month in CSV format." + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -2700,61 +2064,41 @@ } }, "/apps/{appId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], "get": { "description": "Gets the application info.", - "operationId": "apps - Get application info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Apps_GetApplicationInfo", "responses": { "200": { "description": "A JSON object containing the application info.", - "examples": { - "application/json": { - "id": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "name": "MyFirstDummyAp", - "description": "This is my first dummy application", - "culture": "en-us", - "usageScenario": "IoT", - "domain": "Comics", - "versionsCount": 3, - "createdDateTime": "2017-01-31T16:15:54Z", - "endpoints": { - "PRODUCTION": { - "versionId": "0.1", - "isStaging": false, - "endpointUrl": "DummyUrl", - "endpointRegion": "westus", - "assignedEndpointKey": "", - "publishedDateTime": "2017-02-19T17:09:14Z" - } - }, - "endpointHitsCount": 0 - } + "schema": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Info request": { + "$ref": "./examples/apps/SuccessfulGetApplicationInfoRequest.json" + } + } }, "put": { "description": "Updates the name or description of the application.", - "operationId": "apps - Rename application", + "operationId": "Apps_RenameApplication", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "applicationUpdateObject", "in": "body", @@ -2770,24 +2114,27 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes an application.", - "operationId": "apps - Delete application", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Apps_DeleteApplication", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2795,21 +2142,13 @@ "/apps/{appId}/versions/{versionId}/clone": { "post": { "description": "Creates a new version equivalent to the current snapshot of the selected application version.", - "operationId": "versions - Clone version", + "operationId": "Versions_CloneVersion", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The application version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "taskUpdateObject", @@ -2829,6 +2168,12 @@ "examples": { "application/json": "\"0.2\"" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2839,14 +2184,10 @@ "/apps/{appId}/publish": { "post": { "description": "Publishes a specific version of the application.", - "operationId": "apps - Publish application", + "operationId": "Apps_PublishApplication", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { "name": "applicationPublishObject", @@ -2863,62 +2204,40 @@ "responses": { "201": { "description": "An object containing the application endpoint URL and its assigned endpoint key.", - "examples": { - "application/json": { - "endpointUrl": "DummyUrl", - "subscription-key": "DummyEndpointKey", - "endpointRegion": "westus", - "isStaging": false - } + "schema": { + "$ref": "#/definitions/ApplicationPublishResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Publish Application request": { + "$ref": "./examples/apps/SuccessfulPublishApplicationRequest.json" + } + } } }, "/apps/{appId}/versions": { "get": { "description": "Gets the application versions info.", - "operationId": "versions - Get application versions", + "operationId": "Versions_GetApplicationVersions", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "skip", - "in": "query", - "description": "The number of entries to skip. Default value is 0.", - "type": "integer", - "default": 0, - "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ] + "$ref": "#/parameters/SkipInPath" }, { - "name": "take", - "in": "query", - "description": "The number of entries to return. Maximum page size is 500. Default is 100.", - "type": "integer", - "default": 100, - "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ] + "$ref": "#/parameters/TakeInPath" } ], "responses": { @@ -2927,6 +2246,12 @@ "examples": { "application/json": "[ { \"version\": \"0.1\", \"createdDateTime\": \"2017-01-31T16:38:06Z\", \"lastModifiedDateTime\": \"2017-01-31T18:04:35Z\", \"lastTrainedDateTime\": \"2017-01-31T17:05:25Z\", \"lastPublishedDateTime\": \"2017-01-31T17:05:37Z\", \"endpointUrl\": \"DummyUrl\", \"assignedEndpointKey\": { \"SubscriptionKey\": \"\", \"SubscriptionName\": \"\" }, \"externalApiKeys\": {}, \"intentsCount\": 3, \"entitiesCount\": 2, \"endpointHitsCount\": 0 }, { \"version\": \"0.2\", \"createdDateTime\": \"2017-01-31T19:10:29Z\", \"lastModifiedDateTime\": \"2017-01-31T19:12:47Z\", \"lastTrainedDateTime\": \"2017-01-31T19:13:00Z\", \"lastPublishedDateTime\": \"2017-01-31T19:13:20Z\", \"endpointUrl\": \"DummyUrl\", \"assignedEndpointKey\": { \"SubscriptionKey\": \"\", \"SubscriptionName\": \"\" }, \"externalApiKeys\": {}, \"intentsCount\": 3, \"entitiesCount\": 2, \"endpointHitsCount\": 0 }]" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2935,25 +2260,17 @@ } }, "/apps/{appId}/versions/{versionId}/": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "get": { "description": "Gets the task info.", - "operationId": "versions - Get application version", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Versions_GetApplicationVersion", "responses": { "200": { "description": "A JSON object containing the task info.", @@ -2975,6 +2292,12 @@ "endpointHitsCount": 0 } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2983,22 +2306,8 @@ }, "put": { "description": "Updates the name or description of the application version.", - "operationId": "versions - Rename application version", + "operationId": "Versions_RenameApplicationVersion", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The application ID.", - "required": true, - "type": "string" - }, { "name": "taskUpdateObject", "in": "body", @@ -3014,31 +2323,27 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes an application version.", - "operationId": "versions - Delete application version", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The application ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Versions_DeleteApplicationVersion", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3046,21 +2351,13 @@ "/apps/{appId}/versions/{versionId}/export": { "get": { "description": "Exports a LUIS application to JSON format.", - "operationId": "versions - Export application version", + "operationId": "Versions_ExportApplicationVersion", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "responses": { @@ -3149,6 +2446,12 @@ ] } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3157,25 +2460,17 @@ } }, "/apps/{appId}/versions/{versionId}/assignedkey": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "get": { "description": "Gets the given application version's subscription key.", - "operationId": "versions - Get application version subscription key", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The id of the app to get the key for.", - "required": true, - "type": "string" - } - ], + "operationId": "Versions_GetApplicationVersionSubscriptionKey", "responses": { "200": { "description": "The subscription key for this application's endpoint.", @@ -3185,6 +2480,12 @@ "subscriptionKey": "DummyKey" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3193,22 +2494,8 @@ }, "put": { "description": "Assigns a subscription key to the given application version.", - "operationId": "versions - Assign subscription key to version", + "operationId": "Versions_AssignSubscriptionKeyToVersion", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The application ID.", - "required": true, - "type": "string" - }, { "name": "keyValue", "in": "body", @@ -3224,29 +2511,29 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/externalKeys": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "put": { "description": "Assigns an external API key to the given application according to the specified key type.", - "operationId": "versions - Update application version external key", + "operationId": "Versions_UpdateApplicationVersionExternalKey", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The application ID.", - "required": true, - "type": "string" - }, { "name": "externalKeyUpdateObject", "in": "body", @@ -3262,28 +2549,18 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "get": { "description": "Gets the given application versions's external keys.", - "operationId": "versions - Get application version external api keys", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The application version ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Versions_GetApplicationVersionExternalApiKeys", "responses": { "200": { "description": "An array containing the external keys.", @@ -3292,6 +2569,12 @@ "BingSpellCheck": "40fd1383c949492cb16d7b082dcaac82" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3302,21 +2585,13 @@ "/apps/{appId}/versions/{versionId}/externalKeys/{keyType}": { "delete": { "description": "Deletes an external API key currently associated to the given application according for the specified key type.", - "operationId": "versions - Delete application version external key", + "operationId": "Versions_DeleteApplicationVersionExternalKey", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "keyType", @@ -3329,98 +2604,84 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/versions/{versionId}/train": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { - "description": "Sends a training request for a version of a specified LUIS app.
This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status.
Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date.
To verify training success, get the training status at least once after training is complete.", - "operationId": "train - Train application version", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - } - ], + "description": "Sends a training request for a version of a specified LUIS app. This POST request initiates a request asynchronously. To determine whether the training request is successful, submit a GET request to get training status. Note: The application version is not fully trained unless all the models (intents and entities) are trained successfully or are up to date. To verify training success, get the training status at least once after training is complete.", + "operationId": "Train_TrainApplicationVersion", "responses": { "202": { - "description": "" + "description": "", + "schema": { + "$ref": "#/definitions/EnqueueTrainingResponse" + } }, - "400": { - "description": "This response can occur if either of the appId or versionId parameters are incorrect.", - "examples": { - "JSON": "{ \"error\": { \"code\": \"BadArgument\", \"message\": \"Cannot find an application with the specified ID\" }}OR{ \"error\": { \"code\": \"BadArgument\", \"message\": \"Cannot find a task with the specified version ID\" }}" + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json", "JSON" - ] + ], + "x-ms-examples": { + "Successful Train Application Version request": { + "$ref": "./examples/train/SuccessfulTrainApplicationVersionRequest.json" + } + } }, "get": { - "description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status.
appID specifies the LUIS app ID.
versionId specifies the version number of the LUIS app. For example, \"0.1\".", - "operationId": "train - Get application version training status", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - } - ], + "description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. \"appID\" specifies the LUIS app ID. \"versionId\" specifies the version number of the LUIS app. For example, \"0.1\".", + "operationId": "Train_GetApplicationVersionTrainingStatus", "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\".", - "examples": { - "application/json": "[ { \"modelId\": \"f9b00d5b-1f2d-421e-bc99-5ff192d0b998\", \"details\": { \"statusId\": 3, \"status\": \"InProgress\", \"exampleCount\": 0 } }, { \"modelId\": \"51403af3-5342-4926-abaa-91172a42e075\", \"details\": { \"statusId\": 2, \"status\": \"UpToDate\", \"exampleCount\": 12, \"trainingDateTime\": \"2017-01-31T21:42:02Z\" } }, { \"modelId\": \"b4cf6402-dc79-4ca3-8666-b0007337e92b\", \"details\": { \"statusId\": 1, \"status\": \"Fail\", \"exampleCount\": 12, \"failureReason\": \"FewLabels\" } }, { \"modelId\": \"e8e3135a-acd9-4164-a65c-e2fedbe78cfa\", \"details\": { \"statusId\": 3, \"status\": \"InProgress\", \"exampleCount\": 0 } }, { \"modelId\": \"3291fac9-6368-4c87-9562-e78cae0fa7c6\", \"details\": { \"statusId\": 0, \"status\": \"Success\", \"exampleCount\": 12, \"trainingDateTime\": \"2017-01-31T21:42:02Z\" } }, { \"modelId\": \"a193efac-ab02-49d7-b005-ee717d45c4f1\", \"details\": { \"statusId\": 3, \"status\": \"InProgress\", \"exampleCount\": 0 } }]" - } - }, - "400": { - "description": "This response can occur for any of the following reasons:
You need to submit a training request before you request training status.
The format of appId is incorrect.
The value of appId is incorrect.
The value of versionId is incorrect.
", - "examples": { - "JSON": "If you need to submit a training request before you request training status:{ \"error\": { \"code\": \"BadArgument\", \"message\": \"Training request is required before getting training status\" }}If the format of appId is incorrect:{ \"error\": { \"code\": \"BadArgument\", \"message\": \"Value cannot be null. Parameter name: source\" }}If the value of appId is incorrect:{ \"error\": { \"code\": \"BadArgument\", \"message\": \"Cannot find an application with the specified ID\" }}If versionId is incorrect:{ \"error\": { \"code\": \"BadArgument\", \"message\": \"Cannot find a task with the specified version ID\" }}" + "schema": { + "$ref": "#/definitions/ModelTrainingInfoList" } }, - "401": { - "description": "The request failed, either because the key is invalid or is not associated with the LUIS app ID.", - "examples": { - "JSON": { - "statusCode": 401, - "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." - } + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json", "JSON" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Training Status request": { + "$ref": "./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json" + } + } } }, "/subscriptions": { "post": { "description": "Adds a subscription key to the user.", - "operationId": "user - Add subscription key", + "operationId": "User_AddSubscriptionKey", "parameters": [ { "name": "userSubscriptionCreateObject", @@ -3444,6 +2705,12 @@ "subscriptionRegion": "westus" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3452,12 +2719,21 @@ }, "get": { "description": "Gets the user's endpoint subscription keys.", - "operationId": "user - Get user subscription keys", + "operationId": "User_GetUserSubscriptionKeys", "responses": { "200": { "description": "A list containing subscription keys info.", "examples": { "application/json": "[ { \"subscriptionKey\": \"dummykey\", \"subscriptionName\": \"DummyName\", \"subscriptionRegion\":\"westus\" }]" + }, + "schema": { + "$ref": "#/definitions/SubscriptionKeyList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -3467,7 +2743,7 @@ }, "put": { "description": "Renames a subscription key owned by the user.", - "operationId": "user - Rename subscription key", + "operationId": "User_RenameSubscriptionKey", "parameters": [ { "name": "body", @@ -3484,6 +2760,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3491,7 +2773,7 @@ "/externalKeys": { "post": { "description": "Adds an external API key to the user.", - "operationId": "user - Add external api key", + "operationId": "User_AddExternalApiKey", "parameters": [ { "name": "externalKeyCreateObject", @@ -3508,18 +2790,30 @@ "responses": { "201": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "get": { "description": "Gets a list of the user's external api keys.", - "operationId": "user - Get user external api keys", + "operationId": "User_GetUserExternalApiKeys", "responses": { "200": { "description": "A list containing user's external keys info.", "examples": { "application/json": "[ { \"type\": \"bingspellcheck\", \"values\": [ \"ee29eff4fe914fe282ad75d16328d717\" ] }]" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3530,14 +2824,20 @@ "/programmatickey": { "put": { "description": "Resets the user programmatic key.", - "operationId": "user - Reset programmatic key", + "operationId": "User_ResetProgrammaticKey", "responses": { "200": { "description": "The new programmatic key.", "examples": { "application/json": "\"NewDummyProgrammaticKey\"" } - } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } }, "produces": [ "application/json" @@ -3547,7 +2847,7 @@ "/subscriptions/{subscriptionKey}": { "delete": { "description": "Deletes a user subscription key.", - "operationId": "user - Delete subscription key", + "operationId": "User_DeleteSubscriptionKey", "parameters": [ { "name": "subscriptionKey", @@ -3560,6 +2860,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3567,7 +2873,7 @@ "/externalKeys/{externalKeyValue}": { "delete": { "description": "Deletes a user external API key.", - "operationId": "user - Delete external api key", + "operationId": "User_DeleteExternalApiKey", "parameters": [ { "name": "externalKeyValue", @@ -3580,6 +2886,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3587,14 +2899,10 @@ "/apps/{appId}/versions/import": { "post": { "description": "Imports a new version into a LUIS application, the version's JSON should be included in in the request body.", - "operationId": "versions - Import version to application", + "operationId": "Versions_ImportVersionToApplication", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { "name": "versionId", @@ -3620,6 +2928,12 @@ "examples": { "application/json": "\"0.2\"" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3628,44 +2942,41 @@ } }, "/apps/{appId}/settings": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], "get": { "description": "Get the application settings", - "operationId": "apps - Get application settings", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Apps_GetApplicationSettings", "responses": { "200": { "description": "A JSON object containing the application settings.", - "examples": { - "application/json": { - "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", - "public": false - } + "schema": { + "$ref": "#/definitions/ApplicationSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Settings request": { + "$ref": "./examples/apps/SuccessfulGetApplicationSettingsRequest.json" + } + } }, "put": { "description": "Updates the application settings", - "operationId": "apps - Update application settings", + "operationId": "Apps_UpdateApplicationSettings", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "applicationSettingUpdateObject", "in": "body", @@ -3681,6 +2992,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3688,21 +3005,13 @@ "/apps/{appId}/versions/{versionId}/suggest": { "delete": { "description": "Deleted an unlabelled utterance.", - "operationId": "versions - Delete unlabelled utterance", + "operationId": "Versions_DeleteUnlabelledUtterance", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "body", @@ -3719,40 +3028,52 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } }, "/apps/{appId}/permissions": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], "get": { "description": "Gets the list of user emails that have permissions to access your application.", - "operationId": "permissions - Get application user access list", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Permissions_GetApplicationUserAccessList", "responses": { "200": { - "description": "" + "description": "The list includes a single owner. All collaborators are listed in the emails array.", + "schema": { + "$ref": "#/definitions/UserAccessList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "successful Get Application User Access List": { + "$ref": "./examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json" } } }, "post": { "description": "Adds a user to the allowed list of users to access this LUIS application.Users are added using their email address.", - "operationId": "permissions - Add user to the access list", + "operationId": "Permissions_AddUserToAccessList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -3768,20 +3089,19 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Removed a user to the allowed list of users to access this LUIS application.Users are removed using their email address.", - "operationId": "permissions - Remove user from access list", + "operationId": "Permissions_RemoveUserFromAccessList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -3797,20 +3117,19 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "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.", - "operationId": "permissions - Update access list", + "operationId": "Permissions_UpdateAccessList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -3826,59 +3145,62 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } - } + }, + "produces": [ + "application/json" + ] } }, "/apps/{appId}/endpoints": { "get": { "description": "Returns the available endpoint deployment regions and urls", - "operationId": "apps - Get endpoints", + "operationId": "Apps_GetEndpoints", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "responses": { "200": { "description": "Returns a list of endpoints regions and their corresponding endpoint URL", - "examples": { - "application/json": { - "westus": "https://westus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", - "eastus2": "https://eastus2.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", - "westcentralus": "https://westcentralus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", - "southeastasia": "https://southeastasia.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" - } + "schema": { + "$ref": "#/definitions/AvailableEndpoints" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Endpoints request": { + "$ref": "./examples/apps/SuccessfulGetEndpointsRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { "post": { "description": "Adds a list to an existing closed list", - "operationId": "models - Add closed list's sublist", + "operationId": "Model_AddSubList", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "clEntityId", @@ -3904,6 +3226,15 @@ "description": "The id of the newly created list", "examples": { "application/json": "90440" + }, + "schema": { + "$ref": "#/definitions/ApplicationsInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -3915,21 +3246,13 @@ "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { "post": { "description": "Adds a customizable prebuilt domain along with all of its models to this application.", - "operationId": "models - Add custom prebuilt domain to application", + "operationId": "Model_AddCustomPrebuiltDomainToApplication", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "prebuiltDomainCreateBaseObject", @@ -3948,6 +3271,15 @@ "description": "An array of the created custom prebuilt domain model Ids.", "examples": { "application/json": "[ \"9500536f-ffec-4fab-93ad-6268abb0f73c\", \"72a15bcc-538a-4e59-be8c-9fdd43b5338f\", \"3397fc83-5b1d-4f5f-b4cd-0f2169f076c6\", \"d116d287-3e53-4bd8-8b7b-4728c58c34d1\", \"facd34fa-86a3-4805-8bf3-b99e40043b10\", \"ad2cac73-2abf-41cb-99e2-f79d0dd6ca46\", \"b8e31be4-300f-455e-894b-6f079abca0a2\", \"70de3f00-3943-4a93-a88c-09392016b776\"]" + }, + "schema": { + "$ref": "#/definitions/GuidList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -3957,24 +3289,18 @@ } }, "/apps/{appId}/versions/{versionId}/customprebuiltintents": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a custom prebuilt intent model to the application", - "operationId": "models - Add custom prebuilt intent model", + "operationId": "Model_AddCustomPrebuiltIntentModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "prebuiltDomainModelCreateObject", "in": "body", @@ -3992,6 +3318,15 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"c0d59374-cf44-4302-98d1-e853886a4674\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4001,28 +3336,21 @@ }, "get": { "description": "Gets custom prebuilt intents information of this application", - "operationId": "models - Get custom prebuilt domain intents info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetCustomPrebuiltDomainIntentsInfo", "responses": { "200": { "description": "Returns a list of all custom prebuilt intents and their representations.", "examples": { "application/json": "[ { \"id\": \"9500536f-ffec-4fab-93ad-6268abb0f73c\", \"name\": \"$Camera.CapturePhoto\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CapturePhoto\" }, { \"id\": \"facd34fa-86a3-4805-8bf3-b99e40043b10\", \"name\": \"$Camera.CaptureScreenshot\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CaptureScreenshot\" }, { \"id\": \"d116d287-3e53-4bd8-8b7b-4728c58c34d1\", \"name\": \"$Camera.CaptureSelfie\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CaptureSelfie\" }, { \"id\": \"ad2cac73-2abf-41cb-99e2-f79d0dd6ca46\", \"name\": \"$Camera.CaptureVideo\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CaptureVideo\" }, { \"id\": \"70de3f00-3943-4a93-a88c-09392016b776\", \"name\": \"$Camera.StartBroadcasting\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"StartBroadcasting\" }, { \"id\": \"3397fc83-5b1d-4f5f-b4cd-0f2169f076c6\", \"name\": \"$Camera.StopBroadcasting\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"StopBroadcasting\" }, { \"id\": \"72a15bcc-538a-4e59-be8c-9fdd43b5338f\", \"name\": \"$Camera.StopVideoRecording\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"StopVideoRecording\" }]" + }, + "schema": { + "$ref": "#/definitions/ModelsResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4032,24 +3360,18 @@ } }, "/apps/{appId}/versions/{versionId}/customprebuiltentities": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], "post": { "description": "Adds a custom prebuilt entity model to the application", - "operationId": "models - Add custom prebuilt entity model", + "operationId": "Model_AddCustomPrebuiltEntityModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, { "name": "prebuiltDomainModelCreateObject", "in": "body", @@ -4067,6 +3389,15 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"1c2e70c1-3cbf-4e89-9703-9583b81102b9\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4076,28 +3407,21 @@ }, "get": { "description": "Gets all custom prebuilt entities information of this application", - "operationId": "models - Get custom prebuilt domain entities info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetCustomPrebuiltDomainEntitiesInfo", "responses": { "200": { "description": "Returns a list of all custom prebuilt entities and their representations.", "examples": { "application/json": "[ { \"id\": \"b8e31be4-300f-455e-894b-6f079abca0a2\", \"name\": \"$Camera.AppName\", \"typeId\": 1, \"readableType\": \"Entity Extractor\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"AppName\" }]" + }, + "schema": { + "$ref": "#/definitions/ModelsResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4109,21 +3433,13 @@ "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { "get": { "description": "Gets all custom prebuilt models information of this application", - "operationId": "models - Get custom prebuilt domain models info", + "operationId": "Model_GetCustomPrebuiltDomainModelsInfo", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "responses": { @@ -4131,6 +3447,15 @@ "description": "Returns a list of all custom prebuilt models and their representations.", "examples": { "application/json": "[ { \"id\": \"b8e31be4-300f-455e-894b-6f079abca0a2\", \"name\": \"$Camera.AppName\", \"typeId\": 1, \"readableType\": \"Entity Extractor\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"AppName\" }, { \"id\": \"9500536f-ffec-4fab-93ad-6268abb0f73c\", \"name\": \"$Camera.CapturePhoto\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CapturePhoto\" }, { \"id\": \"facd34fa-86a3-4805-8bf3-b99e40043b10\", \"name\": \"$Camera.CaptureScreenshot\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CaptureScreenshot\" }, { \"id\": \"d116d287-3e53-4bd8-8b7b-4728c58c34d1\", \"name\": \"$Camera.CaptureSelfie\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CaptureSelfie\" }, { \"id\": \"ad2cac73-2abf-41cb-99e2-f79d0dd6ca46\", \"name\": \"$Camera.CaptureVideo\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"CaptureVideo\" }, { \"id\": \"70de3f00-3943-4a93-a88c-09392016b776\", \"name\": \"$Camera.StartBroadcasting\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"StartBroadcasting\" }, { \"id\": \"3397fc83-5b1d-4f5f-b4cd-0f2169f076c6\", \"name\": \"$Camera.StopBroadcasting\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"StopBroadcasting\" }, { \"id\": \"72a15bcc-538a-4e59-be8c-9fdd43b5338f\", \"name\": \"$Camera.StopVideoRecording\", \"typeId\": 0, \"readableType\": \"Intent Classifier\", \"customPrebuiltDomainName\": \"Camera\", \"customPrebuiltModelName\": \"StopVideoRecording\" }]" + }, + "schema": { + "$ref": "#/definitions/ModelsResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4142,21 +3467,13 @@ "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { "delete": { "description": "Deletes a prebuilt domain's models from the application.", - "operationId": "models - Delete custom prebuilt domain models", + "operationId": "Model_DeleteCustomPrebuiltDomainModels", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { "name": "domainName", @@ -4169,6 +3486,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -4176,22 +3499,33 @@ "/apps/customprebuiltdomains": { "get": { "description": "Gets all the available custom prebuilt domains for all cultures", - "operationId": "apps - Get available custom prebuilt domains", + "operationId": "Apps_GetAvailableCustomPrebuiltDomains", "responses": { "200": { "description": "Returns a list of all custom prebuilt domains and their intents/entities representation", - "examples": { - "application/json": "[ { \"name\": \"taxi\", \"culture\": \"en-us\", \"description\": \"A custom prebuilt domain for taxi booking\", \"examples\": \"book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux\", \"intents\": [ { \"name\": \"book_taxi\", \"description\": \"Requests/Books taxi\", \"examples\": \"book taxi x on friday at 6 pm\" }, { \"name\": \"cancel_taxi\", \"description\": \"Cancels taxi request\", \"examples\": \"I just called an taxi SUV , please cancel, Cancel my taxi\" } ], \"entities\": [ { \"name\": \"from_place_name\", \"description\": \"Route starting point\", \"examples\": \"find taxi x to take me to 9th street from space needle\" } ] }, { \"name\": \"weather\", \"culture\": \"en-us\", \"description\": \"A custom prebuilt domain that gets weather forecast and condition\", \"examples\": \"Show me the weather for this weekend, What's the weather?\", \"intents\": [ { \"name\": \"get_forecast\", \"description\": \"Gets weather forecast\", \"examples\": \"What's the weather like tomorrow?\" }, { \"name\": \"get_condition\", \"description\": \"Gets weather condition\", \"examples\": \"what's the average temperature in India in September?\" } ], \"entities\": [ { \"name\": \"location\", \"description\": \"Location of the queried weather\", \"examples\": \"What's the weather like in Minneapolis\" }, { \"name\": \"unit\", \"description\": \"Temperature measurement unit\", \"examples\": \"Please change the weather from Fahrenheit to Celsius\" } ] }]" + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Available Custom Prebuilt Domains request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json" + } + } }, "post": { "description": "Adds a prebuilt domain along with its models as a new application.", - "operationId": "apps - Add custom prebuilt application", + "operationId": "Apps_AddCustomPrebuiltApplication", "parameters": [ { "name": "prebuiltDomainCreateObject", @@ -4210,6 +3544,15 @@ "description": "The ID of the created application.", "examples": { "application/json": "\"739f1513-11f0-4aae-8a19-f660804e6da5\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4221,7 +3564,7 @@ "/apps/customprebuiltdomains/{culture}": { "get": { "description": "Gets all the available custom prebuilt domains for a specific culture", - "operationId": "apps - Get available custom prebuilt domains for culture", + "operationId": "Apps_GetAvailableCustomPrebuiltDomainsForCulture", "parameters": [ { "name": "culture", @@ -4236,97 +3579,77 @@ "description": "Returns a list of all domains and their intents/entities representation for a specific culture", "examples": { "application/json": "[ { \"name\": \"taxi\", \"culture\": \"en-us\", \"description\": \"A custom prebuilt domain for taxi booking\", \"examples\": \"book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux\", \"intents\": [ { \"name\": \"book_taxi\", \"description\": \"Requests/Books taxi\", \"examples\": \"book taxi x on friday at 6 pm\" }, { \"name\": \"cancel_taxi\", \"description\": \"Cancels taxi request\", \"examples\": \"I just called an taxi SUV , please cancel, Cancel my taxi\" } ], \"entities\": [ { \"name\": \"from_place_name\", \"description\": \"Route starting point\", \"examples\": \"find taxi x to take me to 9th street from space needle\" } ] }, { \"name\": \"weather\", \"culture\": \"en-us\", \"description\": \"A custom prebuilt domain that gets weather forecast and condition\", \"examples\": \"Show me the weather for this weekend, What's the weather?\", \"intents\": [ { \"name\": \"get_forecast\", \"description\": \"Gets weather forecast\", \"examples\": \"What's the weather like tomorrow?\" }, { \"name\": \"get_condition\", \"description\": \"Gets weather condition\", \"examples\": \"what's the average temperature in India in September?\" } ], \"entities\": [ { \"name\": \"location\", \"description\": \"Location of the queried weather\", \"examples\": \"What's the weather like in Minneapolis\" }, { \"name\": \"unit\", \"description\": \"Temperature measurement unit\", \"examples\": \"Please change the weather from Fahrenheit to Celsius\" } ] }]" + }, + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] - } - }, + ], + "x-ms-examples": { + "Successful Get AvailableCustomPrebuiltDomainsForCulture request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json" + } + } + } + }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "Format - guid. The hierarchical entity extractor child ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets information about the hierarchical entity child model.", - "operationId": "models - Get hierarchical entity child info", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor parent ID.", - "required": true, - "type": "string" - }, - { - "name": "hChildId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor child ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_GetHierarchicalEntityChildInfo", "responses": { "200": { "description": "The hierarchical entity child model info.", - "examples": { - "application/json": { - "id": "ef278a6c-d94f-4d20-a602-cf53d0acf0f5", - "name": "From", - "typeId": 6, - "readableType": "Hierarchical Child Entity Extractor" - } + "schema": { + "$ref": "#/definitions/HierarchicalChildEntity" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Child Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json" + } + } }, "put": { "description": "Renames a single child in an existing hierarchical entity model.", - "operationId": "models - Update hierarchical entity child model", + "operationId": "Model_UpdateHierarchicalEntityChildModel", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" - }, - { - "name": "hChildId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor child ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -4342,45 +3665,27 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, "delete": { "description": "Deletes a hierarchical entity extractor child from the application.", - "operationId": "models - Delete hierarchical entity child model", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, - { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" - }, - { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" - }, - { - "name": "hChildId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor child ID.", - "required": true, - "type": "string" - } - ], + "operationId": "Model_DeleteHierarchicalEntityChildModel", "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -4388,28 +3693,16 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children": { "post": { "description": "Creates a single child in an existing hierarchical entity model.", - "operationId": "models - Create hierarchical entity child model", + "operationId": "Model_CreateHierarchicalEntityChildModel", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/HEntityIdInPath" }, { "name": "body", @@ -4428,6 +3721,15 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"891c235f-4f42-4320-bc36-b6256b6c3f2b\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4439,28 +3741,16 @@ "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { "post": { "description": "Creates a single child in an existing composite entity model.", - "operationId": "models - Create composite entity child model", + "operationId": "Model_CreateCompositeEntityChildModel", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The composite entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/CEntityIdInPath" }, { "name": "body", @@ -4479,6 +3769,15 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"891c235f-4f42-4320-bc36-b6256b6c3f2b\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -4490,28 +3789,16 @@ "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { "delete": { "description": "Deletes a composite entity extractor child from the application.", - "operationId": "models - Delete composite entity child model", + "operationId": "Model_DeleteCompositeEntityChildModel", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" }, { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/CEntityIdInPath" }, { "name": "cChildId", @@ -4524,6 +3811,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -4720,6 +4013,20 @@ } } }, + "JSONSubClosedListResponse": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JSONSubClosedList" + } + ], + "properties": { + "id": { + "type": "number", + "example": "123456" + } + } + }, "JSONAction": { "additionalProperties": false, "type": "object", @@ -5174,7 +4481,8 @@ "items": { "type": "string" }, - "type": "array" + "type": "array", + "x-ms-client-name": "bing_entities" }, "actions": { "items": { @@ -5220,6 +4528,908 @@ } }, "example": "{ \"luis_schema_version\": \"1.3.1\", \"name\": \"DummyImportedApp\", \"versionId\": \"0.2\", \"desc\": \"This is my dummy imported application\", \"culture\": \"en-us\", \"intents\": [ { \"name\": \"BookFlight\" }, { \"name\": \"GetWeather\" }, { \"name\": \"None\" } ], \"entities\": [ { \"name\": \"Location\", \"children\": [ \"To\", \"From\" ] } ], \"composites\": [], \"closedLists\": [], \"bing_entities\": [ \"datetime\" ], \"actions\": [], \"model_features\": [ { \"name\": \"Cities\", \"mode\": true, \"words\": \"Seattle,New York,Paris,Moscow,Beijin\", \"activated\": true } ], \"regex_features\": [], \"utterances\": [ { \"text\": \"book me a flight from redmond to new york next saturday\", \"intent\": \"BookFlight\", \"entities\": [ { \"entity\": \"Location::From\", \"startPos\": 5, \"endPos\": 5 }, { \"entity\": \"Location::To\", \"startPos\": 7, \"endPos\": 8 } ] }, { \"text\": \"what's the weather like in paris?\", \"intent\": \"GetWeather\", \"entities\": [ { \"entity\": \"Location\", \"startPos\": 7, \"endPos\": 7 } ] } ]}" + }, + "GuidResponse": { + "type": "string", + "example": "\"363187f1-c573-46b3-bc4c-ae01d686e68e\"" + }, + "FeatureIDResponse": { + "type": "number", + "example": "398102" + }, + "LabeledUtterances": { + "type": "array", + "items": { + "$ref": "#/definitions/LabeledUtterance" + } + }, + "LabeledUtterance": { + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "ID of Labeled Utterance." + }, + "text": { + "type": "string", + "description": "what's the weather like in seattle?" + }, + "tokenizedText": { + "type": "array", + "description": "the utterance tokenized", + "items": { + "type": "string" + } + }, + "intentLabel": { + "type": "string" + }, + "entityLabels": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityLabel" + }, + "x-nullable": true + }, + "intentPredictions": { + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + }, + "x-nullable": true + } + } + }, + "EntityLabel": { + "type": "object", + "properties": { + "entityName": { + "type": "string" + }, + "startTokenIndex": { + "type": "number" + }, + "endTokenIndex": { + "type": "number" + } + }, + "required": [ + "entityName", "startTokenIndex", "endTokenIndex" + ] + }, + "IntentPrediction": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "score": { + "type": "number" + } + } + }, + "EntityPrediction": { + "type": "object", + "properties": { + "entityName": { + "type": "string" + }, + "startIndex": { + "type": "number" + }, + "endIndex": { + "type": "number" + }, + "phrase": { + "type": "string", + "description": "The actual token(s) that comprise the entity." + } + } + }, + "PersonalAssistantsResponse": { + "type": "object", + "description": "Response containing user's endpoint keys and the endpoint URLs of the prebuilt Cortana applications.", + "properties": { + "endpointKeys": { + "$ref": "#/definitions/EndpointKeys" + }, + "endpointUrls": { + "$ref": "#/definitions/PersonalAssistantUrls" + } + } + }, + "EndpointKeys": { + "type": "array", + "description": "An a array of GUIDs, comprised of Azure Endpoint Keys and the Programmatic API key.", + "items": { + "type": "string" + } + }, + "PersonalAssistantUrls": { + "type": "object", + "description": "Endpoint URLs for prebuilt Cortana applications.", + "properties": { + "English": { + "type":"string" + }, + "Chinese": { + "type":"string" + }, + "French": { + "type":"string" + }, + "Spanish": { + "type":"string" + }, + "Italian": { + "type":"string" + } + } + }, + "ModelsResponseObject" : { + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfo" + } + }, + "ModelInfo": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "number", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "readableType" + ], + "discriminator": "readableType" + }, + "ModelInfoResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "number", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "readableType" + ], + "discriminator": "readableType", + "allOf": [ + { "$ref": "#/definitions/HierarchicalEntityExtractor" }, + { "$ref": "#/definitions/CompositeEntityExtractor"}, + { "$ref": "#/definitions/ClosedListEntityExtractor" }, + { "$ref": "#/definitions/IntentClassifier" }, + { "$ref": "#/definitions/EntityExtractor" } + ] + }, + "ReadableType": { + "type": "string", + "enum": [ + "Entity Extractor", + "Hierarchical Entity Extractor", + "Hierarchical Child Entity Extractor", + "Composite Entity Extractor", + "Closed List Entity Extractor", + "Prebuilt Entity Extractor", + "Intent Classifier" + ] + }, + "HierarchicalEntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Hierarchical Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "HierarchicalEntityExtractorsList": { + "type": "array", + "items": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "CompositeEntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Composite Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "CompositeEntityExtractorsList": { + "type": "array", + "items": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "ClosedListEntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Closed List Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "subLists": { + "type": "array", + "items": { + "$ref": "#/definitions/JSONSubClosedListResponse" + } + } + } + }, + "ClosedListEntityExtractorsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "PrebuiltEntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Prebuilt Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ] + }, + "PrebuiltEntityExtractorsList": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "ChildEntity": { + "type": "object", + "description": "The base child entity class.", + "properties": { + "id": { + "type": "string", + "description": "The GUID belonging to a child entity." + }, + "name": { + "type": "string", + "description": "The name of a child entity." + } + } + }, + "HierarchicalChildEntity": { + "type": "object", + "properties": { + "typeId": { + "type": "number" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "allOf": [ + { "$ref": "#/definitions/ChildEntity" } + ] + }, + "IntentClassifier": { + "type": "object", + "x-ms-discriminator-value": "Intent Classifier", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "type": "string", + "x-nullable": true + }, + "customPrebuiltModelName": { + "type": "string", + "x-nullable": true + } + } + }, + "EntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "type": "string", + "x-nullable": true + }, + "customPrebuiltModelName": { + "type": "string", + "x-nullable": true + } + } + }, + "IntentClassifiersList": { + "type": "array", + "items": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "EntityExtractorsList": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityExtractor" + } + }, + "FeaturesResponseObject": { + "type": "object", + "properties": { + "phraselistFeatures": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + }, + "patternFeatures": { + "$ref": "#/definitions/PatternFeatureInfoList" + } + } + }, + "FeatureInfoObject": { + "description": "The base class Features-related response objects inherit from.", + "type": "object", + "properties": { + "id": { + "type": "number", + "description": "A six-digit ID used for Features." + }, + "name": { + "type": "string", + "description": "The name of the Feature." + }, + "isActive": { + "type": "boolean" + } + } + }, + "PatternFeatureInfo": { + "type": "object", + "properties": { + "pattern": { + "type": "string" + } + }, + "allOf": [ + { "$ref": "#/definitions/FeatureInfoObject" } + ] + }, + "PatternFeatureInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternFeatureInfo" + } + }, + "PhraseListFeatureInfo": { + "type": "object", + "properties": { + "phrases": { + "type": "string", + "description": "A list of comma-separated values." + }, + "isExchangeable": { + "type": "boolean" + } + }, + "allOf": [ + { "$ref": "#/definitions/FeatureInfoObject" } + ] + }, + "PhraseListFeatureInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "LabelExampleResponse": { + "type": "object", + "properties": { + "UtteranceText": { + "type": "string", + "example": "book me a flight from cairo to redmond next thursday" + }, + "ExampleId": { + "type": "number", + "example": "-6830368" + } + } + }, + "BatchLabelExample": { + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/LabelExampleResponse" + }, + "hasError": { + "type": "boolean" + } + } + }, + "BatchLabelExampleResponse": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchLabelExample" + } + }, + "ApplicationInfoResponse": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The GUID of the application." + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "culture": { + "type": "string" + }, + "usageScenario": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "versionsCount": { + "type": "number" + }, + "createdDateTime": { + "type": "string" + }, + "endpoints": { + "type": "object" + }, + "endpointHitsCount": { + "type": "number" + }, + "activeVersion": { + "type": "string" + } + } + }, + "ApplicationsInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "ProductionOrStagingEndpointInfo": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EndpointInfo" + } + ] + }, + "EndpointInfo": { + "type": "object", + "description": "The base class \"ProductionOrStagingEndpointInfo\" inherits from.", + "properties": { + "versionId": { + + }, + "isStaging": { + "type": "boolean" + }, + "endpointUrl": { + "type": "string" + }, + "region": { + "type": "string", + "x-nullable": true + }, + "assignedEndpointKey": { + "type": "string" + }, + "endpointRegion": { + "type": "string", + "description": "The endpoint's region." + }, + "publishedDateTime": { + "type": "string" + } + } + }, + "ApplicationPublishResponse": { + "type": "object", + "properties": { + "endpointUrl": { + "type": "string" + }, + "subscription-key": { + "type": "string" + }, + "endpointRegion": { + "type": "string" + }, + "isStaging": { + "type": "boolean" + } + } + }, + "AvailableEndpoints": { + "type": "object", + "description": "Collection of endpoint URLs the selected application is deployed to.", + "properties": { + "westus": { + "type": "string", + "x-nullable": true, + "example": "https://westus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + }, + "eastus2": { + "type": "string", + "x-nullable": true, + "example": "https://eastus2.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + }, + "westcentralus": { + "type": "string", + "x-nullable": true, + "example": "https://westcentralus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + }, + "southeastasia": { + "type": "string", + "x-nullable": true, + "example": "https://southeastasia.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + }, + "westeurope": { + "type": "string", + "x-nullable": true, + "example": "https://westeurope.dev.cognitive.microsoft.com/docs/services/5890b47c39e2bb17b84a55ff/operations/590aff885aca2f09e404ec3f" + } + } + }, + "AvailableCulture": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "code": { + "type": "string" + } + } + }, + "AvailableCultures": { + "type": "array", + "description": "A list object containing the available application domains.", + "items": { + "$ref": "#/definitions/AvailableCulture" + } + }, + "AvailableDomains": { + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationUsageScenarios": { + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationSettings": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "public": { + "type": "boolean" + } + } + }, + "AvailablePrebuiltEntityModel": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + } + } + }, + "AvailablePrebuiltEntityModels": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrebuiltEntityModel" + } + }, + "EnqueueTrainingResponse": { + "type": "object", + "properties": { + "statusId": { + "type": "number" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + } + } + }, + "TrainingStatus": { + "type": "string", + "enum": [ + "Queued", + "InProgress", + "UpToDate", + "Fail", + "Success" + ] + }, + "ModelTrainingInfo": { + "type": "object", + "properties": { + "modelId": { + "type": "string", + "description": "The GUID of the model." + }, + "details": { + "$ref": "#/definitions/ModelTrainingDetails" + } + } + }, + "ModelTrainingDetails": { + "type": "object", + "properties": { + "statusId": { + "type": "number" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + }, + "exampleCount": { + "type": "number" + }, + "trainingDateTime": { + "type": "string" + }, + "failureReason": { + "type": "string", + "x-ms-nullable": true + } + } + }, + "ModelTrainingInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/ModelTrainingInfo" + } + }, + "PrebuiltDomain": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "culture": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + }, + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainModel" + } + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainModel" + } + } + } + }, + "UserAccessList": { + "type": "object", + "properties": { + "owner": { + "type": "string", + "description": "The email address of owner of the application." + }, + "emails": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseDetails" + } + } + }, + "ErrorResponseDetails": { + "type": "object", + "properties": { + "code": { + "type": "string", + "example": "BadArgument", + "x-nullable": true + }, + "statusCode": { + "type": "number", + "example": "401", + "x-nullable": true + }, + "message": { + "type": "string", + "example": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." + } + } + }, + "PrebuiltDomainsList": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomain" + } + }, + "PrebuiltDomainModel": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + } + } + }, + "GuidList": { + "type": "array", + "items": { + "$ref": "#/definitions/GuidResponse" + } + }, + "SubscriptionKeyList": { + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionKeyInfo" + } + }, + "SubscriptionKeyInfo": { + "type": "object", + "properties": { + "subscriptionKey": { + "type": "string" + }, + "subscriptionName": { + "type": "string" + }, + "subscriptionRegion": { + "type": "string" + } + } + } + }, + "parameters": { + "AppIdInPath": { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "description": "Format - guid. The application ID.", + "x-ms-parameter-location": "method" + }, + "VersionIdInPath": { + "name": "versionId", + "in": "path", + "description": "The version ID of the task.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CEntityIdInPath": { + "name": "cEntityId", + "in": "path", + "description": "Format - guid. The hierarchical entity extractor ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "HEntityIdInPath": { + "name": "hEntityId", + "in": "path", + "description": "Format - guid. The hierarchical entity extractor ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IntentIdInPath": { + "name": "intentId", + "in": "path", + "description": "Format - guid. The intent classifier ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SkipInPath": { + "name": "skip", + "in": "query", + "description": "The number of entries to skip. Default value is 0.", + "type": "integer", + "default": 0, + "x-nullable": "false", + "x-ms-parameter-location": "method" + }, + "TakeInPath": { + "name": "take", + "in": "query", + "description": "The number of entries to return. Maximum page size is 500. Default is 100.", + "type": "integer", + "default": 100, + "x-nullable": "false", + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json new file mode 100644 index 000000000000..7bafb6f0cb6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": "\"Query\",\"UTC DateTime\",\"Response\" \"hello, world!\",01/31/2017 17:17:41,\"{ \"\"query\"\": \"\"Hello, World!\"\", \"\"topScoringIntent\"\": { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, \"\"intents\"\": [ { \"\"intent\"\": \"\"None\"\", \"\"score\"\": 0.6277761 }, { \"\"intent\"\": \"\"BookFlight\"\", \"\"score\"\": 0.002136109 }, { \"\"intent\"\": \"\"GetWeather\"\", \"\"score\"\": 0.00142168161 } ], \"\"entities\"\": []}\"" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json new file mode 100644 index 000000000000..a8b748ac4d97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "English", + "code": "en-us" + }, + { + "name": "Chinese", + "code": "zh-cn" + }, + { + "name": "French", + "code": "fr-fr" + }, + { + "name": "French Canadian", + "code": "fr-ca" + }, + { + "name": "Spanish", + "code": "es-es" + }, + { + "name": "Spanish Mexican", + "code": "es-mx" + }, + { + "name": "Italian", + "code": "it-it" + }, + { + "name": "German", + "code": "de-de" + }, + { + "name": "Japanese", + "code": "ja-jp" + }, + { + "name": "Brazilian Portuguese", + "code": "pt-br" + }, + { + "name": "Korean", + "code": "ko-kr" + }, + { + "name": "Dutch", + "code": "nl-nl" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json new file mode 100644 index 000000000000..bdb83c876421 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "Booking & Reference", + "Business", + "Comics", + "Communication", + "Education", + "Entertainment", + "Finance", + "Food & Nutrition", + "Gaming", + "Health & Fitness", + "Home Automation", + "Media & Video", + "Medical", + "Music & Audio", + "Navigation & Maps", + "News & Magazines", + "Personalization", + "Productivity", + "Real Estate", + "Scheduler", + "Shopping", + "Social Network", + "Sports", + "Telecom", + "Tools", + "Transportation", + "Translation", + "Travel & Local", + "Weather", + "Others" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json new file mode 100644 index 000000000000..f71f11274765 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "name": "MyFirstDummyAp", + "description": "This is my first dummy application", + "culture": "en-us", + "usageScenario": "IoT", + "domain": "Comics", + "versionsCount": 3, + "createdDateTime": "2017-01-31T16:15:54Z", + "endpoints": { + "PRODUCTION": { + "versionId": "0.1", + "isStaging": false, + "endpointUrl": "DummyUrl", + "endpointRegion":"westus", + "assignedEndpointKey": "", + "publishedDateTime": "2017-02-19T17:09:14Z" + } + }, + "endpointHitsCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json new file mode 100644 index 000000000000..9b400b4fa43a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": "\"Query\",\"UTC DateTime\",\"Response\" \"hello, world!\",01/31/2017 17:17:41,\"{ \"query\": \"Hello, World!\", \"topScoringIntent\": { \"intent\": \"None\", \"score\": 0.6277761 }, \"intents\": [ { \"intent\": \"None\", \"score\": 0.6277761 }, { \"intent\": \"BookFlight\", \"score\": 0.002136109 }, { \"intent\": \"GetWeather\", \"score\": 0.00142168161 } ], \"entities\": []}\"" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json new file mode 100644 index 000000000000..bf9de1662a24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", + "public": false + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json new file mode 100644 index 000000000000..2f1da09497ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "IoT", + "Bot", + "Mobile Application", + "Other" + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json new file mode 100644 index 000000000000..955174bffa6c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "name": "MyFirstDummyApp", + "description": "This is my first dummy application", + "culture": "en-us", + "usageScenario": "IoT", + "domain": "Comics", + "versionsCount": 3, + "createdDateTime": "2017-01-31T16:15:54Z", + "endpoints": { + "PRODUCTION": { + "versionId": "0.1", + "isStaging": false, + "endpointUrl": "DummyUrl", + "assignedEndpointKey": "", + "endpointRegion": "westus", + "publishedDateTime": "2017-02-19T17:09:14Z" + } + }, + "endpointHitsCount": 0 + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json new file mode 100644 index 000000000000..34dd49995549 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "culture": "{culture}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "taxi", + "culture": "en-us", + "description": "A custom prebuilt domain for taxi booking", + "examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux", + "intents": [ + { + "name": "book_taxi", + "description": "Requests/Books taxi", + "examples": "book taxi x on friday at 6 pm" + }, + { + "name": "cancel_taxi", + "description": "Cancels taxi request", + "examples": "I just called an taxi SUV , please cancel, Cancel my taxi" + } + ], + "entities": [ + { + "name": "from_place_name", + "description": "Route starting point", + "examples": "find taxi x to take me to 9th street from space needle" + } + ] + }, + { + "name": "weather", + "culture": "en-us", + "description": "A custom prebuilt domain that gets weather forecast and condition", + "examples": "Show me the weather for this weekend, What's the weather?", + "intents": [ + { + "name": "get_forecast", + "description": "Gets weather forecast", + "examples": "What's the weather like tomorrow?" + }, + { + "name": "get_condition", + "description": "Gets weather condition", + "examples": "what's the average temperature in India in September?" + } + ], + "entities": [ + { + "name": "location", + "description": "Location of the queried weather", + "examples": "What's the weather like in Minneapolis" + }, + { + "name": "unit", + "description": "Temperature measurement unit", + "examples": "Please change the weather from Fahrenheit to Celsius" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json new file mode 100644 index 000000000000..cb3b9bba039f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "taxi", + "culture": "en-us", + "description": "A custom prebuilt domain for taxi booking", + "examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux", + "intents": [ + { + "name": "book_taxi", + "description": "Requests/Books taxi", + "examples": "book taxi x on friday at 6 pm" + }, + { + "name": "cancel_taxi", + "description": "Cancels taxi request", + "examples": "I just called an taxi SUV , please cancel, Cancel my taxi" + } + ], + "entities": [ + { + "name": "from_place_name", + "description": "Route starting point", + "examples": "find taxi x to take me to 9th street from space needle" + } + ] + }, + { + "name": "weather", + "culture": "en-us", + "description": "A custom prebuilt domain that gets weather forecast and condition", + "examples": "Show me the weather for this weekend, What's the weather?", + "intents": [ + { + "name": "get_forecast", + "description": "Gets weather forecast", + "examples": "What's the weather like tomorrow?" + }, + { + "name": "get_condition", + "description": "Gets weather condition", + "examples": "what's the average temperature in India in September?" + } + ], + "entities": [ + { + "name": "location", + "description": "Location of the queried weather", + "examples": "What's the weather like in Minneapolis" + }, + { + "name": "unit", + "description": "Temperature measurement unit", + "examples": "Please change the weather from Fahrenheit to Celsius" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json new file mode 100644 index 000000000000..deaf833db1b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "westus": "https://westus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "eastus2": "https://eastus2.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "westcentralus": "https://westcentralus.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "southeastasia": "https://southeastasia.api.cognitive.microsoft.com/api/v2.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json new file mode 100644 index 000000000000..98be48322a65 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKeys": [], + "endpointUrls": { + "English": "EnglishDummyURL", + "Chinese": "ChineseDummyURL", + "French": "FrenchDummyURL", + "Spanish": "SpanishDummyURL", + "Italian": "ItalianDummyURL" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json new file mode 100644 index 000000000000..81c57f16f465 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointUrl": "DummyUrl", + "subscription-key": "DummyEndpointKey", + "endpointRegion": "westus", + "isStaging": false + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulAddLabelRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulAddLabelRequest.json new file mode 100644 index 000000000000..844d0acd61cb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulAddLabelRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "UtteranceText": "book me a flight from cairo to redmond next thursday", + "ExampleId": -11 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json new file mode 100644 index 000000000000..268c7d50fa39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "value": { + "UtteranceText": "book me a flight from cairo to redmond next thursday", + "ExampleId": -11 + }, + "hasError": false + }, + { + "value": { + "UtteranceText": "what's the weather like in seattle?", + "ExampleId": -12 + }, + "hasError": true, + "error": { + "code": "FAILED", + "message": "what's the weather like in seattle?. Error: The intent classifier MyLocation does not exist in the selected application" + } + }, + { + "value": null, + "hasError": true, + "error": { + "code": "FAILED", + "message": "1 ticket to seattle tomorrow. Error: The entity extractor builtin.number doesn't exist in the selected application" + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json new file mode 100644 index 000000000000..1d7ec2b9ce9a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": -12, + "text": "what's the weather like in seattle?", + "tokenizedText": [ + "what", + "'", + "s", + "the", + "weather", + "like", + "in", + "seattle", + "?" + ], + "intentLabel": "GetWeather", + "entityLabels": [ + { + "entityName": "Location", + "startTokenIndex": 7, + "endTokenIndex": 7 + } + ], + "intentPredictions": [ + { + "name": "GetWeather", + "score": 1 + }, + { + "name": "None", + "score": 0.21 + }, + { + "name": "BookFlight", + "score": 0 + } + ], + "entityPredictions": [ + { + "entityName": "Location", + "startIndex": 7, + "endIndex": 7, + "phrase": "seattle" + } + ] + }, + { + "id": -11, + "text": "book me a flight from cairo to redmond next thursday", + "tokenizedText": [ + "book", + "me", + "a", + "flight", + "from", + "cairo", + "to", + "redmond", + "next", + "thursday" + ], + "intentLabel": "BookFlight", + "entityLabels": [ + { + "entityName": "Location::To", + "startTokenIndex": 7, + "endTokenIndex": 7 + }, + { + "entityName": "Location::From", + "startTokenIndex": 5, + "endTokenIndex": 5 + } + ], + "intentPredictions": [ + { + "name": "BookFlight", + "score": 0.93 + }, + { + "name": "None", + "score": 0.41 + }, + { + "name": "GetWeather", + "score": 0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startIndex": 8, + "endIndex": 9, + "phrase": "next thursday" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json new file mode 100644 index 000000000000..ce81a37812c1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": 83147 + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json new file mode 100644 index 000000000000..1620a8a38e97 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": 1823 + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json new file mode 100644 index 000000000000..18cc98ea7d26 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "phraselistFeatures": [ + { + "id": 5341, + "name": "Cities", + "phrases": "Seattle,New York,Paris,Moscow,Beijin", + "isExchangeable": true, + "isActive": true + }, + { + "id": 74598, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true + } + ], + "patternFeatures": [ + { + "id": 81231, + "name": "EmailPattern", + "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", + "isActive": true + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json new file mode 100644 index 000000000000..bc3cd39fd6f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 89178, + "name": "EmailPattern", + "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", + "isActive": true + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json new file mode 100644 index 000000000000..da85614d24d7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 321421, + "name": "Cities", + "phrases": "Seattle,New York,Paris,Moscow,Beijin", + "isExchangeable": true, + "isActive": true + }, + { + "id": 97832, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json new file mode 100644 index 000000000000..4e79ffc28dbd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 7892, + "name": "EmailPattern", + "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", + "isActive": true + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..f24b474573ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 178384, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json new file mode 100644 index 000000000000..d113cae4b4f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "body": { + "domainName": "Camera", + "modelName": "AppName" + } + }, + "responses": { + "200": { + "headers": {}, + "body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json new file mode 100644 index 000000000000..7157b01c3d33 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "body": { + "name": "States", + "sublists": [ + { + "canonicalForm": "New York", + "list": [ + "NY", + "New York" + ] + }, + { + "canonicalForm": "Washington", + "list": [ + "Washington", + "WA" + ] + }, + { + "canonicalForm": "California", + "list": [ + "California", + "CA", + "Calif.", + "Cal." + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": "8713b104-78ec-4c4f-9f96-f2e53562cc16" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json new file mode 100644 index 000000000000..3f6eec7ea706 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "body": { + "name": "Reservation", + "children": [ "Location::To", "datetime" ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json new file mode 100644 index 000000000000..dd14d3b9e574 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "body": { + "name": "DayOfWeek" + } + }, + "responses": { + "200": { + "headers": {}, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json new file mode 100644 index 000000000000..5da305b93f7b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "body": { + "name": "Location", + "children": [ "From", "To" ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": "fe559c31-9778-42ea-ba45-94e0bd7cf767" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json new file mode 100644 index 000000000000..37ef473f0d12 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "body": { + "name": "BookFlight" + } + }, + "responses": { + "200": { + "headers": {}, + "body": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json new file mode 100644 index 000000000000..4c050971574b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json new file mode 100644 index 000000000000..6c3e860c6eb1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json new file mode 100644 index 000000000000..9dbaf207067a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor" + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json new file mode 100644 index 000000000000..6e44b31125c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json new file mode 100644 index 000000000000..c10f4edfa3e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8", + "name": "BookFlight", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "None", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", + "name": "$Camera.CapturePhoto", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "CapturePhoto" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json new file mode 100644 index 000000000000..50258cd2514c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8", + "name": "BookFlight", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor" + }, + { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ] + }, + { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "None", + "typeId": 0, + "readableType": "Intent Classifier" + }, + { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ] + }, + { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName" + }, + { + "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", + "name": "$Camera.CapturePhoto", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "CapturePhoto" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..b6d857227b82 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses":{ + "200":{ + "headers": {}, + "body": [ + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json new file mode 100644 index 000000000000..9664df8fb67b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": "{skip}", + "take": "{take}" + }, + "responses":{ + "200":{ + "headers": {}, + "body": [ + { + "name": "geography", + "description": "Continents, Countries, Cities, Post codes, and other points of interest", + "examples": "Antarctica, Portugal, Dubai, Sanjiang County, Lake Pontchartrain, CB3 0DS" + }, + { + "name": "datetime", + "description": "Dates and times, resolved to a canonical form", + "examples": "June 23, 1976, Jul 11 2012, 7 AM, 6:49 PM, tomorrow at 7 AM" + }, + { + "name": "email", + "description": "Email Addresses", + "examples": "user@site.net, user_name@mysite.com.eg" + }, + { + "name": "url", + "description": "Websites URLs", + "examples": "www.website.com, http://website.net?name=my_name&age=10, https://www.mywebsite.net.eg/page" + }, + { + "name": "phoneNumber", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json new file mode 100644 index 000000000000..520ba881c5ac --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "clEntityId": "{clEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "8713b104-78ec-4c4f-9f96-f2e53562cc16", + "name": "States", + "typeId": 5, + "readableType": "Closed List Entity Extractor", + "subLists": [ + { + "id": 1, + "canonicalForm": "new york", + "list": [ + "ny", + "new york" + ] + }, + { + "id": 2, + "canonicalForm": "washington", + "list": [ + "washington", + "wa" + ] + }, + { + "id": 3, + "canonicalForm": "california", + "list": [ + "california", + "ca", + "calif.", + "cal." + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json new file mode 100644 index 000000000000..e3d7b15e4c4a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc1bae43-7904-48ad-a165-88b1910174f9", + "name": "Reservation", + "typeId": 4, + "readableType": "Composite Entity Extractor", + "children": [ + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "Location::To" + }, + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json new file mode 100644 index 000000000000..5e4766c835b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "entityId": "{entityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json new file mode 100644 index 000000000000..b80fcd522844 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}", + "hChildId": "{hChildId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "ef278a6c-d94f-4d20-a602-cf53d0acf0f5", + "name": "From", + "typeId": 6, + "readableType": "Hierarchical Child Entity Extractor" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json new file mode 100644 index 000000000000..28f5c8d3576e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "name": "Location", + "typeId": 3, + "readableType": "Hierarchical Entity Extractor", + "children": [ + { + "id": "ec076676-d8d9-42fa-a44e-87989c0a2f82", + "name": "From" + }, + { + "id": "63ebd752-4e81-4ce7-a698-b59b82bf5519", + "name": "To" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json new file mode 100644 index 000000000000..fb803d415e2f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "intentId": "{intentId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "None", + "typeId": 0, + "readableType": "Intent Classifier" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json new file mode 100644 index 000000000000..d3b0e86dd06c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "prebuiltId": "{prebuiltId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json new file mode 100644 index 000000000000..007d815e4eda --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "owner": "owner@email.com", + "emails": ["yourname@outlook.com"] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json new file mode 100644 index 000000000000..ab1d4f08661a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "query": "forward to frank 30 dollars through HSBC", + "topScoringIntent": { + "intent": "give", + "score": 0.3964121 + }, + "entities": [ + { + "entity": "30", + "type": "builtin.number", + "startIndex": 17, + "endIndex": 18, + "resolution": { + "value": "30" + } + }, + { + "entity": "frank", + "type": "frank", + "startIndex": 11, + "endIndex": 15, + "score": 0.935219169 + }, + { + "entity": "30 dollars", + "type": "builtin.currency", + "startIndex": 17, + "endIndex": 26, + "resolution": { + "unit": "Dollar", + "value": "30" + } + }, + { + "entity": "hsbc", + "type": "Bank", + "startIndex": 36, + "endIndex": 39, + "resolution": { + "values": [ + "BankeName" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json new file mode 100644 index 000000000000..ab1d4f08661a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "query": "forward to frank 30 dollars through HSBC", + "topScoringIntent": { + "intent": "give", + "score": 0.3964121 + }, + "entities": [ + { + "entity": "30", + "type": "builtin.number", + "startIndex": 17, + "endIndex": 18, + "resolution": { + "value": "30" + } + }, + { + "entity": "frank", + "type": "frank", + "startIndex": 11, + "endIndex": 15, + "score": 0.935219169 + }, + { + "entity": "30 dollars", + "type": "builtin.currency", + "startIndex": 17, + "endIndex": 26, + "resolution": { + "unit": "Dollar", + "value": "30" + } + }, + { + "entity": "hsbc", + "type": "Bank", + "startIndex": 36, + "endIndex": 39, + "resolution": { + "values": [ + "BankeName" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json new file mode 100644 index 000000000000..6ac647b7917d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "modelId": "f9b00d5b-1f2d-421e-bc99-5ff192d0b998", + "details": { + "statusId": 3, + "status": "InProgress", + "exampleCount": 0 + } + }, + { + "modelId": "51403af3-5342-4926-abaa-91172a42e075", + "details": { + "statusId": 2, + "status": "UpToDate", + "exampleCount": 12, + "trainingDateTime": "2017-01-31T21:42:02Z" + } + }, + { + "modelId": "b4cf6402-dc79-4ca3-8666-b0007337e92b", + "details": { + "statusId": 1, + "status": "Fail", + "exampleCount": 12, + "failureReason": "FewLabels" + } + }, + { + "modelId": "e8e3135a-acd9-4164-a65c-e2fedbe78cfa", + "details": { + "statusId": 3, + "status": "InProgress", + "exampleCount": 0 + } + }, + { + "modelId": "3291fac9-6368-4c87-9562-e78cae0fa7c6", + "details": { + "statusId": 0, + "status": "Success", + "exampleCount": 12, + "trainingDateTime": "2017-01-31T21:42:02Z" + } + }, + { + "modelId": "a193efac-ab02-49d7-b005-ee717d45c4f1", + "details": { + "statusId": 3, + "status": "InProgress", + "exampleCount": 0 + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json new file mode 100644 index 000000000000..1ada13a6e28d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "statusId": 9, + "status": "Queued" + } + } + } +} \ No newline at end of file