From 3eb6a948505887582bf3a41b5921f26e8394a880 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Thu, 2 Nov 2017 12:29:06 -0700 Subject: [PATCH 01/19] add definitions, schemas to responses, periods to descriptions, and change operationIds in Endpoint swagger.json --- .../Luis/v2.0/LUIS Endpoint API.swagger.json | 179 ++++++++++++++++-- 1 file changed, 159 insertions(+), 20 deletions(-) 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..99d387f22554 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", @@ -54,51 +54,58 @@ "paths": { "/{appId}": { "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": "Luis_GetPredictionsFromEndpointViaGet", "parameters": [ { "name": "appId", "in": "path", - "description": "Format - guid. The application ID", + "description": "Format - guid. The application ID.", + "required": true, + "type": "string" + }, + { + "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", + "description": "A JSON object containing the predictions.", "examples": { "application/json": { "query": "forward to frank 30 dollars through HSBC", @@ -146,6 +153,9 @@ } ] } + }, + "schema": { + "$ref": "#/definitions/LuisResult" } } }, @@ -154,38 +164,38 @@ ] }, "post": { - "description": "Gets the published endpoint prediction for the given long query", - "operationId": "v2.0 Response - Get predictions from endpoint (post)", + "description": "Gets the published endpoint prediction for the given long query.", + "operationId": "Luis_GetPredictionsFromEndpointViaPost", "parameters": [ { "name": "appId", "in": "path", - "description": "Format - guid. The application ID", + "description": "Format - guid. The application ID.", "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" }, { @@ -194,7 +204,7 @@ "schema": { "$ref": "#/definitions/Q" }, - "description": "The query to predict" + "description": "The query to predict." } ], "consumes": [ @@ -202,7 +212,7 @@ ], "responses": { "200": { - "description": "A JSON object containing the prediction", + "description": "A JSON object containing the prediction.", "examples": { "application/json": { "query": "forward to frank 30 dollars through HSBC", @@ -250,6 +260,9 @@ } ] } + }, + "schema": { + "$ref": "#/definitions/LuisResult" } } }, @@ -264,5 +277,131 @@ "type": "string", "example": "\"forward to frank 30 dollars through HSBC\"" } - } + , + "LuisResult": { + "type": "object", + "properties": { + "query": { + "type": "string" + }, + "topScoringIntent": { + "nullable": true, + "$ref": "#/definitions/IntentModel" + }, + "intents": { + "nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/IntentModel" + } + }, + "entities": { + "nullable": true, + "type": "array", + "items": { + "$ref": "#/definitions/EntityModel" + } + }, + "compositeEntities": { + "type": "array", + "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 From 6da9fb139424531ee712c76b0545c892f1ed077e Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 7 Nov 2017 15:43:03 -0800 Subject: [PATCH 02/19] Refactored operationIds for LUIS Programmatic and Endpoint swagger files --- .../Luis/v2.0/LUIS Endpoint API.swagger.json | 4 +- .../LUIS Programmatic APIs v2.0.swagger.json | 220 +++++++++--------- 2 files changed, 112 insertions(+), 112 deletions(-) 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 99d387f22554..e3b8946fda96 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 @@ -55,7 +55,7 @@ "/{appId}": { "get": { "description": "Gets the published endpoint predictions for the given query.", - "operationId": "Luis_GetPredictionsFromEndpointViaGet", + "operationId": "Prediction_GetPredictionsFromEndpointViaGet", "parameters": [ { "name": "appId", @@ -165,7 +165,7 @@ }, "post": { "description": "Gets the published endpoint prediction for the given long query.", - "operationId": "Luis_GetPredictionsFromEndpointViaPost", + "operationId": "Prediction_GetPredictionsFromEndpointViaPost", "parameters": [ { "name": "appId", 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..9418a4f08e7e 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 @@ -55,7 +55,7 @@ "/apps/{appId}/versions/{versionId}/patterns": { "post": { "description": "Creates a new pattern feature.", - "operationId": "features - Create pattern feature", + "operationId": "Features_CreatePatternFeature", "parameters": [ { "name": "appId", @@ -108,7 +108,7 @@ }, "get": { "description": "Gets all application version pattern features.", - "operationId": "features - Get application version pattern features", + "operationId": "Features_GetApplicationVersionPatternFeatures", "parameters": [ { "name": "appId", @@ -171,7 +171,7 @@ "/apps/{appId}/versions/{versionId}/phraselists": { "post": { "description": "Creates a new phraselist feature.", - "operationId": "features - Create phraselist feature", + "operationId": "Features_CreatePhraselistFeature", "parameters": [ { "name": "appId", @@ -213,7 +213,7 @@ }, "get": { "description": "Gets all application phraselist features.", - "operationId": "features - Get application version phraselist features", + "operationId": "Features_GetApplicationVersionPhraselistFeatures", "parameters": [ { "name": "appId", @@ -276,7 +276,7 @@ "/apps/{appId}/versions/{versionId}/features": { "get": { "description": "Gets all application version features.", - "operationId": "features - Get application version features", + "operationId": "Features_GetApplicationVersionFeatures", "parameters": [ { "name": "appId", @@ -364,7 +364,7 @@ "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { "get": { "description": "Gets pattern feature info.", - "operationId": "features - Get pattern feature info", + "operationId": "Features_Get_Pattern_Feature_Info", "parameters": [ { "name": "appId", @@ -407,7 +407,7 @@ }, "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", @@ -450,7 +450,7 @@ }, "delete": { "description": "Deletes a pattern feature from an application version.", - "operationId": "features - Delete pattern feature", + "operationId": "Features_DeletePatternFeature", "parameters": [ { "name": "appId", @@ -484,7 +484,7 @@ "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { "get": { "description": "Gets phraselist feature info.", - "operationId": "features - Get phraselist feature info", + "operationId": "Features_GetPhraselistFeatureInfo", "parameters": [ { "name": "appId", @@ -528,7 +528,7 @@ }, "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", @@ -571,7 +571,7 @@ }, "delete": { "description": "Deletes a phraselist feature from an application.", - "operationId": "features - Delete phraselist feature", + "operationId": "Features_DeletePhraselistFeature", "parameters": [ { "name": "appId", @@ -605,7 +605,7 @@ "/apps/{appId}/versions/{versionId}/example": { "post": { "description": "Adds a labeled example to the application.", - "operationId": "examples - Add label", + "operationId": "Examples_AddLabel", "parameters": [ { "name": "appId", @@ -652,7 +652,7 @@ "/apps/{appId}/versions/{versionId}/examples": { "post": { "description": "Adds a batch of labeled examples to the specified application.", - "operationId": "examples - Batch add labels", + "operationId": "Examples_BatchAddLabels", "parameters": [ { "name": "appId", @@ -694,7 +694,7 @@ }, "get": { "description": "Returns examples to be reviewed.", - "operationId": "examples - Review labeled examples", + "operationId": "Examples_ReviewLabeledExamples", "parameters": [ { "name": "appId", @@ -757,7 +757,7 @@ "/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", @@ -791,7 +791,7 @@ "/apps/{appId}/versions/{versionId}/intents": { "post": { "description": "Adds an intent classifier to the application.", - "operationId": "models - Create intent classifier", + "operationId": "Models_CreateIntentClassifier", "parameters": [ { "name": "appId", @@ -833,7 +833,7 @@ }, "get": { "description": "Gets information about the intent models.", - "operationId": "models - Get application version intent infos", + "operationId": "Models_GetApplicationVersionIntentInfos", "parameters": [ { "name": "appId", @@ -896,7 +896,7 @@ "/apps/{appId}/versions/{versionId}/entities": { "post": { "description": "Adds an entity extractor to the application.", - "operationId": "models - Create entity extractor", + "operationId": "Models_CreateEntityExtractor", "parameters": [ { "name": "appId", @@ -938,7 +938,7 @@ }, "get": { "description": "Gets information about the entity models.", - "operationId": "models - Get application version entity infos", + "operationId": "Models_GetApplicationVersionEntityInfos", "parameters": [ { "name": "appId", @@ -1001,7 +1001,7 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities": { "post": { "description": "Adds a hierarchical entity extractor to the application version.", - "operationId": "models - Create hierarchical entity extractor", + "operationId": "Models_CreateHierarchicalEntityExtractor", "parameters": [ { "name": "appId", @@ -1043,7 +1043,7 @@ }, "get": { "description": "Gets information about the hierarchical entity models.", - "operationId": "models - Get application version hierarchical entity infos", + "operationId": "Models_GetApplicationVersionHierarchicalEntityInfos", "parameters": [ { "name": "appId", @@ -1106,7 +1106,7 @@ "/apps/{appId}/versions/{versionId}/compositeentities": { "post": { "description": "Adds a composite entity extractor to the application.", - "operationId": "models - Create composite entity extractor", + "operationId": "Models_CreateCompositeEntityExtractor", "parameters": [ { "name": "appId", @@ -1148,7 +1148,7 @@ }, "get": { "description": "Gets information about the composite entity models.", - "operationId": "models - Get application version composite entity infos", + "operationId": "Models_GetApplicationVersionCompositeEntityInfos", "parameters": [ { "name": "appId", @@ -1211,7 +1211,7 @@ "/apps/{appId}/versions/{versionId}/closedlists": { "post": { "description": "Adds a closed list model to the application.", - "operationId": "models - Create closed list entity model", + "operationId": "Models_CreateClosedListEntityModel", "parameters": [ { "name": "appId", @@ -1253,7 +1253,7 @@ }, "get": { "description": "Gets information about the closedlist models.", - "operationId": "models - Get application version closed list infos", + "operationId": "Models_GetApplicationVersionClosedListInfos", "parameters": [ { "name": "appId", @@ -1316,7 +1316,7 @@ "/apps/{appId}/versions/{versionId}/prebuilts": { "post": { "description": "Adds a list of prebuilt entity extractors to the application.", - "operationId": "models - Add prebuilt entity extractors", + "operationId": "Models_AddPrebuiltEntityExtractors", "parameters": [ { "name": "appId", @@ -1358,7 +1358,7 @@ }, "get": { "description": "Gets information about the prebuilt entity models.", - "operationId": "models - Get application version prebuilt infos", + "operationId": "Models_GetApplicationVersionPrebuiltInfos", "parameters": [ { "name": "appId", @@ -1421,7 +1421,7 @@ "/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": "Models_GetAvailablePrebuiltEntityExtractors", "parameters": [ { "name": "appId", @@ -1454,7 +1454,7 @@ "/apps/{appId}/versions/{versionId}/models": { "get": { "description": "Gets information about the application version models.", - "operationId": "models - Get application version model infos", + "operationId": "Models_GetApplicationVersionModelInfos", "parameters": [ { "name": "appId", @@ -1517,7 +1517,7 @@ "/apps/{appId}/versions/{versionId}/intents/{intentId}": { "get": { "description": "Gets information about the intent model.", - "operationId": "models - Get intent info", + "operationId": "Models_GetIntentInfo", "parameters": [ { "name": "appId", @@ -1560,7 +1560,7 @@ }, "put": { "description": "Updates the name of an intent classifier.", - "operationId": "models - Rename intent model", + "operationId": "Models_RenameIntentModel", "parameters": [ { "name": "appId", @@ -1603,7 +1603,7 @@ }, "delete": { "description": "Deletes an intent classifier from the application.", - "operationId": "models - Delete intent model", + "operationId": "Models_DeleteIntentModel", "parameters": [ { "name": "appId", @@ -1637,7 +1637,7 @@ "/apps/{appId}/versions/{versionId}/entities/{entityId}": { "get": { "description": "Gets information about the entity model.", - "operationId": "models - Get entity info", + "operationId": "Models_GetEntityInfo", "parameters": [ { "name": "appId", @@ -1680,7 +1680,7 @@ }, "put": { "description": "Updates the name of an entity extractor.", - "operationId": "models - Rename entity model", + "operationId": "Models_RenameEntityModel", "parameters": [ { "name": "appId", @@ -1723,7 +1723,7 @@ }, "delete": { "description": "Deletes an entity extractor from the application.", - "operationId": "models - Delete entity model", + "operationId": "Models_DeleteEntityModel", "parameters": [ { "name": "appId", @@ -1757,7 +1757,7 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { "get": { "description": "Gets information about the hierarchical entity model.", - "operationId": "models - Get hierarchical entity info", + "operationId": "Models_GetHierarchicalEntityInfo", "parameters": [ { "name": "appId", @@ -1810,7 +1810,7 @@ }, "put": { "description": "Updates the name and children of a hierarchical entity model.", - "operationId": "models - Update hierarchical entity model", + "operationId": "Models_UpdateHierarchicalEntityModel", "parameters": [ { "name": "appId", @@ -1853,7 +1853,7 @@ }, "delete": { "description": "Deletes a hierarchical entity extractor from the application version.", - "operationId": "models - Delete hierarchical entity model", + "operationId": "Models_DeleteHierarchicalEntityModel", "parameters": [ { "name": "appId", @@ -1887,7 +1887,7 @@ "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { "get": { "description": "Gets information about the composite entity model.", - "operationId": "models - Get composite entity info", + "operationId": "Models_GetCompositeEntityInfo", "parameters": [ { "name": "appId", @@ -1940,7 +1940,7 @@ }, "put": { "description": "Updates the composite entity extractor.", - "operationId": "models - Update composite entity model", + "operationId": "Models_UpdateCompositeEntityModel", "parameters": [ { "name": "appId", @@ -1983,7 +1983,7 @@ }, "delete": { "description": "Deletes a composite entity extractor from the application.", - "operationId": "models - Delete composite entity model", + "operationId": "Models_DeleteCompositeEntityModel", "parameters": [ { "name": "appId", @@ -2017,7 +2017,7 @@ "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { "get": { "description": "Gets information of a closed list model.", - "operationId": "models - Get closed list entity info", + "operationId": "Models_GetClosedListEntityInfo", "parameters": [ { "name": "appId", @@ -2088,7 +2088,7 @@ }, "put": { "description": "Updates the closed list model.", - "operationId": "models - Update closed list entity model", + "operationId": "Models_UpdateClosedListEntityModel", "parameters": [ { "name": "appId", @@ -2131,7 +2131,7 @@ }, "patch": { "description": "Adds a batch of sublists to an existing closedlist.", - "operationId": "models - Patch closed list entity model", + "operationId": "Models_PatchClosedListEntityModel", "parameters": [ { "name": "appId", @@ -2174,7 +2174,7 @@ }, "delete": { "description": "Deletes a closed list model from the application.", - "operationId": "models - Delete closed list entity model", + "operationId": "Models_DeleteClosedListEntityModel", "parameters": [ { "name": "appId", @@ -2208,7 +2208,7 @@ "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { "get": { "description": "Gets information about the prebuilt entity model.", - "operationId": "models - Get prebuilt info", + "operationId": "Models_GetPrebuiltInfo", "parameters": [ { "name": "appId", @@ -2251,7 +2251,7 @@ }, "delete": { "description": "Deletes a prebuilt entity extractor from the application.", - "operationId": "models - Delete prebuilt model", + "operationId": "Models_DeletePrebuiltModel", "parameters": [ { "name": "appId", @@ -2285,7 +2285,7 @@ "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { "delete": { "description": "Deletes a sublist of a specific closed list model.", - "operationId": "models - Delete sub list", + "operationId": "Models_DeleteSubList", "parameters": [ { "name": "appId", @@ -2324,7 +2324,7 @@ }, "put": { "description": "Updates one of the closed list's sublists", - "operationId": "models - Update closed list's sublist", + "operationId": "Models_UpdateSubList", "parameters": [ { "name": "appId", @@ -2376,7 +2376,7 @@ "/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": "Models_SuggestEndpointQueriesForIntents", "parameters": [ { "name": "appId", @@ -2431,7 +2431,7 @@ "/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": "Models_SuggestEndpointQueriesForEntities", "parameters": [ { "name": "appId", @@ -2486,7 +2486,7 @@ "/apps/": { "post": { "description": "Creates a new LUIS app.", - "operationId": "apps - Add application", + "operationId": "Apps_AddApplication", "parameters": [ { "name": "applicationCreateObject", @@ -2514,7 +2514,7 @@ }, "get": { "description": "Lists all of the user applications.", - "operationId": "apps - Get user applications", + "operationId": "Apps_GetUserApplications", "parameters": [ { "name": "skip", @@ -2563,7 +2563,7 @@ "/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", @@ -2599,7 +2599,7 @@ "/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.", @@ -2625,7 +2625,7 @@ "/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.", @@ -2642,7 +2642,7 @@ "/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.", @@ -2659,7 +2659,7 @@ "/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.", @@ -2676,7 +2676,7 @@ "/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", @@ -2702,7 +2702,7 @@ "/apps/{appId}": { "get": { "description": "Gets the application info.", - "operationId": "apps - Get application info", + "operationId": "Apps_GetApplicationInfo", "parameters": [ { "name": "appId", @@ -2746,7 +2746,7 @@ }, "put": { "description": "Updates the name or description of the application.", - "operationId": "apps - Rename application", + "operationId": "Apps_RenameApplication", "parameters": [ { "name": "appId", @@ -2775,7 +2775,7 @@ }, "delete": { "description": "Deletes an application.", - "operationId": "apps - Delete application", + "operationId": "Apps_DeleteApplication", "parameters": [ { "name": "appId", @@ -2795,7 +2795,7 @@ "/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", @@ -2839,7 +2839,7 @@ "/apps/{appId}/publish": { "post": { "description": "Publishes a specific version of the application.", - "operationId": "apps - Publish application", + "operationId": "Apps_PublishApplication", "parameters": [ { "name": "appId", @@ -2881,7 +2881,7 @@ "/apps/{appId}/versions": { "get": { "description": "Gets the application versions info.", - "operationId": "versions - Get application versions", + "operationId": "Versions_GetApplicationVersions", "parameters": [ { "name": "appId", @@ -2937,7 +2937,7 @@ "/apps/{appId}/versions/{versionId}/": { "get": { "description": "Gets the task info.", - "operationId": "versions - Get application version", + "operationId": "Versions_GetApplicationVersion", "parameters": [ { "name": "appId", @@ -2983,7 +2983,7 @@ }, "put": { "description": "Updates the name or description of the application version.", - "operationId": "versions - Rename application version", + "operationId": "Versions_RenameApplicationVersion", "parameters": [ { "name": "appId", @@ -3019,7 +3019,7 @@ }, "delete": { "description": "Deletes an application version.", - "operationId": "versions - Delete application version", + "operationId": "Versions_DeleteApplicationVersion", "parameters": [ { "name": "appId", @@ -3046,7 +3046,7 @@ "/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", @@ -3159,7 +3159,7 @@ "/apps/{appId}/versions/{versionId}/assignedkey": { "get": { "description": "Gets the given application version's subscription key.", - "operationId": "versions - Get application version subscription key", + "operationId": "Versions_GetApplicationVersionSubscriptionKey", "parameters": [ { "name": "appId", @@ -3193,7 +3193,7 @@ }, "put": { "description": "Assigns a subscription key to the given application version.", - "operationId": "versions - Assign subscription key to version", + "operationId": "Versions_AssignSubscriptionKeyToVersion", "parameters": [ { "name": "appId", @@ -3231,7 +3231,7 @@ "/apps/{appId}/versions/{versionId}/externalKeys": { "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", @@ -3267,7 +3267,7 @@ }, "get": { "description": "Gets the given application versions's external keys.", - "operationId": "versions - Get application version external api keys", + "operationId": "Versions_GetApplicationVersionExternalApiKeys", "parameters": [ { "name": "appId", @@ -3302,7 +3302,7 @@ "/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", @@ -3336,7 +3336,7 @@ "/apps/{appId}/versions/{versionId}/train": { "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", + "operationId": "Train_TrainApplicationVersion", "parameters": [ { "name": "appId", @@ -3371,7 +3371,7 @@ }, "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", + "operationId": "Train_GetApplicationVersionTrainingStatus", "parameters": [ { "name": "appId", @@ -3420,7 +3420,7 @@ "/subscriptions": { "post": { "description": "Adds a subscription key to the user.", - "operationId": "user - Add subscription key", + "operationId": "User_AddSubscriptionKey", "parameters": [ { "name": "userSubscriptionCreateObject", @@ -3452,7 +3452,7 @@ }, "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.", @@ -3467,7 +3467,7 @@ }, "put": { "description": "Renames a subscription key owned by the user.", - "operationId": "user - Rename subscription key", + "operationId": "User_RenameSubscriptionKey", "parameters": [ { "name": "body", @@ -3491,7 +3491,7 @@ "/externalKeys": { "post": { "description": "Adds an external API key to the user.", - "operationId": "user - Add external api key", + "operationId": "User_AddExternalApiKey", "parameters": [ { "name": "externalKeyCreateObject", @@ -3513,7 +3513,7 @@ }, "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.", @@ -3530,7 +3530,7 @@ "/programmatickey": { "put": { "description": "Resets the user programmatic key.", - "operationId": "user - Reset programmatic key", + "operationId": "User_ResetProgrammaticKey", "responses": { "200": { "description": "The new programmatic key.", @@ -3547,7 +3547,7 @@ "/subscriptions/{subscriptionKey}": { "delete": { "description": "Deletes a user subscription key.", - "operationId": "user - Delete subscription key", + "operationId": "User_DeleteSubscriptionKey", "parameters": [ { "name": "subscriptionKey", @@ -3567,7 +3567,7 @@ "/externalKeys/{externalKeyValue}": { "delete": { "description": "Deletes a user external API key.", - "operationId": "user - Delete external api key", + "operationId": "User_DeleteExternalApiKey", "parameters": [ { "name": "externalKeyValue", @@ -3587,7 +3587,7 @@ "/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", @@ -3630,7 +3630,7 @@ "/apps/{appId}/settings": { "get": { "description": "Get the application settings", - "operationId": "apps - Get application settings", + "operationId": "Apps_GetApplicationSettings", "parameters": [ { "name": "appId", @@ -3657,7 +3657,7 @@ }, "put": { "description": "Updates the application settings", - "operationId": "apps - Update application settings", + "operationId": "Apps_UpdateApplicationSettings", "parameters": [ { "name": "appId", @@ -3688,7 +3688,7 @@ "/apps/{appId}/versions/{versionId}/suggest": { "delete": { "description": "Deleted an unlabelled utterance.", - "operationId": "versions - Delete unlabelled utterance", + "operationId": "Versions_DeleteUnlabelledUtterance", "parameters": [ { "name": "appId", @@ -3726,7 +3726,7 @@ "/apps/{appId}/permissions": { "get": { "description": "Gets the list of user emails that have permissions to access your application.", - "operationId": "permissions - Get application user access list", + "operationId": "Permissions_GetApplicationUserAccessList", "parameters": [ { "name": "appId", @@ -3744,7 +3744,7 @@ }, "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", @@ -3773,7 +3773,7 @@ }, "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", @@ -3802,7 +3802,7 @@ }, "put": { "description": "Replaces the current users access list with the one sent in the body.If an empty list is sent, all access to other users will be removed.", - "operationId": "permissions - Update access list", + "operationId": "Permissions_UpdateAccessList", "parameters": [ { "name": "appId", @@ -3833,7 +3833,7 @@ "/apps/{appId}/endpoints": { "get": { "description": "Returns the available endpoint deployment regions and urls", - "operationId": "apps - Get endpoints", + "operationId": "Apps_GetEndpoints", "parameters": [ { "name": "appId", @@ -3864,7 +3864,7 @@ "/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": "Models_AddSubList", "parameters": [ { "name": "appId", @@ -3915,7 +3915,7 @@ "/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": "Models_AddCustomPrebuiltDomainToApplication", "parameters": [ { "name": "appId", @@ -3959,7 +3959,7 @@ "/apps/{appId}/versions/{versionId}/customprebuiltintents": { "post": { "description": "Adds a custom prebuilt intent model to the application", - "operationId": "models - Add custom prebuilt intent model", + "operationId": "Models_AddCustomPrebuiltIntentModel", "parameters": [ { "name": "appId", @@ -4001,7 +4001,7 @@ }, "get": { "description": "Gets custom prebuilt intents information of this application", - "operationId": "models - Get custom prebuilt domain intents info", + "operationId": "Models_GetCustomPrebuiltDomainIntentsInfo", "parameters": [ { "name": "appId", @@ -4034,7 +4034,7 @@ "/apps/{appId}/versions/{versionId}/customprebuiltentities": { "post": { "description": "Adds a custom prebuilt entity model to the application", - "operationId": "models - Add custom prebuilt entity model", + "operationId": "Models_AddCustomPrebuiltEntityModel", "parameters": [ { "name": "appId", @@ -4076,7 +4076,7 @@ }, "get": { "description": "Gets all custom prebuilt entities information of this application", - "operationId": "models - Get custom prebuilt domain entities info", + "operationId": "Models_GetCustomPrebuiltDomainEntitiesInfo", "parameters": [ { "name": "appId", @@ -4109,7 +4109,7 @@ "/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": "Models_GetCustomPrebuiltDomainModelsInfo", "parameters": [ { "name": "appId", @@ -4142,7 +4142,7 @@ "/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": "Models_DeleteCustomPrebuiltDomainModels", "parameters": [ { "name": "appId", @@ -4176,7 +4176,7 @@ "/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", @@ -4191,7 +4191,7 @@ }, "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", @@ -4221,7 +4221,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", @@ -4247,7 +4247,7 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { "get": { "description": "Gets information about the hierarchical entity child model.", - "operationId": "models - Get hierarchical entity child info", + "operationId": "Models_GetHierarchicalEntityChildInfo", "parameters": [ { "name": "appId", @@ -4297,7 +4297,7 @@ }, "put": { "description": "Renames a single child in an existing hierarchical entity model.", - "operationId": "models - Update hierarchical entity child model", + "operationId": "Models_UpdateHierarchicalEntityChildModel", "parameters": [ { "name": "appId", @@ -4347,7 +4347,7 @@ }, "delete": { "description": "Deletes a hierarchical entity extractor child from the application.", - "operationId": "models - Delete hierarchical entity child model", + "operationId": "Models_DeleteHierarchicalEntityChildModel", "parameters": [ { "name": "appId", @@ -4388,7 +4388,7 @@ "/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": "Models_CreateHierarchicalEntityChildModel", "parameters": [ { "name": "appId", @@ -4439,7 +4439,7 @@ "/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": "Models_CreateCompositeEntityChildModel", "parameters": [ { "name": "appId", @@ -4490,7 +4490,7 @@ "/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": "Models_DeleteCompositeEntityChildModel", "parameters": [ { "name": "appId", From 045a120a17ce9be42169fa063b164ade81381221 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 7 Nov 2017 19:53:35 -0800 Subject: [PATCH 03/19] remove apiKeyQuery security definition, remove global security declarations --- .../Luis/v2.0/LUIS Endpoint API.swagger.json | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) 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 e3b8946fda96..1d67946499e9 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 @@ -36,21 +36,8 @@ "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" - }, - "apiKeyQuery": { - "type": "apiKey", - "name": "subscription-key", - "in": "query" } }, - "security": [ - { - "apiKeyHeader": [] - }, - { - "apiKeyQuery": [] - } - ], "paths": { "/{appId}": { "get": { @@ -166,6 +153,11 @@ "post": { "description": "Gets the published endpoint prediction for the given long query.", "operationId": "Prediction_GetPredictionsFromEndpointViaPost", + "security": [ + { + "apiKeyHeader": [] + } + ], "parameters": [ { "name": "appId", From b4320c2714e2ed4bf9a692f3d68c6f55dd71ec3b Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 7 Nov 2017 19:54:59 -0800 Subject: [PATCH 04/19] fix typo in operationId for Features_GetPatternFeatureInfo --- .../Luis/v2.0/LUIS Programmatic APIs v2.0.swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 9418a4f08e7e..5839f9470100 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 @@ -364,7 +364,7 @@ "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { "get": { "description": "Gets pattern feature info.", - "operationId": "Features_Get_Pattern_Feature_Info", + "operationId": "Features_GetPatternFeatureInfo", "parameters": [ { "name": "appId", From 48aed5ca45d1c5b47b2c5664f8d472ed27f1f24a Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 7 Nov 2017 20:01:11 -0800 Subject: [PATCH 05/19] remove unused securityDefinition 'apiKeyQuery' from LUIS Programmatic APIs swagger file --- .../Luis/v2.0/LUIS Programmatic APIs v2.0.swagger.json | 8 -------- 1 file changed, 8 deletions(-) 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 5839f9470100..d59847fde50b 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,19 +36,11 @@ "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" - }, - "apiKeyQuery": { - "type": "apiKey", - "name": "subscription-key", - "in": "query" } }, "security": [ { "apiKeyHeader": [] - }, - { - "apiKeyQuery": [] } ], "paths": { From 040a0fabbbf65eb63013625b60c0e30175afde24 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Wed, 8 Nov 2017 19:40:18 -0800 Subject: [PATCH 06/19] clean up LUIS Programmatic APIs Swagger file by creating path-specific parameters --- .../LUIS Programmatic APIs v2.0.swagger.json | 1740 +++++------------ 1 file changed, 524 insertions(+), 1216 deletions(-) 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 d59847fde50b..5e80c6814d9a 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 @@ -45,24 +45,26 @@ ], "paths": { "/apps/{appId}/versions/{versionId}/patterns": { + "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" + } + ], "post": { "description": "Creates a new 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", @@ -102,20 +104,6 @@ "description": "Gets all 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", @@ -161,24 +149,26 @@ } }, "/apps/{appId}/versions/{versionId}/phraselists": { + "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" + } + ], "post": { "description": "Creates a new 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", @@ -207,20 +197,6 @@ "description": "Gets all application 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", @@ -354,32 +330,32 @@ } }, "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { + "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" + } + ], "get": { "description": "Gets pattern feature info.", "operationId": "Features_GetPatternFeatureInfo", - "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" - } - ], "responses": { "200": { "description": "A JSON object containing the pattern feature info.", @@ -401,27 +377,6 @@ "description": "Updates the pattern, the name and the state of the 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", @@ -443,29 +398,6 @@ "delete": { "description": "Deletes a pattern feature from an application version.", "operationId": "Features_DeletePatternFeature", - "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" - } - ], "responses": { "200": { "description": "" @@ -474,32 +406,32 @@ } }, "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { + "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 deleted.", + "required": true, + "type": "integer" + } + ], "get": { "description": "Gets phraselist feature info.", "operationId": "Features_GetPhraselistFeatureInfo", - "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" - } - ], "responses": { "200": { "description": "A JSON object containing the phraselist feature info.", @@ -522,27 +454,6 @@ "description": "Updates the phrases, the state and the name of the 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", @@ -564,29 +475,6 @@ "delete": { "description": "Deletes a phraselist feature from an application.", "operationId": "Features_DeletePhraselistFeature", - "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 deleted.", - "required": true, - "type": "integer" - } - ], "responses": { "200": { "description": "" @@ -642,24 +530,27 @@ } }, "/apps/{appId}/versions/{versionId}/examples": { + "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" + } + ], "post": { "description": "Adds a batch of labeled examples to the specified application.", "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", @@ -688,20 +579,6 @@ "description": "Returns examples to be reviewed.", "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", @@ -781,24 +658,26 @@ } }, "/apps/{appId}/versions/{versionId}/intents": { + "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" + } + ], "post": { "description": "Adds an intent classifier to the application.", "operationId": "Models_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", @@ -827,20 +706,6 @@ "description": "Gets information about the intent models.", "operationId": "Models_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", @@ -886,24 +751,26 @@ } }, "/apps/{appId}/versions/{versionId}/entities": { + "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" + } + ], "post": { "description": "Adds an entity extractor to the application.", "operationId": "Models_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", @@ -932,20 +799,6 @@ "description": "Gets information about the entity models.", "operationId": "Models_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", @@ -991,24 +844,26 @@ } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities": { + "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" + } + ], "post": { "description": "Adds a hierarchical entity extractor to the application version.", "operationId": "Models_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", @@ -1037,20 +892,6 @@ "description": "Gets information about the hierarchical entity models.", "operationId": "Models_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", @@ -1096,24 +937,26 @@ } }, "/apps/{appId}/versions/{versionId}/compositeentities": { + "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" + } + ], "post": { "description": "Adds a composite entity extractor to the application.", "operationId": "Models_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", @@ -1142,20 +985,6 @@ "description": "Gets information about the composite entity models.", "operationId": "Models_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" - }, { "name": "skip", "in": "query", @@ -1201,24 +1030,26 @@ } }, "/apps/{appId}/versions/{versionId}/closedlists": { + "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" + } + ], "post": { "description": "Adds a closed list model to the application.", "operationId": "Models_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", @@ -1247,20 +1078,6 @@ "description": "Gets information about the closedlist models.", "operationId": "Models_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", @@ -1306,24 +1123,26 @@ } }, "/apps/{appId}/versions/{versionId}/prebuilts": { + "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" + } + ], "post": { "description": "Adds a list of prebuilt entity extractors to the application.", "operationId": "Models_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", @@ -1352,20 +1171,6 @@ "description": "Gets information about the prebuilt entity models.", "operationId": "Models_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", @@ -1507,32 +1312,32 @@ } }, "/apps/{appId}/versions/{versionId}/intents/{intentId}": { + "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": "intentId", + "in": "path", + "description": "Format - guid. The intent classifier ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets information about the intent model.", "operationId": "Models_GetIntentInfo", - "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" - } - ], "responses": { "200": { "description": "An intent model info.", @@ -1554,27 +1359,6 @@ "description": "Updates the name of an intent classifier.", "operationId": "Models_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", @@ -1596,29 +1380,6 @@ "delete": { "description": "Deletes an intent classifier from the application.", "operationId": "Models_DeleteIntentModel", - "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" - } - ], "responses": { "200": { "description": "" @@ -1627,32 +1388,32 @@ } }, "/apps/{appId}/versions/{versionId}/entities/{entityId}": { + "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" + } + ], "get": { "description": "Gets information about the entity model.", "operationId": "Models_GetEntityInfo", - "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" - } - ], "responses": { "200": { "description": "An entity model info.", @@ -1674,27 +1435,6 @@ "description": "Updates the name of an entity extractor.", "operationId": "Models_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", @@ -1716,29 +1456,6 @@ "delete": { "description": "Deletes an entity extractor from the application.", "operationId": "Models_DeleteEntityModel", - "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" - } - ], "responses": { "200": { "description": "" @@ -1747,32 +1464,32 @@ } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { + "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" + } + ], "get": { "description": "Gets information about the hierarchical entity model.", "operationId": "Models_GetHierarchicalEntityInfo", - "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" - } - ], "responses": { "200": { "description": "A hierarchical entity model info.", @@ -1804,27 +1521,6 @@ "description": "Updates the name and children of a hierarchical entity model.", "operationId": "Models_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", @@ -1846,29 +1542,6 @@ "delete": { "description": "Deletes a hierarchical entity extractor from the application version.", "operationId": "Models_DeleteHierarchicalEntityModel", - "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" - } - ], "responses": { "200": { "description": "" @@ -1877,32 +1550,32 @@ } }, "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { + "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" + } + ], "get": { "description": "Gets information about the composite entity model.", "operationId": "Models_GetCompositeEntityInfo", - "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" - } - ], "responses": { "200": { "description": "The composite entity model info.", @@ -1934,27 +1607,6 @@ "description": "Updates the composite entity extractor.", "operationId": "Models_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", @@ -1976,29 +1628,6 @@ "delete": { "description": "Deletes a composite entity extractor from the application.", "operationId": "Models_DeleteCompositeEntityModel", - "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" - } - ], "responses": { "200": { "description": "" @@ -2007,32 +1636,32 @@ } }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { + "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" + } + ], "get": { "description": "Gets information of a closed list model.", "operationId": "Models_GetClosedListEntityInfo", - "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" - } - ], "responses": { "200": { "description": "The closed list model info.", @@ -2082,27 +1711,6 @@ "description": "Updates the closed list model.", "operationId": "Models_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", @@ -2125,27 +1733,6 @@ "description": "Adds a batch of sublists to an existing closedlist.", "operationId": "Models_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", @@ -2167,63 +1754,40 @@ "delete": { "description": "Deletes a closed list model from the application.", "operationId": "Models_DeleteClosedListEntityModel", - "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" - } - ], "responses": { "200": { "description": "" } } - } - }, - "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { + "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" + } + ], "get": { "description": "Gets information about the prebuilt entity model.", "operationId": "Models_GetPrebuiltInfo", - "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" - } - ], "responses": { "200": { "description": "A prebuilt entity models info.", @@ -2244,29 +1808,7 @@ "delete": { "description": "Deletes a prebuilt entity extractor from the application.", "operationId": "Models_DeletePrebuiltModel", - "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" - } - ], + "responses": { "200": { "description": "" @@ -2275,39 +1817,39 @@ } }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { + "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" + } + ], "delete": { "description": "Deletes a sublist of a specific closed list model.", "operationId": "Models_DeleteSubList", - "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" - } - ], "responses": { "200": { "description": "" @@ -2318,34 +1860,6 @@ "description": "Updates one of the closed list's sublists", "operationId": "Models_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", @@ -2692,18 +2206,18 @@ } }, "/apps/{appId}": { + "parameters": [ + { + "name": "appId", + "in": "path", + "description": "Format - guid. The application ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets the application info.", "operationId": "Apps_GetApplicationInfo", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], "responses": { "200": { "description": "A JSON object containing the application info.", @@ -2740,13 +2254,6 @@ "description": "Updates the name or description of the application.", "operationId": "Apps_RenameApplication", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "applicationUpdateObject", "in": "body", @@ -2768,15 +2275,6 @@ "delete": { "description": "Deletes an application.", "operationId": "Apps_DeleteApplication", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], "responses": { "200": { "description": "" @@ -2927,25 +2425,25 @@ } }, "/apps/{appId}/versions/{versionId}/": { + "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" + } + ], "get": { "description": "Gets the task info.", "operationId": "Versions_GetApplicationVersion", - "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" - } - ], "responses": { "200": { "description": "A JSON object containing the task info.", @@ -2977,20 +2475,6 @@ "description": "Updates the name or description of the 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", @@ -3012,22 +2496,6 @@ "delete": { "description": "Deletes an application version.", "operationId": "Versions_DeleteApplicationVersion", - "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" - } - ], "responses": { "200": { "description": "" @@ -3149,25 +2617,25 @@ } }, "/apps/{appId}/versions/{versionId}/assignedkey": { + "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" + } + ], "get": { "description": "Gets the given application version's subscription key.", "operationId": "Versions_GetApplicationVersionSubscriptionKey", - "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" - } - ], "responses": { "200": { "description": "The subscription key for this application's endpoint.", @@ -3187,20 +2655,6 @@ "description": "Assigns a subscription key to the given application 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", @@ -3221,24 +2675,26 @@ } }, "/apps/{appId}/versions/{versionId}/externalKeys": { + "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" + } + ], "put": { "description": "Assigns an external API key to the given application according to the specified key type.", "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", @@ -3256,26 +2712,10 @@ "description": "" } } - }, - "get": { - "description": "Gets the given application versions's external keys.", - "operationId": "Versions_GetApplicationVersionExternalApiKeys", - "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" - } - ], + }, + "get": { + "description": "Gets the given application versions's external keys.", + "operationId": "Versions_GetApplicationVersionExternalApiKeys", "responses": { "200": { "description": "An array containing the external keys.", @@ -3326,25 +2766,25 @@ } }, "/apps/{appId}/versions/{versionId}/train": { + "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" + } + ], "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_TrainApplicationVersion", - "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" - } - ], "responses": { "202": { "description": "" @@ -3364,22 +2804,6 @@ "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_GetApplicationVersionTrainingStatus", - "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" - } - ], "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\".", @@ -3620,18 +3044,18 @@ } }, "/apps/{appId}/settings": { + "parameters": [ + { + "name": "appId", + "in": "path", + "description": "Format - guid. The application ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Get the application settings", "operationId": "Apps_GetApplicationSettings", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], "responses": { "200": { "description": "A JSON object containing the application settings.", @@ -3651,13 +3075,6 @@ "description": "Updates the application settings", "operationId": "Apps_UpdateApplicationSettings", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "applicationSettingUpdateObject", "in": "body", @@ -3716,18 +3133,18 @@ } }, "/apps/{appId}/permissions": { + "parameters": [ + { + "name": "appId", + "in": "path", + "description": "Format - guid. The application ID.", + "required": true, + "type": "string" + } + ], "get": { "description": "Gets the list of user emails that have permissions to access your application.", "operationId": "Permissions_GetApplicationUserAccessList", - "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - } - ], "responses": { "200": { "description": "" @@ -3738,13 +3155,6 @@ "description": "Adds a user to the allowed list of users to access this LUIS application.Users are added using their email address.", "operationId": "Permissions_AddUserToAccessList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -3767,13 +3177,6 @@ "description": "Removed a user to the allowed list of users to access this LUIS application.Users are removed using their email address.", "operationId": "Permissions_RemoveUserFromAccessList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -3796,13 +3199,6 @@ "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_UpdateAccessList", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "body", "in": "body", @@ -3911,17 +3307,15 @@ "parameters": [ { "name": "appId", + "type": "string", "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "required": true }, { "name": "versionId", + "type": "string", "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "required": true }, { "name": "prebuiltDomainCreateBaseObject", @@ -3949,24 +3343,26 @@ } }, "/apps/{appId}/versions/{versionId}/customprebuiltintents": { + "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" + } + ], "post": { "description": "Adds a custom prebuilt intent model to the application", "operationId": "Models_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", @@ -3994,22 +3390,6 @@ "get": { "description": "Gets custom prebuilt intents information of this application", "operationId": "Models_GetCustomPrebuiltDomainIntentsInfo", - "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" - } - ], "responses": { "200": { "description": "Returns a list of all custom prebuilt intents and their representations.", @@ -4024,24 +3404,26 @@ } }, "/apps/{appId}/versions/{versionId}/customprebuiltentities": { + "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" + } + ], "post": { "description": "Adds a custom prebuilt entity model to the application", "operationId": "Models_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", @@ -4069,22 +3451,6 @@ "get": { "description": "Gets all custom prebuilt entities information of this application", "operationId": "Models_GetCustomPrebuiltDomainEntitiesInfo", - "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" - } - ], "responses": { "200": { "description": "Returns a list of all custom prebuilt entities and their representations.", @@ -4237,39 +3603,39 @@ } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { + "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" + } + ], "get": { "description": "Gets information about the hierarchical entity child model.", "operationId": "Models_GetHierarchicalEntityChildInfo", - "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" - } - ], "responses": { "200": { "description": "The hierarchical entity child model info.", @@ -4291,34 +3657,6 @@ "description": "Renames a single child in an existing hierarchical entity model.", "operationId": "Models_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", @@ -4340,36 +3678,6 @@ "delete": { "description": "Deletes a hierarchical entity extractor child from the application.", "operationId": "Models_DeleteHierarchicalEntityChildModel", - "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" - } - ], "responses": { "200": { "description": "" From 5eb0abd10c15eb1f509c638cb85f6a544a21b885 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Fri, 10 Nov 2017 12:44:20 -0800 Subject: [PATCH 07/19] LUIS Endpoint - replace nullable properties with semantically correct x-nullable --- .../Luis/v2.0/LUIS Endpoint API.swagger.json | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) 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 1d67946499e9..8611254f8350 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 @@ -274,29 +274,30 @@ "type": "object", "properties": { "query": { - "type": "string" + "type": "string", + "x-nullable": true }, "topScoringIntent": { - "nullable": true, - "$ref": "#/definitions/IntentModel" + "$ref": "#/definitions/IntentModel", + "x-nullable": true }, "intents": { - "nullable": true, "type": "array", + "x-nullable": true, "items": { "$ref": "#/definitions/IntentModel" } }, "entities": { - "nullable": true, "type": "array", + "x-nullable": true, "items": { "$ref": "#/definitions/EntityModel" } }, "compositeEntities": { "type": "array", - "nullable": true, + "x-nullable": true, "description": "The composite entities extracted from the utterance.", "items": { "$ref": "#/definitions/CompositeEntityModel" From bb49a6a48740d2651f222c5cd302d0c8f0fd010e Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Fri, 10 Nov 2017 13:51:18 -0800 Subject: [PATCH 08/19] create parameters definitions AppIdInPath, VersionIdInPath for LUIS Programatic Swagger file --- .../LUIS Programmatic APIs v2.0.swagger.json | 582 ++++-------------- 1 file changed, 113 insertions(+), 469 deletions(-) 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 5e80c6814d9a..3ca230936aa0 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 @@ -47,18 +47,10 @@ "/apps/{appId}/versions/{versionId}/patterns": { "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" } ], "post": { @@ -151,19 +143,11 @@ "/apps/{appId}/versions/{versionId}/phraselists": { "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" + } ], "post": { "description": "Creates a new phraselist feature.", @@ -247,18 +231,10 @@ "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", @@ -332,18 +308,10 @@ "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { "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": "patternId", @@ -408,18 +376,10 @@ "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { "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": "phraselistId", @@ -488,18 +448,10 @@ "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", @@ -532,18 +484,10 @@ "/apps/{appId}/versions/{versionId}/examples": { "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" } ], "post": { @@ -629,18 +573,10 @@ "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", @@ -660,18 +596,10 @@ "/apps/{appId}/versions/{versionId}/intents": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "post": { @@ -753,18 +681,10 @@ "/apps/{appId}/versions/{versionId}/entities": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "post": { @@ -846,18 +766,10 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "post": { @@ -939,18 +851,10 @@ "/apps/{appId}/versions/{versionId}/compositeentities": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "post": { @@ -1032,18 +936,10 @@ "/apps/{appId}/versions/{versionId}/closedlists": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "post": { @@ -1125,18 +1021,10 @@ "/apps/{appId}/versions/{versionId}/prebuilts": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "in": "path", - "description": "The task version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "post": { @@ -1221,18 +1109,10 @@ "operationId": "Models_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": { @@ -1254,18 +1134,10 @@ "operationId": "Models_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", @@ -1314,18 +1186,10 @@ "/apps/{appId}/versions/{versionId}/intents/{intentId}": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. ID of the application.", - "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", @@ -1390,18 +1254,10 @@ "/apps/{appId}/versions/{versionId}/entities/{entityId}": { "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", @@ -1466,18 +1322,10 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { "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", @@ -1552,18 +1400,10 @@ "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { "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", @@ -1638,18 +1478,10 @@ "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { "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", @@ -1764,18 +1596,10 @@ "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { "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": "prebuiltId", @@ -1819,18 +1643,10 @@ "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { "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", @@ -1885,18 +1701,10 @@ "operationId": "Models_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", @@ -1940,18 +1748,10 @@ "operationId": "Models_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", @@ -2185,11 +1985,7 @@ "operationId": "Apps_DownloadApplicationQueryLogs", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "responses": { @@ -2208,11 +2004,7 @@ "/apps/{appId}": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "get": { @@ -2288,18 +2080,10 @@ "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", @@ -2332,11 +2116,7 @@ "operationId": "Apps_PublishApplication", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application version ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { "name": "applicationPublishObject", @@ -2374,11 +2154,7 @@ "operationId": "Versions_GetApplicationVersions", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { "name": "skip", @@ -2427,18 +2203,10 @@ "/apps/{appId}/versions/{versionId}/": { "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" } ], "get": { @@ -2509,18 +2277,10 @@ "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": { @@ -2619,18 +2379,10 @@ "/apps/{appId}/versions/{versionId}/assignedkey": { "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 id of the app to get the key for.", - "required": true, - "type": "string" + "$ref": "#/parameters/VersionIdInPath" } ], "get": { @@ -2677,18 +2429,10 @@ "/apps/{appId}/versions/{versionId}/externalKeys": { "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" } ], "put": { @@ -2737,18 +2481,10 @@ "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", @@ -2768,18 +2504,10 @@ "/apps/{appId}/versions/{versionId}/train": { "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" } ], "post": { @@ -3006,11 +2734,7 @@ "operationId": "Versions_ImportVersionToApplication", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" }, { "name": "versionId", @@ -3046,11 +2770,7 @@ "/apps/{appId}/settings": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "get": { @@ -3100,18 +2820,10 @@ "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", @@ -3135,11 +2847,7 @@ "/apps/{appId}/permissions": { "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "get": { @@ -3224,11 +2932,7 @@ "operationId": "Apps_GetEndpoints", "parameters": [ { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/AppIdInPath" } ], "responses": { @@ -3255,18 +2959,10 @@ "operationId": "Models_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", @@ -3306,16 +3002,10 @@ "operationId": "Models_AddCustomPrebuiltDomainToApplication", "parameters": [ { - "name": "appId", - "type": "string", - "in": "path", - "required": true + "$ref": "#/parameters/AppIdInPath" }, { - "name": "versionId", - "type": "string", - "in": "path", - "required": true + "$ref": "#/parameters/VersionIdInPath" }, { "name": "prebuiltDomainCreateBaseObject", @@ -3345,18 +3035,10 @@ "/apps/{appId}/versions/{versionId}/customprebuiltintents": { "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" } ], "post": { @@ -3406,18 +3088,10 @@ "/apps/{appId}/versions/{versionId}/customprebuiltentities": { "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" } ], "post": { @@ -3470,18 +3144,10 @@ "operationId": "Models_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": { @@ -3503,18 +3169,10 @@ "operationId": "Models_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", @@ -3605,18 +3263,10 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { "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", @@ -3691,18 +3341,10 @@ "operationId": "Models_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", @@ -3742,18 +3384,10 @@ "operationId": "Models_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", @@ -3793,18 +3427,10 @@ "operationId": "Models_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", @@ -4521,5 +4147,23 @@ }, "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 } ] } ]}" } + }, + "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" + } } } \ No newline at end of file From daf76700b7b8b61afae70dcbf457a0e06858ae65 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Fri, 10 Nov 2017 21:30:58 -0800 Subject: [PATCH 09/19] create additional parameters definitions for LUIS Programmatic Swagger File --- .../LUIS Programmatic APIs v2.0.swagger.json | 498 ++++-------------- 1 file changed, 93 insertions(+), 405 deletions(-) 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 3ca230936aa0..8ce283b4dffe 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 @@ -97,34 +97,10 @@ "operationId": "Features_GetApplicationVersionPatternFeatures", "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": { @@ -182,34 +158,10 @@ "operationId": "Features_GetApplicationVersionPhraselistFeatures", "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": { @@ -237,34 +189,10 @@ "$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": { @@ -524,34 +452,10 @@ "operationId": "Examples_ReviewLabeledExamples", "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": { @@ -635,34 +539,10 @@ "operationId": "Models_GetApplicationVersionIntentInfos", "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": { @@ -720,34 +600,10 @@ "operationId": "Models_GetApplicationVersionEntityInfos", "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": { @@ -805,34 +661,10 @@ "operationId": "Models_GetApplicationVersionHierarchicalEntityInfos", "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": { @@ -890,34 +722,10 @@ "operationId": "Models_GetApplicationVersionCompositeEntityInfos", "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": { @@ -975,34 +783,10 @@ "operationId": "Models_GetApplicationVersionClosedListInfos", "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": { @@ -1060,34 +844,10 @@ "operationId": "Models_GetApplicationVersionPrebuiltInfos", "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": { @@ -1140,34 +900,10 @@ "$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": { @@ -1192,11 +928,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "intentId", - "in": "path", - "description": "Format - guid. The intent classifier ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/IntentIdInPath" } ], "get": { @@ -1328,11 +1060,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/HEntityIdInPath" } ], "get": { @@ -1406,11 +1134,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The composite entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/CEntityIdInPath" } ], "get": { @@ -1707,26 +1431,10 @@ "$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": { @@ -1761,19 +1469,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": { @@ -1823,34 +1519,10 @@ "operationId": "Apps_GetUserApplications", "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": { @@ -2157,34 +1829,10 @@ "$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": { @@ -3269,11 +2917,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor parent ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/HEntityIdInPath" }, { "name": "hChildId", @@ -3347,11 +2991,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "hEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/HEntityIdInPath" }, { "name": "body", @@ -3390,11 +3030,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The composite entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/CEntityIdInPath" }, { "name": "body", @@ -3433,11 +3069,7 @@ "$ref": "#/parameters/VersionIdInPath" }, { - "name": "cEntityId", - "in": "path", - "description": "Format - guid. The hierarchical entity extractor ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/CEntityIdInPath" }, { "name": "cChildId", @@ -4164,6 +3796,62 @@ "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-enum": { + "name": "SkipParameter", + "modelAsString": false + }, + "enum": [ + 0 + ], + "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-enum": { + "name": "TakeParameter", + "modelAsString": false + }, + "enum": [ + 100 + ], + "x-ms-parameter-location": "method" + } } } \ No newline at end of file From 71927b83e5b32c21f4fdb170f9925bf5a6d41185 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Mon, 13 Nov 2017 13:36:33 -0800 Subject: [PATCH 10/19] begin moving 'models' group operations to 'model' group, add response schemas for 'model' group operations --- .../LUIS Programmatic APIs v2.0.swagger.json | 466 ++++++++++++++++-- 1 file changed, 422 insertions(+), 44 deletions(-) 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 8ce283b4dffe..4b96173bf789 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 @@ -508,7 +508,7 @@ ], "post": { "description": "Adds an intent classifier to the application.", - "operationId": "Models_CreateIntentClassifier", + "operationId": "Model_CreateIntentClassifier", "parameters": [ { "name": "modelCreateObject", @@ -527,6 +527,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -569,7 +572,7 @@ ], "post": { "description": "Adds an entity extractor to the application.", - "operationId": "Models_CreateEntityExtractor", + "operationId": "Model_CreateEntityExtractor", "parameters": [ { "name": "modelCreateObject", @@ -588,6 +591,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"3d73462d-98f0-4dcd-8d30-fab9e65f2e73\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -630,7 +636,7 @@ ], "post": { "description": "Adds a hierarchical entity extractor to the application version.", - "operationId": "Models_CreateHierarchicalEntityExtractor", + "operationId": "Model_CreateHierarchicalEntityExtractor", "parameters": [ { "name": "hierarchicalModelCreateObject", @@ -649,6 +655,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"fe559c31-9778-42ea-ba45-94e0bd7cf767\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -658,7 +667,7 @@ }, "get": { "description": "Gets information about the hierarchical entity models.", - "operationId": "Models_GetApplicationVersionHierarchicalEntityInfos", + "operationId": "Model_GetApplicationVersionHierarchicalEntityInfos", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -672,6 +681,9 @@ "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/HierarchicalEntityExtractorResponse" } } }, @@ -691,7 +703,7 @@ ], "post": { "description": "Adds a composite entity extractor to the application.", - "operationId": "Models_CreateCompositeEntityExtractor", + "operationId": "Model_CreateCompositeEntityExtractor", "parameters": [ { "name": "hierarchicalModelCreateObject", @@ -710,6 +722,9 @@ "description": "The ID of the created Model.", "examples": { "application/json": "\"bc1bae43-7904-48ad-a165-88b1910174f9\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -719,7 +734,7 @@ }, "get": { "description": "Gets information about the composite entity models.", - "operationId": "Models_GetApplicationVersionCompositeEntityInfos", + "operationId": "Model_GetApplicationVersionCompositeEntityInfos", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -733,6 +748,9 @@ "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/CompositeEntityExtractorResponse" } } }, @@ -752,7 +770,7 @@ ], "post": { "description": "Adds a closed list model to the application.", - "operationId": "Models_CreateClosedListEntityModel", + "operationId": "Model_CreateClosedListEntityModel", "parameters": [ { "name": "closedListModelCreateObject", @@ -771,6 +789,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"8713b104-78ec-4c4f-9f96-f2e53562cc16\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -780,7 +801,7 @@ }, "get": { "description": "Gets information about the closedlist models.", - "operationId": "Models_GetApplicationVersionClosedListInfos", + "operationId": "Model_GetApplicationVersionClosedListInfos", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -794,6 +815,9 @@ "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/ClosedListEntityExtractorResponse" } } }, @@ -813,7 +837,7 @@ ], "post": { "description": "Adds a list of prebuilt entity extractors to the application.", - "operationId": "Models_AddPrebuiltEntityExtractors", + "operationId": "Model_AddPrebuiltEntityExtractors", "parameters": [ { "name": "prebuiltExtractorNames", @@ -832,6 +856,9 @@ "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/PrebuiltEntityExtractorResponse" } } }, @@ -841,7 +868,7 @@ }, "get": { "description": "Gets information about the prebuilt entity models.", - "operationId": "Models_GetApplicationVersionPrebuiltInfos", + "operationId": "Model_GetApplicationVersionPrebuiltInfos", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -855,6 +882,9 @@ "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/PrebuiltEntityExtractorResponse" } } }, @@ -891,7 +921,7 @@ "/apps/{appId}/versions/{versionId}/models": { "get": { "description": "Gets information about the application version models.", - "operationId": "Models_GetApplicationVersionModelInfos", + "operationId": "Model_GetApplicationVersionModelInfos", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -911,6 +941,9 @@ "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" } } }, @@ -1021,7 +1054,7 @@ }, "put": { "description": "Updates the name of an entity extractor.", - "operationId": "Models_RenameEntityModel", + "operationId": "Model_RenameEntityModel", "parameters": [ { "name": "modelUpdateObject", @@ -1043,7 +1076,7 @@ }, "delete": { "description": "Deletes an entity extractor from the application.", - "operationId": "Models_DeleteEntityModel", + "operationId": "Model_DeleteEntityModel", "responses": { "200": { "description": "" @@ -1095,7 +1128,7 @@ }, "put": { "description": "Updates the name and children of a hierarchical entity model.", - "operationId": "Models_UpdateHierarchicalEntityModel", + "operationId": "Model_UpdateHierarchicalEntityModel", "parameters": [ { "name": "hierarchicalModelUpdateObject", @@ -1117,7 +1150,7 @@ }, "delete": { "description": "Deletes a hierarchical entity extractor from the application version.", - "operationId": "Models_DeleteHierarchicalEntityModel", + "operationId": "Model_DeleteHierarchicalEntityModel", "responses": { "200": { "description": "" @@ -1169,7 +1202,7 @@ }, "put": { "description": "Updates the composite entity extractor.", - "operationId": "Models_UpdateCompositeEntityModel", + "operationId": "Model_UpdateCompositeEntityModel", "parameters": [ { "name": "hierarchicalModelUpdateObject", @@ -1191,7 +1224,7 @@ }, "delete": { "description": "Deletes a composite entity extractor from the application.", - "operationId": "Models_DeleteCompositeEntityModel", + "operationId": "Model_DeleteCompositeEntityModel", "responses": { "200": { "description": "" @@ -1265,7 +1298,7 @@ }, "put": { "description": "Updates the closed list model.", - "operationId": "Models_UpdateClosedListEntityModel", + "operationId": "Model_UpdateClosedListEntityModel", "parameters": [ { "name": "closedListModelUpdateObject", @@ -1287,7 +1320,7 @@ }, "patch": { "description": "Adds a batch of sublists to an existing closedlist.", - "operationId": "Models_PatchClosedListEntityModel", + "operationId": "Model_PatchClosedListEntityModel", "parameters": [ { "name": "closedListModelPatchObject", @@ -1309,7 +1342,7 @@ }, "delete": { "description": "Deletes a closed list model from the application.", - "operationId": "Models_DeleteClosedListEntityModel", + "operationId": "Model_DeleteClosedListEntityModel", "responses": { "200": { "description": "" @@ -1355,8 +1388,7 @@ }, "delete": { "description": "Deletes a prebuilt entity extractor from the application.", - "operationId": "Models_DeletePrebuiltModel", - + "operationId": "Model_DeletePrebuiltModel", "responses": { "200": { "description": "" @@ -1389,7 +1421,7 @@ ], "delete": { "description": "Deletes a sublist of a specific closed list model.", - "operationId": "Models_DeleteSubList", + "operationId": "Model_DeleteSubList", "responses": { "200": { "description": "" @@ -1398,7 +1430,7 @@ }, "put": { "description": "Updates one of the closed list's sublists", - "operationId": "Models_UpdateSubList", + "operationId": "Model_UpdateSubList", "parameters": [ { "name": "wordListBaseUpdateObject", @@ -1507,6 +1539,9 @@ "description": "The ID of the created application.", "examples": { "application/json": "\"363187f1-c573-46b3-bc4c-ae01d686e68e\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -1592,6 +1627,9 @@ "Italian": "ItalianDummyURL" } } + }, + "schema": { + "$ref": "#/definitions/PersonalAssistantsResponse" } } }, @@ -2710,6 +2748,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"c0d59374-cf44-4302-98d1-e853886a4674\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -2814,7 +2855,7 @@ "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { "delete": { "description": "Deletes a prebuilt domain's models from the application.", - "operationId": "Models_DeleteCustomPrebuiltDomainModels", + "operationId": "Model_DeleteCustomPrebuiltDomainModels", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -2874,6 +2915,9 @@ "description": "The ID of the created application.", "examples": { "application/json": "\"739f1513-11f0-4aae-8a19-f660804e6da5\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -2949,7 +2993,7 @@ }, "put": { "description": "Renames a single child in an existing hierarchical entity model.", - "operationId": "Models_UpdateHierarchicalEntityChildModel", + "operationId": "Model_UpdateHierarchicalEntityChildModel", "parameters": [ { "name": "body", @@ -2971,7 +3015,7 @@ }, "delete": { "description": "Deletes a hierarchical entity extractor child from the application.", - "operationId": "Models_DeleteHierarchicalEntityChildModel", + "operationId": "Model_DeleteHierarchicalEntityChildModel", "responses": { "200": { "description": "" @@ -2982,7 +3026,7 @@ "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children": { "post": { "description": "Creates a single child in an existing hierarchical entity model.", - "operationId": "Models_CreateHierarchicalEntityChildModel", + "operationId": "Model_CreateHierarchicalEntityChildModel", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -3010,6 +3054,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"891c235f-4f42-4320-bc36-b6256b6c3f2b\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -3021,7 +3068,7 @@ "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { "post": { "description": "Creates a single child in an existing composite entity model.", - "operationId": "Models_CreateCompositeEntityChildModel", + "operationId": "Model_CreateCompositeEntityChildModel", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -3049,6 +3096,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"891c235f-4f42-4320-bc36-b6256b6c3f2b\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -3060,7 +3110,7 @@ "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { "delete": { "description": "Deletes a composite entity extractor child from the application.", - "operationId": "Models_DeleteCompositeEntityChildModel", + "operationId": "Model_DeleteCompositeEntityChildModel", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -3778,6 +3828,348 @@ } }, "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": { + "additionalProperties": false, + "type": "string", + "example": "\"363187f1-c573-46b3-bc4c-ae01d686e68e\"" + }, + "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 + } + }, + "required": [ + "id", "text", "tokenizedText", + "intentLabel", "intentPredictions" + ] + }, + "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", + "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" + } + } + } + }, + "HierarchicalEntityExtractorResponse": { + "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" + } + } + } + }, + "CompositeEntityExtractorResponse": { + "type": "array", + "items": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "ClosedListEntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Closed List Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ] + }, + "ClosedListEntityExtractorResponse": { + "type": "array", + "items": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "PrebuiltEntityExtractor": { + "type": "object", + "x-ms-discriminator-value": "Prebuilt Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ] + }, + "PrebuiltEntityExtractorResponse": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "ChildEntity": { + "properties": { + "id": { + "type": "string", + "description": "The GUID belonging to a child entity." + }, + "name": { + "type": "string", + "description": "The name of a child entity." + } + } + }, + "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 + } + } } }, "parameters": { @@ -3828,13 +4220,6 @@ "type": "integer", "default": 0, "x-nullable": "false", - "x-ms-enum": { - "name": "SkipParameter", - "modelAsString": false - }, - "enum": [ - 0 - ], "x-ms-parameter-location": "method" }, "TakeInPath": { @@ -3844,13 +4229,6 @@ "type": "integer", "default": 100, "x-nullable": "false", - "x-ms-enum": { - "name": "TakeParameter", - "modelAsString": false - }, - "enum": [ - 100 - ], "x-ms-parameter-location": "method" } } From 642f0c52f705efccd52499cf2f34c0c338fbf731 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 14 Nov 2017 09:32:52 -0800 Subject: [PATCH 11/19] add defnitions and response schemas to LUIS Programmatic Swagger File --- .../LUIS Programmatic APIs v2.0.swagger.json | 418 +++++++++++++++++- 1 file changed, 403 insertions(+), 15 deletions(-) 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 4b96173bf789..98568ddc0885 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 @@ -74,6 +74,9 @@ "description": "The ID of the created feature.", "examples": { "application/json": "83147" + }, + "schema": { + "$ref": "#/definitions/FeatureIDResponse" } }, "400": { @@ -108,6 +111,9 @@ "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" } } }, @@ -146,6 +152,9 @@ "description": "The ID of the created feature.", "examples": { "application/json": "1823" + }, + "schema": { + "$ref": "#/definitions/FeatureIDResponse" } } }, @@ -169,6 +178,9 @@ "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" } } }, @@ -225,6 +237,9 @@ } ] } + }, + "schema": { + "$ref": "#/definitions/FeaturesResponseObject" } } }, @@ -262,6 +277,9 @@ "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", "isActive": true } + }, + "schema": { + "$ref": "#/definitions/PatternFeatureInfo" } } }, @@ -331,6 +349,9 @@ "isExchangeable": true, "isActive": true } + }, + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfo" } } }, @@ -401,6 +422,9 @@ "UtteranceText": "book me a flight from cairo to redmond next thursday", "ExampleId": -11 } + }, + "schema": { + "$ref": "#/definitions/LabelExampleResponse" } } }, @@ -440,6 +464,9 @@ "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" } } }, @@ -553,6 +580,9 @@ "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" } } }, @@ -617,6 +647,9 @@ "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" } } }, @@ -683,7 +716,7 @@ "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/HierarchicalEntityExtractorResponse" + "$ref": "#/definitions/HierarchicalEntityExtractorsList" } } }, @@ -750,7 +783,7 @@ "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/CompositeEntityExtractorResponse" + "$ref": "#/definitions/CompositeEntityExtractorsList" } } }, @@ -817,7 +850,7 @@ "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/ClosedListEntityExtractorResponse" + "$ref": "#/definitions/ClosedListEntityExtractorsList" } } }, @@ -858,7 +891,7 @@ "application/json": "[ { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\", \"typeId\": 2, \"readableType\": \"Prebuilt Entity Extractor\" }]" }, "schema": { - "$ref": "#/definitions/PrebuiltEntityExtractorResponse" + "$ref": "#/definitions/PrebuiltEntityExtractorsList" } } }, @@ -884,7 +917,7 @@ "application/json": "[ { \"id\": \"a18eaa87-ecd9-4a67-a951-e70cf5b87c7e\", \"name\": \"datetime\", \"typeId\": 2, \"readableType\": \"Prebuilt Entity Extractor\" }]" }, "schema": { - "$ref": "#/definitions/PrebuiltEntityExtractorResponse" + "$ref": "#/definitions/PrebuiltEntityExtractorsList" } } }, @@ -966,7 +999,7 @@ ], "get": { "description": "Gets information about the intent model.", - "operationId": "Models_GetIntentInfo", + "operationId": "Model_GetIntentInfo", "responses": { "200": { "description": "An intent model info.", @@ -977,6 +1010,9 @@ "typeId": 0, "readableType": "Intent Classifier" } + }, + "schema": { + "$ref": "#/definitions/IntentClassifier" } } }, @@ -986,7 +1022,7 @@ }, "put": { "description": "Updates the name of an intent classifier.", - "operationId": "Models_RenameIntentModel", + "operationId": "Model_RenameIntentModel", "parameters": [ { "name": "modelUpdateObject", @@ -1008,7 +1044,7 @@ }, "delete": { "description": "Deletes an intent classifier from the application.", - "operationId": "Models_DeleteIntentModel", + "operationId": "Model_DeleteIntentModel", "responses": { "200": { "description": "" @@ -1045,6 +1081,9 @@ "typeId": 1, "readableType": "Entity Extractor" } + }, + "schema": { + "$ref": "#/definitions/EntityExtractor" } } }, @@ -1119,6 +1158,9 @@ } ] } + }, + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractor" } } }, @@ -1193,6 +1235,9 @@ } ] } + }, + "schema": { + "$ref": "#/definitions/CompositeEntityExtractor" } } }, @@ -1289,6 +1334,9 @@ } ] } + }, + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractor" } } }, @@ -1379,6 +1427,9 @@ "typeId": 2, "readableType": "Prebuilt Entity Extractor" } + }, + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractor" } } }, @@ -2201,7 +2252,10 @@ "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.", @@ -2288,6 +2342,9 @@ "description": "A list containing subscription keys info.", "examples": { "application/json": "[ { \"subscriptionKey\": \"dummykey\", \"subscriptionName\": \"DummyName\", \"subscriptionRegion\":\"westus\" }]" + }, + "schema": { + "$ref": "#/definitions/SubscriptionKeyList" } } }, @@ -2674,6 +2731,9 @@ "description": "The id of the newly created list", "examples": { "application/json": "90440" + }, + "schema": { + "$ref": "#/definitions/ApplicationsInfoList" } } }, @@ -2710,6 +2770,9 @@ "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" } } }, @@ -2766,6 +2829,9 @@ "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" } } }, @@ -2804,6 +2870,9 @@ "description": "The ID of the created model.", "examples": { "application/json": "\"1c2e70c1-3cbf-4e89-9703-9583b81102b9\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -2819,6 +2888,9 @@ "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" } } }, @@ -2844,6 +2916,9 @@ "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" } } }, @@ -2887,6 +2962,9 @@ "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" } } }, @@ -2944,6 +3022,9 @@ "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" } } }, @@ -3328,6 +3409,20 @@ } } }, + "JSONSubClosedListResponse": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/JSONSubClosedList" + } + ], + "properties": { + "id": { + "type": "number", + "example": "123456" + } + } + }, "JSONAction": { "additionalProperties": false, "type": "object", @@ -3830,10 +3925,13 @@ "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": { - "additionalProperties": false, "type": "string", "example": "\"363187f1-c573-46b3-bc4c-ae01d686e68e\"" }, + "FeatureIDResponse": { + "type": "number", + "example": "398102" + }, "LabeledUtterances": { "type": "array", "items": { @@ -4062,7 +4160,7 @@ } } }, - "HierarchicalEntityExtractorResponse": { + "HierarchicalEntityExtractorsList": { "type": "array", "items": { "$ref": "#/definitions/HierarchicalEntityExtractor" @@ -4085,7 +4183,7 @@ } } }, - "CompositeEntityExtractorResponse": { + "CompositeEntityExtractorsList": { "type": "array", "items": { "$ref": "#/definitions/CompositeEntityExtractor" @@ -4098,9 +4196,17 @@ { "$ref": "#/definitions/ModelInfo" } - ] + ], + "properties": { + "subLists": { + "type": "array", + "items": { + "$ref": "#/definitions/JSONSubClosedListResponse" + } + } + } }, - "ClosedListEntityExtractorResponse": { + "ClosedListEntityExtractorsList": { "type": "array", "items": { "$ref": "#/definitions/ClosedListEntityExtractor" @@ -4115,7 +4221,7 @@ } ] }, - "PrebuiltEntityExtractorResponse": { + "PrebuiltEntityExtractorsList": { "type": "array", "items": { "$ref": "#/definitions/PrebuiltEntityExtractor" @@ -4170,6 +4276,288 @@ "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" + } + } + }, + "EnqueueTrainingResponse": { + "type": "object", + "properties": { + "statusId": { + "type": "number" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + } + } + }, + "TrainingStatus": { + "type": "string", + "enum": [ + "Queued" + ] + }, + "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" + } + } + } + }, + "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": { From 9db2e6ec73faa0cb59f33e00855374af857d7f39 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Wed, 15 Nov 2017 21:20:50 -0800 Subject: [PATCH 12/19] add additional definitions and response schemas to LUIS Programmatic File --- .../LUIS Programmatic APIs v2.0.swagger.json | 241 ++++++++++++++++-- 1 file changed, 213 insertions(+), 28 deletions(-) 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 98568ddc0885..ed0ff6ed8fa2 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 @@ -490,6 +490,9 @@ "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" } } }, @@ -566,7 +569,7 @@ }, "get": { "description": "Gets information about the intent models.", - "operationId": "Models_GetApplicationVersionIntentInfos", + "operationId": "Model_GetApplicationVersionIntentInfos", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -633,7 +636,7 @@ }, "get": { "description": "Gets information about the entity models.", - "operationId": "Models_GetApplicationVersionEntityInfos", + "operationId": "Model_GetApplicationVersionEntityInfos", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -929,7 +932,7 @@ "/apps/{appId}/versions/{versionId}/listprebuilts": { "get": { "description": "Gets all the available prebuilt entity extractors for the application.", - "operationId": "Models_GetAvailablePrebuiltEntityExtractors", + "operationId": "Model_GetAvailablePrebuiltEntityExtractors", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -1070,7 +1073,7 @@ ], "get": { "description": "Gets information about the entity model.", - "operationId": "Models_GetEntityInfo", + "operationId": "Model_GetEntityInfo", "responses": { "200": { "description": "An entity model info.", @@ -1137,7 +1140,7 @@ ], "get": { "description": "Gets information about the hierarchical entity model.", - "operationId": "Models_GetHierarchicalEntityInfo", + "operationId": "Model_GetHierarchicalEntityInfo", "responses": { "200": { "description": "A hierarchical entity model info.", @@ -1214,7 +1217,7 @@ ], "get": { "description": "Gets information about the composite entity model.", - "operationId": "Models_GetCompositeEntityInfo", + "operationId": "Model_GetCompositeEntityInfo", "responses": { "200": { "description": "The composite entity model info.", @@ -1295,7 +1298,7 @@ ], "get": { "description": "Gets information of a closed list model.", - "operationId": "Models_GetClosedListEntityInfo", + "operationId": "Model_GetClosedListEntityInfo", "responses": { "200": { "description": "The closed list model info.", @@ -1416,7 +1419,7 @@ ], "get": { "description": "Gets information about the prebuilt entity model.", - "operationId": "Models_GetPrebuiltInfo", + "operationId": "Model_GetPrebuiltInfo", "responses": { "200": { "description": "A prebuilt entity models info.", @@ -1505,7 +1508,7 @@ "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { "get": { "description": "Suggests examples that would improve the accuracy of the intent model.", - "operationId": "Models_SuggestEndpointQueriesForIntents", + "operationId": "Model_SuggestEndpointQueriesForIntents", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -1536,7 +1539,7 @@ "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { "get": { "description": "Suggests examples that would improve the accuracy of the entity model.", - "operationId": "Models_SuggestEndpointQueriesForEntities", + "operationId": "Model_SuggestEndpointQueriesForEntities", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -1616,6 +1619,9 @@ "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" } } }, @@ -1652,6 +1658,9 @@ "description": "The ID of the imported application.", "examples": { "application/json": "\"f8c64e2a-8635-4a09-8f78-39d7adc76ec5\"" + }, + "schema": { + "$ref": "#/definitions/GuidResponse" } } }, @@ -1698,6 +1707,9 @@ "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" } } }, @@ -1715,6 +1727,9 @@ "description": "A list object containing the available application usage scenarios.", "examples": { "application/json": "[ \"IoT\", \"Bot\", \"Mobile Application\", \"Other\"]" + }, + "schema": { + "$ref": "#/definitions/ApplicationUsageScenarios" } } }, @@ -1732,6 +1747,9 @@ "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" } } }, @@ -1796,6 +1814,9 @@ }, "endpointHitsCount": 0 } + }, + "schema": { + "$ref": "#/definitions/ApplicationInfoResponse" } } }, @@ -2277,6 +2298,9 @@ "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 } }]" + }, + "schema": { + "$ref": "#/definitions/ModelTrainingInfoList" } }, "400": { @@ -2527,6 +2551,9 @@ "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", "public": false } + }, + "schema": { + "$ref": "#/definitions/ApplicationSettings" } } }, @@ -2598,9 +2625,15 @@ "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" + } } - } + }, + "produces": [ + "application/json" + ] }, "post": { "description": "Adds a user to the allowed list of users to access this LUIS application.Users are added using their email address.", @@ -2666,7 +2699,10 @@ "200": { "description": "" } - } + }, + "produces": [ + "application/json" + ] } }, "/apps/{appId}/endpoints": { @@ -2688,6 +2724,9 @@ "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" } } }, @@ -2699,7 +2738,7 @@ "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { "post": { "description": "Adds a list to an existing closed list", - "operationId": "Models_AddSubList", + "operationId": "Model_AddSubList", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -2745,7 +2784,7 @@ "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { "post": { "description": "Adds a customizable prebuilt domain along with all of its models to this application.", - "operationId": "Models_AddCustomPrebuiltDomainToApplication", + "operationId": "Model_AddCustomPrebuiltDomainToApplication", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -2792,7 +2831,7 @@ ], "post": { "description": "Adds a custom prebuilt intent model to the application", - "operationId": "Models_AddCustomPrebuiltIntentModel", + "operationId": "Model_AddCustomPrebuiltIntentModel", "parameters": [ { "name": "prebuiltDomainModelCreateObject", @@ -2823,7 +2862,7 @@ }, "get": { "description": "Gets custom prebuilt intents information of this application", - "operationId": "Models_GetCustomPrebuiltDomainIntentsInfo", + "operationId": "Model_GetCustomPrebuiltDomainIntentsInfo", "responses": { "200": { "description": "Returns a list of all custom prebuilt intents and their representations.", @@ -2851,7 +2890,7 @@ ], "post": { "description": "Adds a custom prebuilt entity model to the application", - "operationId": "Models_AddCustomPrebuiltEntityModel", + "operationId": "Model_AddCustomPrebuiltEntityModel", "parameters": [ { "name": "prebuiltDomainModelCreateObject", @@ -2882,7 +2921,7 @@ }, "get": { "description": "Gets all custom prebuilt entities information of this application", - "operationId": "Models_GetCustomPrebuiltDomainEntitiesInfo", + "operationId": "Model_GetCustomPrebuiltDomainEntitiesInfo", "responses": { "200": { "description": "Returns a list of all custom prebuilt entities and their representations.", @@ -2902,7 +2941,7 @@ "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { "get": { "description": "Gets all custom prebuilt models information of this application", - "operationId": "Models_GetCustomPrebuiltDomainModelsInfo", + "operationId": "Model_GetCustomPrebuiltDomainModelsInfo", "parameters": [ { "$ref": "#/parameters/AppIdInPath" @@ -3054,7 +3093,7 @@ ], "get": { "description": "Gets information about the hierarchical entity child model.", - "operationId": "Models_GetHierarchicalEntityChildInfo", + "operationId": "Model_GetHierarchicalEntityChildInfo", "responses": { "200": { "description": "The hierarchical entity child model info.", @@ -3877,7 +3916,8 @@ "items": { "type": "string" }, - "type": "array" + "type": "array", + "x-ms-client-name": "bing_entities" }, "actions": { "items": { @@ -3979,11 +4019,7 @@ }, "x-nullable": true } - }, - "required": [ - "id", "text", "tokenizedText", - "intentLabel", "intentPredictions" - ] + } }, "EntityLabel": { "type": "object", @@ -4467,6 +4503,78 @@ } } }, + "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" + } + } + }, "EnqueueTrainingResponse": { "type": "object", "properties": { @@ -4481,9 +4589,52 @@ "TrainingStatus": { "type": "string", "enum": [ - "Queued" + "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": { @@ -4513,6 +4664,40 @@ } } }, + "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" + }, + "message": { + "type": "string" + } + } + }, "PrebuiltDomainsList": { "type": "array", "items": { From 7bc9cb632e6423b5df904f8dbbbf2fd437139601 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Thu, 16 Nov 2017 14:19:27 -0800 Subject: [PATCH 13/19] add Error Response definition and use in operations in LUIS Programmatic Swagger File --- .../LUIS Programmatic APIs v2.0.swagger.json | 729 +++++++++++++++++- 1 file changed, 701 insertions(+), 28 deletions(-) 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 ed0ff6ed8fa2..084a13a5dbcf 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 @@ -79,15 +79,10 @@ "$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" } } }, @@ -115,6 +110,12 @@ "schema": { "$ref": "#/definitions/PatternFeatureInfoList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -156,6 +157,12 @@ "schema": { "$ref": "#/definitions/FeatureIDResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -182,6 +189,12 @@ "schema": { "$ref": "#/definitions/PhraseListFeatureInfoList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -241,6 +254,12 @@ "schema": { "$ref": "#/definitions/FeaturesResponseObject" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -281,6 +300,12 @@ "schema": { "$ref": "#/definitions/PatternFeatureInfo" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -306,6 +331,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -315,6 +346,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -353,6 +390,12 @@ "schema": { "$ref": "#/definitions/PhraseListFeatureInfo" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -378,6 +421,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -387,6 +436,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -426,6 +481,12 @@ "schema": { "$ref": "#/definitions/LabelExampleResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -468,6 +529,12 @@ "schema": { "$ref": "#/definitions/BatchLabelExampleResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -494,6 +561,12 @@ "schema": { "$ref": "#/definitions/LabeledUtterances" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -523,6 +596,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -587,6 +666,12 @@ "schema": { "$ref": "#/definitions/IntentClassifiersList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -628,6 +713,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -654,6 +745,12 @@ "schema": { "$ref": "#/definitions/EntityExtractorsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -695,6 +792,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -721,6 +824,12 @@ "schema": { "$ref": "#/definitions/HierarchicalEntityExtractorsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -762,6 +871,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -788,6 +903,12 @@ "schema": { "$ref": "#/definitions/CompositeEntityExtractorsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -829,6 +950,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -855,6 +982,12 @@ "schema": { "$ref": "#/definitions/ClosedListEntityExtractorsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -896,6 +1029,12 @@ "schema": { "$ref": "#/definitions/PrebuiltEntityExtractorsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -922,6 +1061,12 @@ "schema": { "$ref": "#/definitions/PrebuiltEntityExtractorsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -946,6 +1091,15 @@ "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" } } }, @@ -981,6 +1135,12 @@ "schema": { "$ref": "#/definitions/ModelsResponseObject" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1017,6 +1177,12 @@ "schema": { "$ref": "#/definitions/IntentClassifier" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1042,6 +1208,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1051,6 +1223,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1088,6 +1266,12 @@ "schema": { "$ref": "#/definitions/EntityExtractor" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1113,6 +1297,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1122,6 +1312,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1165,6 +1361,12 @@ "schema": { "$ref": "#/definitions/HierarchicalEntityExtractor" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1190,6 +1392,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1199,6 +1407,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1242,6 +1456,12 @@ "schema": { "$ref": "#/definitions/CompositeEntityExtractor" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1267,6 +1487,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1276,6 +1502,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1341,6 +1573,12 @@ "schema": { "$ref": "#/definitions/ClosedListEntityExtractor" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1366,6 +1604,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1388,6 +1632,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1397,6 +1647,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1434,6 +1690,12 @@ "schema": { "$ref": "#/definitions/PrebuiltEntityExtractor" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1446,6 +1708,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1479,6 +1747,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1501,6 +1775,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1529,6 +1809,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": [ @@ -1564,6 +1850,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": [ @@ -1597,6 +1889,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1623,6 +1921,12 @@ "schema": { "$ref": "#/definitions/ApplicationsInfoList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1662,6 +1966,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1691,6 +2001,12 @@ "schema": { "$ref": "#/definitions/PersonalAssistantsResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1711,6 +2027,12 @@ "schema": { "$ref": "#/definitions/AvailableDomains" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1731,6 +2053,12 @@ "schema": { "$ref": "#/definitions/ApplicationUsageScenarios" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1751,6 +2079,12 @@ "schema": { "$ref": "#/definitions/AvailableCultures" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1773,6 +2107,12 @@ "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\"\": []}\"" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1818,6 +2158,12 @@ "schema": { "$ref": "#/definitions/ApplicationInfoResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1843,6 +2189,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -1852,6 +2204,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -1885,6 +2243,12 @@ "examples": { "application/json": "\"0.2\"" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -1922,6 +2286,15 @@ "endpointRegion": "westus", "isStaging": false } + }, + "schema": { + "$ref": "#/definitions/ApplicationPublishResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" } } }, @@ -1951,6 +2324,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": [ @@ -1991,6 +2370,12 @@ "endpointHitsCount": 0 } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2016,6 +2401,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -2025,6 +2416,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2127,6 +2524,12 @@ ] } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2155,6 +2558,12 @@ "subscriptionKey": "DummyKey" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2180,6 +2589,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2212,6 +2627,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -2226,6 +2647,12 @@ "BingSpellCheck": "40fd1383c949492cb16d7b082dcaac82" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2255,6 +2682,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2278,10 +2711,10 @@ "$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" } } }, @@ -2303,19 +2736,10 @@ "$ref": "#/definitions/ModelTrainingInfoList" } }, - "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\" }}" - } - }, - "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" } } }, @@ -2352,6 +2776,12 @@ "subscriptionRegion": "westus" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2370,6 +2800,12 @@ "schema": { "$ref": "#/definitions/SubscriptionKeyList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2395,6 +2831,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2419,6 +2861,12 @@ "responses": { "201": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -2431,6 +2879,12 @@ "examples": { "application/json": "[ { \"type\": \"bingspellcheck\", \"values\": [ \"ee29eff4fe914fe282ad75d16328d717\" ] }]" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2448,6 +2902,12 @@ "examples": { "application/json": "\"NewDummyProgrammaticKey\"" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2471,6 +2931,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2491,6 +2957,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2527,6 +2999,12 @@ "examples": { "application/json": "\"0.2\"" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2555,6 +3033,12 @@ "schema": { "$ref": "#/definitions/ApplicationSettings" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2580,6 +3064,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2610,6 +3100,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -2629,6 +3125,12 @@ "schema": { "$ref": "#/definitions/UserAccessList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2654,6 +3156,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -2676,6 +3184,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -2698,6 +3212,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2728,6 +3248,12 @@ "schema": { "$ref": "#/definitions/AvailableEndpoints" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2774,6 +3300,12 @@ "schema": { "$ref": "#/definitions/ApplicationsInfoList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2813,6 +3345,12 @@ "schema": { "$ref": "#/definitions/GuidList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2854,6 +3392,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2872,6 +3416,12 @@ "schema": { "$ref": "#/definitions/ModelsResponseObject" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2913,6 +3463,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2931,6 +3487,12 @@ "schema": { "$ref": "#/definitions/ModelsResponseObject" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2959,6 +3521,12 @@ "schema": { "$ref": "#/definitions/ModelsResponseObject" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -2988,6 +3556,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3005,6 +3579,12 @@ "schema": { "$ref": "#/definitions/PrebuiltDomainsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3036,6 +3616,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3065,6 +3651,12 @@ "schema": { "$ref": "#/definitions/PrebuiltDomainsList" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3105,6 +3697,12 @@ "readableType": "Hierarchical Child Entity Extractor" } } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3130,6 +3728,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } }, @@ -3139,6 +3743,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -3178,6 +3788,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3220,6 +3836,12 @@ "schema": { "$ref": "#/definitions/GuidResponse" } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, "produces": [ @@ -3252,6 +3874,12 @@ "responses": { "200": { "description": "" + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } } } @@ -4503,6 +5131,23 @@ } } }, + "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.", @@ -4575,6 +5220,26 @@ } } }, + "AvailablePrebuiltEntityModel": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + } + } + }, + "AvailablePrebuiltEntityModels": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrebuiltEntityModel" + } + }, "EnqueueTrainingResponse": { "type": "object", "properties": { @@ -4691,10 +5356,18 @@ "type": "object", "properties": { "code": { - "type": "string" + "type": "string", + "example": "BadArgument", + "x-nullable": true + }, + "statusCode": { + "type": "number", + "example": "401", + "x-nullable": true }, "message": { - "type": "string" + "type": "string", + "example": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription." } } }, From 0456dfe15668890524c74d0381a37ffbb4713f85 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Thu, 16 Nov 2017 16:26:49 -0800 Subject: [PATCH 14/19] add examples for Model GET operations in LUIS Programmatic Swagger File --- .../LUIS Programmatic APIs v2.0.swagger.json | 90 +++++++------ ...licationVersionClosedListInfosRequest.json | 50 +++++++ ...ionVersionCompositeEntityInfosRequest.json | 32 +++++ ...tApplicationVersionEntityInfosRequest.json | 30 +++++ ...VersionHierarchicalEntityInfosRequest.json | 32 +++++ ...tApplicationVersionIntentInfosRequest.json | 36 ++++++ ...etApplicationVersionModelInfosRequest.json | 122 ++++++++++++++++++ ...pplicationVersionPrebuiltInfosRequest.json | 22 ++++ ...ilablePrebuiltEntityExtractorsRequest.json | 41 ++++++ ...uccessfulReviewLabeledExamplesRequest.json | 110 ++++++++++++++++ 10 files changed, 529 insertions(+), 36 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionEntityInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionIntentInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionModelInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulReviewLabeledExamplesRequest.json 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 084a13a5dbcf..dd2657615067 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 @@ -555,9 +555,6 @@ "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" } @@ -571,7 +568,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Review Labeled Examples request": { + "$ref": "./examples/SuccessfulReviewLabeledExamplesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { @@ -660,9 +662,6 @@ "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" } @@ -676,7 +675,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Intent Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionIntentInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/entities": { @@ -739,9 +743,6 @@ "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" } @@ -755,7 +756,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Entity Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionEntityInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities": { @@ -818,9 +824,6 @@ "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" } @@ -834,7 +837,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Hierarchical Entity Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/compositeentities": { @@ -897,9 +905,6 @@ "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" } @@ -913,7 +918,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Composite Entity Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/closedlists": { @@ -976,9 +986,6 @@ "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" } @@ -992,7 +999,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Closed List Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/prebuilts": { @@ -1055,9 +1067,6 @@ "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" } @@ -1071,7 +1080,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Prebuilt Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/listprebuilts": { @@ -1089,9 +1103,6 @@ "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" } @@ -1105,7 +1116,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Available Prebuilt Entity Extractors request": { + "$ref": "./examples/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/models": { @@ -1129,9 +1145,6 @@ "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" } @@ -1145,7 +1158,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Model Infos request": { + "$ref": "./examples/SuccessfulGetApplicationVersionModelInfosRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/intents/{intentId}": { diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json new file mode 100644 index 000000000000..4c050971574b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json new file mode 100644 index 000000000000..6c3e860c6eb1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionEntityInfosRequest.json new file mode 100644 index 000000000000..9dbaf207067a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json new file mode 100644 index 000000000000..6e44b31125c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionIntentInfosRequest.json new file mode 100644 index 000000000000..c10f4edfa3e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionModelInfosRequest.json new file mode 100644 index 000000000000..50258cd2514c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..b6d857227b82 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json new file mode 100644 index 000000000000..9664df8fb67b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/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/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulReviewLabeledExamplesRequest.json new file mode 100644 index 000000000000..1d7ec2b9ce9a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Luis/v2.0/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 From 594f69c0e5abea977b00741b1dee3472d2982a8f Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Mon, 20 Nov 2017 18:51:21 -0800 Subject: [PATCH 15/19] relocate and breakout examples from LUIS Programmatic Swagger File --- .../LUIS Programmatic APIs v2.0.swagger.json | 367 +++++++++--------- ...pplicationVersionPrebuiltInfosRequest.json | 22 -- .../examples/SuccessfulAddLabelRequest.json | 16 + .../SuccessfulBatchAddLabelsRequest.json | 40 ++ ...uccessfulReviewLabeledExamplesRequest.json | 0 ...licationVersionClosedListInfosRequest.json | 0 ...ionVersionCompositeEntityInfosRequest.json | 0 ...tApplicationVersionEntityInfosRequest.json | 0 ...VersionHierarchicalEntityInfosRequest.json | 0 ...tApplicationVersionIntentInfosRequest.json | 0 ...etApplicationVersionModelInfosRequest.json | 0 ...ilablePrebuiltEntityExtractorsRequest.json | 0 ...ulGetApplicationUserAccessListRequest.json | 15 + ...plicationVersionTrainingStatusRequest.json | 65 ++++ ...cessfulTrainApplicationVersionRequest.json | 16 + 15 files changed, 346 insertions(+), 195 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulAddLabelRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulBatchAddLabelsRequest.json rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => examples}/SuccessfulReviewLabeledExamplesRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetApplicationVersionClosedListInfosRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetApplicationVersionEntityInfosRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetApplicationVersionIntentInfosRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetApplicationVersionModelInfosRequest.json (100%) rename specification/cognitiveservices/data-plane/Luis/v2.0/examples/{ => model}/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json (100%) create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/train/SuccessfulTrainApplicationVersionRequest.json 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 dd2657615067..c1c2b0480188 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 @@ -72,9 +72,6 @@ "responses": { "201": { "description": "The ID of the created feature.", - "examples": { - "application/json": "83147" - }, "schema": { "$ref": "#/definitions/FeatureIDResponse" } @@ -88,7 +85,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Pattern Feature request": { + "$ref": "./examples/features/SuccessfulCreatePatternFeatureRequest.json" + } + } }, "get": { "description": "Gets all application version pattern features.", @@ -104,9 +106,6 @@ "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" } @@ -120,7 +119,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Pattern Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/phraselists": { @@ -151,9 +155,6 @@ "responses": { "201": { "description": "The ID of the created feature.", - "examples": { - "application/json": "1823" - }, "schema": { "$ref": "#/definitions/FeatureIDResponse" } @@ -167,7 +168,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Phraselist Feature request": { + "$ref": "./examples/features/SuccessfulCreatePhraselistFeatureRequest.json" + } + } }, "get": { "description": "Gets all application phraselist features.", @@ -183,9 +189,6 @@ "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" } @@ -199,7 +202,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Phraselist Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/features": { @@ -223,34 +231,6 @@ "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" } @@ -264,7 +244,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/patterns/{patternId}": { @@ -289,14 +274,6 @@ "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" } @@ -310,7 +287,12 @@ }, "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.", @@ -378,15 +360,6 @@ "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" } @@ -400,7 +373,12 @@ }, "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.", @@ -472,12 +450,6 @@ "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" } @@ -491,7 +463,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Add Label request": { + "$ref": "./examples/examples/SuccessfulAddLabelRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/examples": { @@ -523,9 +500,6 @@ "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" } @@ -539,7 +513,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Batch Add Labels request": { + "$ref": "./examples/examples/SuccessfulBatchAddLabelsRequest.json" + } + } }, "get": { "description": "Returns examples to be reviewed.", @@ -571,7 +550,7 @@ ], "x-ms-examples": { "Successful Review Labeled Examples request": { - "$ref": "./examples/SuccessfulReviewLabeledExamplesRequest.json" + "$ref": "./examples/examples/SuccessfulReviewLabeledExamplesRequest.json" } } } @@ -678,7 +657,7 @@ ], "x-ms-examples": { "Successful Get Application Version Intent Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionIntentInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json" } } } @@ -759,7 +738,7 @@ ], "x-ms-examples": { "Successful Get Application Version Entity Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionEntityInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json" } } } @@ -840,7 +819,7 @@ ], "x-ms-examples": { "Successful Get Application Version Hierarchical Entity Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" } } } @@ -921,7 +900,7 @@ ], "x-ms-examples": { "Successful Get Application Version Composite Entity Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" } } } @@ -1002,7 +981,7 @@ ], "x-ms-examples": { "Successful Get Application Version Closed List Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json" } } } @@ -1083,7 +1062,7 @@ ], "x-ms-examples": { "Successful Get Application Version Prebuilt Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" } } } @@ -1119,7 +1098,7 @@ ], "x-ms-examples": { "Successful Get Available Prebuilt Entity Extractors request": { - "$ref": "./examples/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" + "$ref": "./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" } } } @@ -1161,7 +1140,7 @@ ], "x-ms-examples": { "Successful Get Application Version Model Infos request": { - "$ref": "./examples/SuccessfulGetApplicationVersionModelInfosRequest.json" + "$ref": "./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json" } } } @@ -1184,14 +1163,6 @@ "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" } @@ -1205,7 +1176,12 @@ }, "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.", @@ -1358,24 +1334,6 @@ "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" } @@ -1389,7 +1347,12 @@ }, "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.", @@ -1921,7 +1884,7 @@ }, "get": { "description": "Lists all of the user applications.", - "operationId": "Apps_GetUserApplications", + "operationId": "Apps_GetApplicationsList", "parameters": [ { "$ref": "#/parameters/SkipInPath" @@ -1949,7 +1912,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Applications List request": { + "$ref": "./examples/apps/SuccessfulGetApplicationsListRequest.json" + } + } } }, "/apps/import": { @@ -2003,7 +1971,7 @@ "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.", + "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", "examples": { "application/json": { "endpointKeys": [], @@ -2029,7 +1997,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Personal Assistant Applications": { + "$ref": "./examples/apps/SuccessfulGetPersonalAssistantApplications.json" + } + } } }, "/apps/domains": { @@ -2039,9 +2012,6 @@ "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" } @@ -2055,7 +2025,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Domains request": { + "$ref": "./examples/apps/SuccessfulGetApplicationDomainsRequest.json" + } + } } }, "/apps/usagescenarios": { @@ -2081,7 +2056,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Usage Scenarios request": { + "$ref": "./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json" + } + } } }, "/apps/cultures": { @@ -2091,9 +2071,6 @@ "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" } @@ -2107,7 +2084,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Cultures request": { + "$ref": "./examples/apps/SuccessfulGetApplicationCulturesRequest.json" + } + } } }, "/apps/{appId}/querylogs": { @@ -2135,7 +2117,12 @@ }, "produces": [ "application/octet-stream" - ] + ], + "x-ms-examples": { + "Successful Download Application Query Logs request": { + "$ref": "./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json" + } + } } }, "/apps/{appId}": { @@ -2186,7 +2173,12 @@ }, "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.", @@ -2297,14 +2289,6 @@ "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" } @@ -2318,7 +2302,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Publish Application request": { + "$ref": "./examples/apps/SuccessfulPublishApplicationRequest.json" + } + } } }, "/apps/{appId}/versions": { @@ -2720,7 +2709,7 @@ } ], "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.", + "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": { @@ -2739,17 +2728,19 @@ "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\".", + "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 } }]" - }, "schema": { "$ref": "#/definitions/ModelTrainingInfoList" } @@ -2764,7 +2755,12 @@ "produces": [ "application/json", "JSON" - ] + ], + "x-ms-examples": { + "Successful Get Application Version Training Status request": { + "$ref": "./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json" + } + } } }, "/subscriptions": { @@ -3042,12 +3038,6 @@ "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" } @@ -3061,7 +3051,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Application Settings request": { + "$ref": "./examples/apps/SuccessfulGetApplicationSettingsRequest.json" + } + } }, "put": { "description": "Updates the application settings", @@ -3153,7 +3148,12 @@ }, "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.", @@ -3255,14 +3255,6 @@ "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" } @@ -3276,7 +3268,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Endpoints request": { + "$ref": "./examples/apps/SuccessfulGetEndpointsRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { @@ -3591,9 +3588,6 @@ "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" } @@ -3607,7 +3601,12 @@ }, "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.", @@ -3679,7 +3678,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get AvailableCustomPrebuiltDomainsForCulture request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json" + } + } } }, "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { @@ -3707,13 +3711,8 @@ "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": { @@ -3725,7 +3724,12 @@ }, "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.", @@ -4819,6 +4823,7 @@ "enum": [ "Entity Extractor", "Hierarchical Entity Extractor", + "Hierarchical Child Entity Extractor", "Composite Entity Extractor", "Closed List Entity Extractor", "Prebuilt Entity Extractor", @@ -4910,6 +4915,8 @@ } }, "ChildEntity": { + "type": "object", + "description": "The base child entity class.", "properties": { "id": { "type": "string", @@ -4921,6 +4928,20 @@ } } }, + "HierarchicalChildEntity": { + "type": "object", + "properties": { + "typeId": { + "type": "number" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "allOf": [ + { "$ref": "#/definitions/ChildEntity" } + ] + }, "IntentClassifier": { "type": "object", "x-ms-discriminator-value": "Intent Classifier", diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json deleted file mode 100644 index b6d857227b82..000000000000 --- a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "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/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/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulReviewLabeledExamplesRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionClosedListInfosRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionEntityInfosRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionIntentInfosRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetApplicationVersionModelInfosRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json diff --git a/specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json similarity index 100% rename from specification/cognitiveservices/data-plane/Luis/v2.0/examples/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json rename to specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json 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/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 From ea38a5a8a4889175ef3d2634ddf1eb492acbf911 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 21 Nov 2017 11:12:38 -0800 Subject: [PATCH 16/19] add x-ms-examples for Apps group for LUIS Programmatic Swagger File --- ...ulDownloadApplicationQueryLogsRequest.json | 12 ++++ ...ccessfulGetApplicationCulturesRequest.json | 60 ++++++++++++++++ ...uccessfulGetApplicationDomainsRequest.json | 42 ++++++++++++ .../SuccessfulGetApplicationInfoRequest.json | 32 +++++++++ ...cessfulGetApplicationQueryLogsRequest.json | 12 ++++ ...ccessfulGetApplicationSettingsRequest.json | 15 ++++ ...tApplicationUsageScenariosListRequest.json | 16 +++++ .../SuccessfulGetApplicationsListRequest.json | 35 ++++++++++ ...ustomPrebuiltDomainsForCultureRequest.json | 68 +++++++++++++++++++ ...AvailableCustomPrebuiltDomainsRequest.json | 67 ++++++++++++++++++ .../apps/SuccessfulGetEndpointsRequest.json | 17 +++++ ...ssfulGetPersonalAssistantApplications.json | 20 ++++++ .../SuccessfulPublishApplicationRequest.json | 17 +++++ 13 files changed, 413 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationQueryLogsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetEndpointsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json 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 From 834a404dce3e0ddfe63049ae48a297fc99201cf4 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 21 Nov 2017 11:14:39 -0800 Subject: [PATCH 17/19] add x-ms-examples for features and model group for LUIS Programmatic Swagger File --- ...SuccessfulCreatePatternFeatureRequest.json | 13 +++++ ...cessfulCreatePhraselistFeatureRequest.json | 13 +++++ ...lGetApplicationVersionFeaturesRequest.json | 38 +++++++++++++++ ...licationVersionPatternFeaturesRequest.json | 20 ++++++++ ...ationVersionPhraselistFeaturesRequest.json | 28 +++++++++++ ...uccessfulGetPatternFeatureInfoRequest.json | 18 +++++++ ...essfulGetPhraselistFeatureInfoRequest.json | 19 ++++++++ ...fulAddPrebuiltEntityExtractorsRequest.json | 17 +++++++ ...fulCreateClosedListEntityModelRequest.json | 41 ++++++++++++++++ ...CreateCompositeEntityExtractorRequest.json | 17 +++++++ ...uccessfulCreateEntityExtractorRequest.json | 16 +++++++ ...ateHierarchicalEntityExtractorRequest.json | 17 +++++++ ...ccessfulCreateIntentClassifierRequest.json | 16 +++++++ ...pplicationVersionPrebuiltInfosRequest.json | 22 +++++++++ ...cessfulGetClosedListEntityInfoRequest.json | 47 +++++++++++++++++++ ...ccessfulGetCompositeEntityInfoRequest.json | 29 ++++++++++++ .../model/SuccessfulGetEntityInfoRequest.json | 19 ++++++++ ...GetHierarchicalChildEntityInfoRequest.json | 20 ++++++++ ...ssfulGetHierarchicalEntityInfoRequest.json | 29 ++++++++++++ .../model/SuccessfulGetIntentInfoRequest.json | 19 ++++++++ .../SuccessfulGetPrebuiltInfoRequest.json | 19 ++++++++ 21 files changed, 477 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePatternFeatureRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPatternFeaturesRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPatternFeatureInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulAddPrebuiltEntityExtractorsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateCompositeEntityExtractorRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateEntityExtractorRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateHierarchicalEntityExtractorRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulCreateIntentClassifierRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetEntityInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetIntentInfoRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json 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/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/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 From e49896ef1202e290235ef423bfa478abd0b3a410 Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 21 Nov 2017 11:15:49 -0800 Subject: [PATCH 18/19] add references to examples for LUIS Programmatic Swagger File --- .../LUIS Programmatic APIs v2.0.swagger.json | 136 ++++++++---------- 1 file changed, 58 insertions(+), 78 deletions(-) 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 c1c2b0480188..ceccc9036cb5 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 @@ -615,9 +615,6 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8\"" - }, "schema": { "$ref": "#/definitions/GuidResponse" } @@ -625,7 +622,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Intent Classifier request": { + "$ref": "./examples/model/SuccessfulCreateIntentClassifierRequest.json" + } + } }, "get": { "description": "Gets information about the intent models.", @@ -690,9 +692,6 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"3d73462d-98f0-4dcd-8d30-fab9e65f2e73\"" - }, "schema": { "$ref": "#/definitions/GuidResponse" } @@ -706,7 +705,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Create Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateEntityExtractorRequest.json" + } + } }, "get": { "description": "Gets information about the entity models.", @@ -771,9 +775,6 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"fe559c31-9778-42ea-ba45-94e0bd7cf767\"" - }, "schema": { "$ref": "#/definitions/GuidResponse" } @@ -787,7 +788,12 @@ }, "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.", @@ -852,9 +858,6 @@ "responses": { "201": { "description": "The ID of the created Model.", - "examples": { - "application/json": "\"bc1bae43-7904-48ad-a165-88b1910174f9\"" - }, "schema": { "$ref": "#/definitions/GuidResponse" } @@ -868,7 +871,12 @@ }, "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.", @@ -949,7 +957,12 @@ }, "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.", @@ -1270,7 +1283,12 @@ }, "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.", @@ -1447,7 +1465,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples": { + "Successful Get Composite Entity Info request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityInfoRequest.json" + } + } }, "put": { "description": "Updates the composite entity extractor.", @@ -1564,7 +1587,12 @@ }, "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.", @@ -1660,14 +1688,6 @@ "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" } @@ -1681,7 +1701,12 @@ }, "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.", @@ -1896,9 +1921,6 @@ "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" } @@ -1972,18 +1994,6 @@ "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" - } - } - }, "schema": { "$ref": "#/definitions/PersonalAssistantsResponse" } @@ -2040,9 +2050,6 @@ "responses": { "200": { "description": "A list object containing the available application usage scenarios.", - "examples": { - "application/json": "[ \"IoT\", \"Bot\", \"Mobile Application\", \"Other\"]" - }, "schema": { "$ref": "#/definitions/ApplicationUsageScenarios" } @@ -2104,8 +2111,9 @@ "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": { @@ -2117,12 +2125,7 @@ }, "produces": [ "application/octet-stream" - ], - "x-ms-examples": { - "Successful Download Application Query Logs request": { - "$ref": "./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json" - } - } + ] } }, "/apps/{appId}": { @@ -2137,29 +2140,6 @@ "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" } From b1316d31808bc678322e953c18019f10f3f83d7c Mon Sep 17 00:00:00 2001 From: stevengum97 Date: Tue, 21 Nov 2017 12:18:54 -0800 Subject: [PATCH 19/19] adjust LUIS Endpoint Swagger File, add x-ms-examples and remove examples from LUIS Programmatic Swagger File --- .../Luis/v2.0/LUIS Endpoint API.swagger.json | 136 +++--------------- .../LUIS Programmatic APIs v2.0.swagger.json | 65 --------- ...tPredictionsFromEndpointViaGetRequest.json | 57 ++++++++ ...PredictionsFromEndpointViaPostRequest.json | 57 ++++++++ 4 files changed, 136 insertions(+), 179 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaGetRequest.json create mode 100644 specification/cognitiveservices/data-plane/Luis/v2.0/examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json 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 8611254f8350..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 @@ -40,17 +40,19 @@ }, "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": "Prediction_GetPredictionsFromEndpointViaGet", "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "subscription-key", "in": "query", @@ -93,54 +95,6 @@ "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" - ] - } - } - ] - } - }, "schema": { "$ref": "#/definitions/LuisResult" } @@ -148,7 +102,12 @@ }, "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.", @@ -159,13 +118,6 @@ } ], "parameters": [ - { - "name": "appId", - "in": "path", - "description": "Format - guid. The application ID.", - "required": true, - "type": "string" - }, { "name": "timezoneOffset", "in": "query", @@ -205,54 +157,6 @@ "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" - ] - } - } - ] - } - }, "schema": { "$ref": "#/definitions/LuisResult" } @@ -260,7 +164,12 @@ }, "produces": [ "application/json" - ] + ], + "x-ms-examples":{ + "Successful Get Predictions From Endpoint Via Post request": { + "$ref": "./examples/prediction/SuccessfulGetPredictionsFromEndpointViaPostRequest.json" + } + } } } }, @@ -268,8 +177,7 @@ "Q": { "type": "string", "example": "\"forward to frank 30 dollars through HSBC\"" - } - , + }, "LuisResult": { "type": "object", "properties": { 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 ceccc9036cb5..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 @@ -941,9 +941,6 @@ "responses": { "201": { "description": "The ID of the created model.", - "examples": { - "application/json": "\"8713b104-78ec-4c4f-9f96-f2e53562cc16\"" - }, "schema": { "$ref": "#/definitions/GuidResponse" } @@ -1262,14 +1259,6 @@ "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" } @@ -1434,24 +1423,6 @@ "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" } @@ -1538,42 +1509,6 @@ "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" } 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