diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md index a32d57aebb46..d4f38177e3bd 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.go.md @@ -10,27 +10,30 @@ go: ``` ### Go multi-api - ``` yaml $(go) && $(multiapi) batch: - tag: authoring_2_0 - tag: authoring_3_0_preview + - tag: authoring_3_0 ``` ### Tag: authoring_2_0 and go - These settings apply only when `--tag=authoring_2_0 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. - ``` yaml $(tag) == 'authoring_2_0' && $(go) output-folder: $(go-sdk-folder)/services/cognitiveservices/v2.0/luis/$(namespace) ``` ### Tag: authoring_3_0_preview and go - These settings apply only when `--tag=authoring_3_0_preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. - ``` yaml $(tag) == 'authoring_3_0_preview' && $(go) output-folder: $(go-sdk-folder)/services/preview/cognitiveservices/v3.0/luis/$(namespace) +``` + +### Tag: authoring_3_0 and go +These settings apply only when `--tag=authoring_3_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. +``` yaml $(tag) == 'authoring_3_0' && $(go) +output-folder: $(go-sdk-folder)/services/stable/cognitiveservices/v3.0/luis/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md index bd3c1cdb639d..ed47ca3acf39 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md @@ -5,12 +5,12 @@ Configuration for generating LUIS Authoring SDK. ``` yaml -tag: authoring_3_0_preview +tag: authoring_3_0 add-credentials: true openapi-type: data-plane ``` -The current release for the Authoring Endpoint is `authoring_3_0_preview`. +The current release for the Authoring Endpoint is `authoring_3_0`. # Releases @@ -47,10 +47,9 @@ directive: - suppress: DefinitionsPropertiesNamesCamelCase reason: Changing casing will break existing clients/consumers ``` - --- -## Authoring 3.0 +## Authoring 3.0-preview These settings apply only when `--tag=authoring_3_0_preview` is specified on the command line. ``` yaml $(tag) == 'authoring_3_0_preview' @@ -75,6 +74,25 @@ directive: AutoRest-Linter Suppressions +``` yaml +# Ignore autorest-linter issues that cannot be resolve without updates to the API implementation +directive: + - suppress: DeleteMustNotHaveRequestBody + reason: Body is used to specify entity to delete + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Changing casing will break existing clients/consumers +``` +--- + +## Authoring 3.0 +These settings apply only when `--tag=authoring_3_0` is specified on the command line. + +``` yaml $(tag) == 'authoring_3_0' +input-file: stable/v3.0/LUIS-Authoring.json +``` + +AutoRest-Linter Suppressions + ``` yaml # Ignore autorest-linter issues that cannot be resolve without updates to the API implementation directive: @@ -88,7 +106,6 @@ directive: # Code Generation - ## Swagger to SDK This section describes what SDK should be generated by the automatic system. @@ -96,7 +113,6 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-node @@ -157,5 +173,4 @@ uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/LUIS-Authoring.json new file mode 100644 index 000000000000..f6d0d09d1549 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/LUIS-Authoring.json @@ -0,0 +1,10800 @@ +{ + "swagger": "2.0", + "info": { + "title": "LUIS Authoring Client", + "version": "3.0" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/luis/authoring/v3.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/apps/{appId}/versions/{versionId}/phraselists": { + "post": { + "description": "Creates a new phraselist feature in a version of the application.", + "operationId": "Features_AddPhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PhraselistCreateObject" + }, + "description": "A Phraselist object containing Name, comma-separated Phrases and the isExchangeable boolean. Default value for isExchangeable is true." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created feature.", + "schema": { + "$ref": "#/definitions/FeatureIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Phraselist Feature request": { + "$ref": "./examples/features/SuccessfulCreatePhraselistFeatureRequest.json" + } + } + }, + "get": { + "description": "Gets all the phraselist features in a version of the application.", + "operationId": "Features_ListPhraseLists", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all phraselist features.", + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Phraselist Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/features": { + "get": { + "description": "Gets all the extraction phraselist and pattern features in a version of the application.", + "operationId": "Features_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all phraselist features and a list of all pattern features.", + "schema": { + "$ref": "#/definitions/FeaturesResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Features request": { + "$ref": "./examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/phraselists/{phraselistId}": { + "get": { + "description": "Gets phraselist feature info in a version of the application.", + "operationId": "Features_GetPhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be retrieved.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "A phraselist feature info.", + "schema": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the phrases, the state and the name of the phraselist feature in a version of the application.", + "operationId": "Features_UpdatePhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be updated.", + "required": true, + "type": "integer" + }, + { + "name": "phraselistUpdateObject", + "in": "body", + "schema": { + "$ref": "#/definitions/PhraselistUpdateObject" + }, + "description": "The new values for: - Just a boolean called IsActive, in which case the status of the feature will be changed. - Name, Pattern, Mode, and a boolean called IsActive to update the feature." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated phraselist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes a phraselist feature from a version of the application.", + "operationId": "Features_DeletePhraseList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "phraselistId", + "in": "path", + "description": "The ID of the feature to be deleted.", + "required": true, + "type": "integer" + } + ], + "responses": { + "200": { + "description": "Successfully deleted phraselist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Phraselist Feature Info request": { + "$ref": "./examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/example": { + "post": { + "description": "Adds a labeled example utterance in a version of the application.", + "operationId": "Examples_Add", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" + }, + { + "name": "exampleLabelObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExampleLabelObject" + }, + "description": "A labeled example utterance with the expected intent and entities." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created example utterance.", + "schema": { + "$ref": "#/definitions/LabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Label request": { + "$ref": "./examples/examples/SuccessfulAddLabelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/examples": { + "post": { + "description": "Adds a batch of labeled example utterances to a version of the application.", + "operationId": "Examples_Batch", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" + }, + { + "name": "exampleLabelObjectArray", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExampleLabelObjectArray" + }, + "description": "Array of example utterances." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "A string array determining which labeled example utterances were added successfully.", + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "207": { + "description": "Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labeled example utterances.", + "schema": { + "$ref": "#/definitions/BatchLabelExampleResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Batch Add Labels request": { + "$ref": "./examples/examples/SuccessfulBatchAddLabelsRequest.json" + } + } + }, + "get": { + "description": "Returns example utterances to be reviewed from a version of the application.", + "operationId": "Examples_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" + } + ], + "responses": { + "200": { + "description": "A list of predictions and label pairs for every example utterance in the application.", + "schema": { + "$ref": "#/definitions/LabeledUtterances" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Review Labeled Examples request": { + "$ref": "./examples/examples/SuccessfulReviewLabeledExamplesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/examples/{exampleId}": { + "delete": { + "description": "Deletes the labeled example utterances with the specified ID from a version of the application.", + "operationId": "Examples_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "exampleId", + "in": "path", + "description": "The example ID.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "Successfully deleted example utterance.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Example Label request": { + "$ref": "./examples/examples/SuccessfulDeleteExampleLabelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents": { + "post": { + "description": "Adds an intent to a version of the application.", + "operationId": "Model_AddIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "intentCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelCreateObject" + }, + "description": "A model object containing the name of the new intent." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created intent model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Intent Classifier request": { + "$ref": "./examples/model/SuccessfulCreateIntentClassifierRequest.json" + } + } + }, + "get": { + "description": "Gets information about the intent models in a version of the application.", + "operationId": "Model_ListIntents", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of intent model infos.", + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Intent Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities": { + "post": { + "description": "Adds an entity extractor to a version of the application.", + "operationId": "Model_AddEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityModelCreateObject" + }, + "description": "A model object containing the name of the new entity extractor and its children." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Entity Extractor request": { + "$ref": "./examples/model/SuccessfulCreateEntityExtractorRequest.json" + } + } + }, + "get": { + "description": "Gets information about all the simple entity models in a version of the application.", + "operationId": "Model_ListEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of entity model infos.", + "schema": { + "$ref": "#/definitions/NDepthEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities": { + "get": { + "description": "Gets information about all the hierarchical entity models in a version of the application.", + "operationId": "Model_ListHierarchicalEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of hierarchical entity model infos.", + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Hierarchical Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities": { + "get": { + "description": "Gets information about all the composite entity models in a version of the application.", + "operationId": "Model_ListCompositeEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of composite entity model infos.", + "schema": { + "$ref": "#/definitions/CompositeEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Composite Entity Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists": { + "get": { + "description": "Gets information about all the list entity models in a version of the application.", + "operationId": "Model_ListClosedLists", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of list entity model infos.", + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Closed List Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json" + } + } + }, + "post": { + "description": "Adds a list entity model to a version of the application.", + "operationId": "Model_AddClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "closedListModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelCreateObject" + }, + "description": "A model containing the name and words for the new list entity extractor." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Closed List Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts": { + "post": { + "description": "Adds a list of prebuilt entities to a version of the application.", + "operationId": "Model_AddPrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltExtractorNames", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltExtractorNames" + }, + "description": "An array of prebuilt entity extractor names." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An array of the created prebuilt extractor infos.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json" + } + } + }, + "get": { + "description": "Gets information about all the prebuilt entities in a version of the application.", + "operationId": "Model_ListPrebuilts", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of prebuilt entity models infos.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Prebuilt Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/listprebuilts": { + "get": { + "description": "Gets all the available prebuilt entities in a version of the application.", + "operationId": "Model_ListPrebuiltEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the possible prebuilt entity extractors.", + "schema": { + "$ref": "#/definitions/AvailablePrebuiltEntityModels" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Available Prebuilt Entity Extractors request": { + "$ref": "./examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/models": { + "get": { + "description": "Gets information about all the intent and entity models in a version of the application.", + "operationId": "Model_ListModels", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of application model infos.", + "schema": { + "$ref": "#/definitions/ModelsInfoResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version Model Infos request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/models/{modelId}/examples": { + "get": { + "description": "Gets the example utterances for the given intent or entity model in a version of the application.", + "operationId": "Model_Examples", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "modelId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID (GUID) of the model.", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of example utterances for the model.", + "schema": { + "$ref": "#/definitions/ExamplesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Examples Per Model Request": { + "$ref": "./examples/model/SuccessfulGetExamplesPerModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}": { + "get": { + "description": "Gets information about the intent model in a version of the application.", + "operationId": "Model_GetIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + } + ], + "responses": { + "200": { + "description": "An intent model info.", + "schema": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Intent Info request": { + "$ref": "./examples/model/SuccessfulGetIntentInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name of an intent in a version of the application.", + "operationId": "Model_UpdateIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "modelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdateObject" + }, + "description": "A model object containing the new intent name." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Intent Model request": { + "$ref": "./examples/model/SuccessfulRenameIntentModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes an intent from a version of the application.", + "operationId": "Model_DeleteIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "deleteUtterances", + "in": "query", + "type": "boolean", + "description": "If true, deletes the intent's example utterances. If false, moves the example utterances to the None intent. The default value is false.", + "default": false + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Intent Model request": { + "$ref": "./examples/model/SuccessfulDeleteIntentModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}": { + "get": { + "description": "Gets information about an entity model in a version of the application.", + "operationId": "Model_GetEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity model info.", + "schema": { + "$ref": "#/definitions/NDepthEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Entity Info request": { + "$ref": "./examples/model/SuccessfulGetEntityInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes an entity or a child from a version of the application.", + "operationId": "Model_DeleteEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor or the child entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteEntityExtractorRequest.json" + } + } + }, + "patch": { + "description": "Updates the name of an entity extractor or the name and instanceOf model of a child entity extractor.", + "operationId": "Model_UpdateEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor or the child entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityModelUpdateObject" + }, + "description": "A model object containing the name new entity extractor or the name and instance of model of a child entity extractor " + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Entity Extractor request": { + "$ref": "./examples/model/SuccessfulUpdateEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/features": { + "post": { + "description": "Adds a new feature relation to be used by the intent in a version of the application.", + "operationId": "Features_AddIntentFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "featureRelationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A Feature relation information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Feature Relation request": { + "$ref": "./examples/model/SuccessfulAddIntentFeatureRelationRequest.json" + } + } + }, + "get": { + "description": "Gets the information of the features used by the intent in a version of the application.", + "operationId": "Model_GetIntentFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of feature information objects for the intent.", + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Features information request": { + "$ref": "./examples/model/SuccessfulGetIntentFeaturesInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the information of the features used by the intent in a version of the application.", + "operationId": "Model_ReplaceIntentFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "featureRelationsUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + }, + "description": "A list of feature information objects containing the new feature relations." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Replace Features request": { + "$ref": "./examples/model/SuccessfulReplaceIntentFeaturesRequest.json" + } + } + }, + "delete": { + "description": "Deletes a relation from the feature relations used by the intent in a version of the application.", + "operationId": "Model_DeleteIntentFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "name": "featureRelationDeleteObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A feature information object containing the feature relation to delete." + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete feature relation request": { + "$ref": "./examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/features": { + "post": { + "description": "Adds a new feature relation to be used by the entity in a version of the application.", + "operationId": "Features_AddEntityFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + }, + { + "name": "featureRelationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A Feature relation information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Feature Relation request": { + "$ref": "./examples/model/SuccessfulAddEntityFeatureRelationRequest.json" + } + } + }, + "get": { + "description": "Gets the information of the features used by the entity in a version of the application.", + "operationId": "Model_GetEntityFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of feature information objects for the entity.", + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Features information request": { + "$ref": "./examples/model/SuccessfulGetEntityFeaturesInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the information of the features used by the entity in a version of the application.", + "operationId": "Model_ReplaceEntityFeatures", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + }, + { + "name": "featureRelationsUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FeaturesPerModelResponseObject" + }, + "description": "A list of feature information objects containing the new feature relations." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Replace Features request": { + "$ref": "./examples/model/SuccessfulReplaceEntityFeaturesRequest.json" + } + } + }, + "delete": { + "description": "Deletes a relation from the feature relations used by the entity in a version of the application.", + "operationId": "Model_DeleteEntityFeature", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/EntityIdInPath" + }, + { + "name": "featureRelationDeleteObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelFeatureInformation" + }, + "description": "A feature information object containing the feature relation to delete." + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete feature relation request": { + "$ref": "./examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}": { + "get": { + "description": "Gets information about a hierarchical entity in a version of the application.", + "operationId": "Model_GetHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A hierarchical entity model info.", + "schema": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json" + } + } + }, + "patch": { + "description": "Updates the name of a hierarchical entity model in a version of the application.", + "operationId": "Model_UpdateHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "modelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ModelUpdateObject" + }, + "description": "Model containing names of the hierarchical entity." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Info request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a hierarchical entity from a version of the application.", + "operationId": "Model_DeleteHierarchicalEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Hierarchical Entity Model request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}": { + "get": { + "description": "Gets information about a composite entity in a version of the application.", + "operationId": "Model_GetCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "The composite entity model info.", + "schema": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Composite Entity Info request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates a composite entity in a version of the application.", + "operationId": "Model_UpdateCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "compositeModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CompositeEntityModel" + }, + "description": "A model object containing the new entity extractor name and children." + } + ], + "consumes": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Composite Entity Extractor request": { + "$ref": "./examples/model/SuccessfulUpdateCompositeEntityModelRequest.json" + } + }, + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated composite entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Deletes a composite entity from a version of the application.", + "operationId": "Model_DeleteCompositeEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted composite entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}": { + "get": { + "description": "Gets information about a list entity in a version of the application.", + "operationId": "Model_GetClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The list model info.", + "schema": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the list entity in a version of the application.", + "operationId": "Model_UpdateClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "closedListModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelUpdateObject" + }, + "description": "The new list entity name and words list." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated list entity name and words list.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulUpdateClosedListEntityModelRequest.json" + } + } + }, + "patch": { + "description": "Adds a batch of sublists to an existing list entity in a version of the application.", + "operationId": "Model_PatchClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "closedListModelPatchObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClosedListModelPatchObject" + }, + "description": "A words list batch." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully added sublists to the list entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add SubLists to Closed List Entity request": { + "$ref": "./examples/model/SuccessfulPatchClosedListEntityModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a list entity model from a version of the application.", + "operationId": "Model_DeleteClosedList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully delete list entity from a version of application.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Closed List Entity Info request": { + "$ref": "./examples/model/SuccessfulDeleteClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{prebuiltId}": { + "get": { + "description": "Gets information about a prebuilt entity model in a version of the application.", + "operationId": "Model_GetPrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "The prebuilt entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A prebuilt entity models info.", + "schema": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltInfoRequest.json" + } + } + }, + "delete": { + "description": "Deletes a prebuilt entity extractor from a version of the application.", + "operationId": "Model_DeletePrebuilt", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltId", + "in": "path", + "description": "The prebuilt entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Prebuilt Info request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists/{subListId}": { + "delete": { + "description": "Deletes a sublist of a specific list entity model from a version of the application.", + "operationId": "Model_DeleteSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "Successfully deleted sublist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Sublist request": { + "$ref": "./examples/model/SuccessfulDeleteSublistRequest.json" + } + } + }, + "put": { + "description": "Updates one of the list entity's sublists in a version of the application.", + "operationId": "Model_UpdateSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "subListId", + "in": "path", + "description": "The sublist ID.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "wordListBaseUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordListBaseUpdateObject" + }, + "description": "A sublist update object containing the new canonical form and the list of words." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated sublist.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Sublist request": { + "$ref": "./examples/model/SuccessfulUpdateSublistRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/suggest": { + "get": { + "description": "Suggests example utterances that would improve the accuracy of the intent model in a version of the application.", + "operationId": "Model_ListIntentSuggestions", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" + } + ], + "responses": { + "200": { + "description": "If there's no trained intent model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the intent model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.", + "schema": { + "$ref": "#/definitions/IntentsSuggestionExamples" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Intents Suggestion Examples": { + "$ref": "./examples/model/SuccessfulGetIntentsSuggestionExamples.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/suggest": { + "get": { + "description": "Get suggested example utterances that would improve the accuracy of the entity model in a version of the application.", + "operationId": "Model_ListEntitySuggestions", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The target entity extractor model to enhance.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "$ref": "#/parameters/TakeInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" + } + ], + "responses": { + "200": { + "description": "If there's no trained entity model, nothing is returned in the response. If there's a trained model and active learning finds any relevant queries, they are returned with the entity model predictions. If there's a trained model but active learning didn't find any relevant queries, an empty list is returned in the response.", + "schema": { + "$ref": "#/definitions/EntitiesSuggestionExamples" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Entity Suggestion Examples": { + "$ref": "./examples/model/SuccessfulGetEntitySuggestionExamples.json" + } + } + } + }, + "/apps/": { + "post": { + "description": "Creates a new LUIS app.", + "operationId": "Apps_Add", + "parameters": [ + { + "name": "applicationCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationCreateObject" + }, + "description": "An application containing Name, Description (optional), Culture, Usage Scenario (optional), Domain (optional) and initial version ID (optional) of the application. Default value for the version ID is \"0.1\". Note: the culture cannot be changed after the app is created." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Application Creation": { + "$ref": "./examples/apps/SuccessfulAddApplicationRequest.json" + } + } + }, + "get": { + "description": "Lists all of the user's applications.", + "operationId": "Apps_List", + "parameters": [ + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of the user applications.", + "schema": { + "$ref": "#/definitions/ApplicationsInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Applications List request": { + "$ref": "./examples/apps/SuccessfulGetApplicationsListRequest.json" + } + } + } + }, + "/apps/import": { + "post": { + "description": "Imports an application to LUIS, the application's structure is included in the request body.", + "operationId": "Apps_Import", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.", + "type": "string" + }, + { + "name": "luisApp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the imported application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/apps/SuccessfulImportApplicationRequest.json" + } + } + } + }, + "/apps/assistants": { + "get": { + "description": "Gets the endpoint URLs for the prebuilt Cortana applications.", + "operationId": "Apps_ListCortanaEndpoints", + "responses": { + "200": { + "description": "A personal assistant apps JSON object containing the endpoint URLs for Cortana applications and the user's endpoint keys.", + "schema": { + "$ref": "#/definitions/PersonalAssistantsResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Personal Assistant Applications": { + "$ref": "./examples/apps/SuccessfulGetPersonalAssistantApplications.json" + } + } + } + }, + "/apps/domains": { + "get": { + "description": "Gets the available application domains.", + "operationId": "Apps_ListDomains", + "responses": { + "200": { + "description": "A list object containing the available application domains.", + "schema": { + "$ref": "#/definitions/AvailableDomains" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Domains request": { + "$ref": "./examples/apps/SuccessfulGetApplicationDomainsRequest.json" + } + } + } + }, + "/apps/usagescenarios": { + "get": { + "description": "Gets the application available usage scenarios.", + "operationId": "Apps_ListUsageScenarios", + "responses": { + "200": { + "description": "A list object containing the available application usage scenarios.", + "schema": { + "$ref": "#/definitions/ApplicationUsageScenarios" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Usage Scenarios request": { + "$ref": "./examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json" + } + } + } + }, + "/apps/cultures": { + "get": { + "description": "Gets a list of supported cultures. Cultures are equivalent to the written language and locale. For example,\"en-us\" represents the U.S. variation of English.", + "operationId": "Apps_ListSupportedCultures", + "responses": { + "200": { + "description": "A list object containing the supported application cultures.", + "schema": { + "$ref": "#/definitions/AvailableCultures" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Cultures request": { + "$ref": "./examples/apps/SuccessfulGetApplicationCulturesRequest.json" + } + } + } + }, + "/apps/{appId}/querylogs": { + "get": { + "description": "Gets the logs of the past month's endpoint queries for the application.", + "operationId": "Apps_DownloadQueryLogs", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "A CSV file containing the query logs for the past month.", + "schema": { + "type": "object", + "format": "file", + "description": "The query logs of an application for the past month in CSV format." + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream" + ], + "x-ms-examples": { + "Successful Download Application Query logs request": { + "$ref": "./examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json" + } + } + } + }, + "/apps/{appId}": { + "get": { + "description": "Gets the application info.", + "operationId": "Apps_Get", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application info.", + "schema": { + "$ref": "#/definitions/ApplicationInfoResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Info request": { + "$ref": "./examples/apps/SuccessfulGetApplicationInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name or description of the application.", + "operationId": "Apps_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateObject" + }, + "description": "A model containing Name and Description of the application." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application name and description.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application request": { + "$ref": "./examples/apps/SuccessfulRenameApplicationRequest.json" + } + } + }, + "delete": { + "description": "Deletes an application.", + "operationId": "Apps_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/ForcePath" + } + ], + "responses": { + "200": { + "description": "Successfully deleted application.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application request": { + "$ref": "./examples/apps/SuccessfulDeleteApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/clone": { + "post": { + "description": "Creates a new version from the selected version.", + "operationId": "Versions_Clone", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "versionCloneObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateObject" + }, + "description": "A model containing the new version ID." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The new version ID.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Clone Application Version request": { + "$ref": "./examples/versions/SuccessfulCloneApplicatioVersionRequest.json" + } + } + } + }, + "/apps/{appId}/publish": { + "post": { + "description": "Publishes a specific version of the application.", + "operationId": "Apps_Publish", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationPublishObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationPublishObject" + }, + "description": "The application publish object. The region is the target region that the application is published to." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status.", + "schema": { + "$ref": "#/definitions/ProductionOrStagingEndpointInfo" + } + }, + "207": { + "description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status in case that publishing one or more regions failed.", + "schema": { + "$ref": "#/definitions/ProductionOrStagingEndpointInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Publish Application request": { + "$ref": "./examples/apps/SuccessfulPublishApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions": { + "get": { + "description": "Gets a list of versions for this application ID.", + "operationId": "Versions_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of all versions of the application.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VersionInfo" + } + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Versions info request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/": { + "get": { + "description": "Gets the version information such as date created, last modified date, endpoint URL, count of intents and entities, training and publishing status.", + "operationId": "Versions_Get", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A model containing the version info.", + "schema": { + "$ref": "#/definitions/VersionInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version info request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionInfoRequest.json" + } + } + }, + "put": { + "description": "Updates the name or description of the application version.", + "operationId": "Versions_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "versionUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateObject" + }, + "description": "A model containing Name and Description of the application." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Rename Application Version request": { + "$ref": "./examples/versions/SuccessfulRenameApplicationVersionRequest.json" + } + } + }, + "delete": { + "description": "Deletes an application version.", + "operationId": "Versions_Delete", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Application Version request": { + "$ref": "./examples/versions/SuccessfulDeleteApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/export": { + "get": { + "description": "Exports a LUIS application to JSON format.", + "operationId": "Versions_Export", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "The LUIS application structure in JSON format." + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Export Application Version": { + "$ref": "./examples/versions/SuccessfulExportApplicationVersionRequest.json" + } + } + } + }, + "/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_TrainVersion", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "in": "query", + "name": "mode", + "description": "An enum value specifying mode of training.", + "type": "string" + } + ], + "responses": { + "202": { + "description": "This response indicates the initial training status.", + "schema": { + "$ref": "#/definitions/EnqueueTrainingResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Train Application Version request": { + "$ref": "./examples/train/SuccessfulTrainApplicationVersionRequest.json" + } + } + }, + "get": { + "description": "Gets the training status of all models (intents and entities) for the specified LUIS app. You must call the train API to train the LUIS app before you call this API to get training status. \"appID\" specifies the LUIS app ID. \"versionId\" specifies the version number of the LUIS app. For example, \"0.1\".", + "operationId": "Train_GetStatus", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "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/v3.0/apps/{appId}/versions/{versionId}/models The details property for each model can contain the following fields: \"statusId\": An integer from 0 to 3 that corresponds to the value of the status field. \"status\": A string with one of the following values: \"Success\", \"UpToDate\", \"InProgress\", \"Fail\". If the status is \"Fail\", the \"failureReason\" property provides the reason for failure. \"exampleCount\": The number of examples used for training. In the case of the None intent or prebuilt domain intents and entities, this number includes example provided internally by the system as well as examples you added to your LUIS app. \"failureReason\": A string that indicates the reason training failed. The value \"FewLabels\" means that no labeled example utterances were provided for training. \"trainingDateTime\": A string indicating the time the model was last trained. The value uses the ISO 8601 format for representing times in UTC (Coordinated Universal Time) with a UTC designator (\"Z\"), for example: \"2017-08-10T01:08:34Z\".", + "schema": { + "$ref": "#/definitions/ModelTrainingInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json", + "JSON" + ], + "x-ms-examples": { + "Successful Get Application Version Training Status request": { + "$ref": "./examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json" + } + } + } + }, + "/apps/{appId}/versions/import": { + "post": { + "description": "Imports a new version into a LUIS application.", + "operationId": "Versions_Import", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "versionId", + "in": "query", + "description": "The new versionId to import. If not specified, the versionId will be read from the imported object.", + "type": "string" + }, + { + "name": "luisApp", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisApp" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The created application version.", + "schema": { + "$ref": "#/definitions/VersionResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/versions/SuccessfulImportApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/settings": { + "get": { + "description": "Get the application settings including 'UseAllTrainingData'.", + "operationId": "Apps_GetSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application settings.", + "schema": { + "$ref": "#/definitions/ApplicationSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Settings request": { + "$ref": "./examples/apps/SuccessfulGetApplicationSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the application settings including 'UseAllTrainingData'.", + "operationId": "Apps_UpdateSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "applicationSettingUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSettingUpdateObject" + }, + "description": "An object containing the new application settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application settings.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Application Settings request": { + "$ref": "./examples/apps/SuccessfulUpdateApplicationSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/publishsettings": { + "get": { + "description": "Get the application publish settings including 'UseAllTrainingData'.", + "operationId": "Apps_GetPublishSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "The application publish settings.", + "schema": { + "$ref": "#/definitions/PublishSettings" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Publish Settings request": { + "$ref": "./examples/apps/SuccessfulGetPublishSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the application publish settings including 'UseAllTrainingData'.", + "operationId": "Apps_UpdatePublishSettings", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "publishSettingUpdateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublishSettingUpdateObject" + }, + "description": "An object containing the new publish application settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated application settings.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Publish Settings request": { + "$ref": "./examples/apps/SuccessfulUpdatePublishSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/suggest": { + "delete": { + "description": "Deleted an unlabelled utterance in a version of the application.", + "operationId": "Versions_DeleteUnlabelledUtterance", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "utterance", + "in": "body", + "required": true, + "schema": { + "type": "string" + }, + "description": "The utterance text to delete." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Unlabelled Utterance": { + "$ref": "./examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json" + } + } + } + }, + "/apps/{appId}/endpoints": { + "get": { + "description": "Returns the available endpoint deployment regions and URLs.", + "operationId": "Apps_ListEndpoints", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of endpoints regions and their corresponding endpoint URL.", + "schema": { + "$ref": "#/definitions/AvailableEndpoints" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Endpoints request": { + "$ref": "./examples/apps/SuccessfulGetEndpointsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists": { + "post": { + "description": "Adds a sublist to an existing list entity in a version of the application.", + "operationId": "Model_AddSubList", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "clEntityId", + "in": "path", + "description": "The list entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "wordListCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordListObject" + }, + "description": "Words list." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the newly created sublist.", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Sublist request": { + "$ref": "./examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltdomains": { + "post": { + "description": "Adds a customizable prebuilt domain along with all of its intent and entity models in a version of the application.", + "operationId": "Model_AddCustomPrebuiltDomain", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainCreateBaseObject" + }, + "description": "A prebuilt domain create object containing the name of the domain." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "An array of the created customizable prebuilt domain intent and entity model Ids.", + "schema": { + "$ref": "#/definitions/GuidList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Domain to Application request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltintents": { + "post": { + "description": "Adds a customizable prebuilt intent model to a version of the application.", + "operationId": "Model_AddCustomPrebuiltIntent", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainModelCreateObject" + }, + "description": "A model object containing the name of the customizable prebuilt intent and the name of the domain to which this model belongs." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created intent model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Intent request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuildIntentRequest.json" + } + } + }, + "get": { + "description": "Gets information about customizable prebuilt intents added to a version of the application.", + "operationId": "Model_ListCustomPrebuiltIntents", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all customizable prebuilt intents and their representations in a version of the application.", + "schema": { + "$ref": "#/definitions/IntentClassifiersList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Intent request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuildIntentRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities": { + "post": { + "description": "Adds a prebuilt entity model to a version of the application.", + "operationId": "Model_AddCustomPrebuiltEntity", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "prebuiltDomainModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrebuiltDomainModelCreateObject" + }, + "description": "A model object containing the name of the prebuilt entity and the name of the domain to which this model belongs." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created prebuilt model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Entity request": { + "$ref": "./examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json" + } + } + }, + "get": { + "description": "Gets all prebuilt entities used in a version of the application.", + "operationId": "Model_ListCustomPrebuiltEntities", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all prebuilt entities and their representations.", + "schema": { + "$ref": "#/definitions/EntityExtractorsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Entities request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltmodels": { + "get": { + "description": "Gets all prebuilt intent and entity model information used in a version of this application.", + "operationId": "Model_ListCustomPrebuiltModels", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "Returns a list of all prebuilt models and their representations.", + "schema": { + "$ref": "#/definitions/CustomPrebuiltModelList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Models request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltdomains/{domainName}": { + "delete": { + "description": "Deletes a prebuilt domain's models in a version of the application.", + "operationId": "Model_DeleteCustomPrebuiltDomain", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "domainName", + "in": "path", + "description": "Domain name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Prebuilt Domain from Application request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json" + } + } + } + }, + "/apps/customprebuiltdomains": { + "get": { + "description": "Gets all the available custom prebuilt domains for all cultures.", + "operationId": "Apps_ListAvailableCustomPrebuiltDomains", + "responses": { + "200": { + "description": "Returns a list of all custom prebuilt domains and their intents/entities representation.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Available Custom Prebuilt Domains request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json" + } + } + }, + "post": { + "description": "Adds a prebuilt domain along with its intent and entity models as a new application.", + "operationId": "Apps_AddCustomPrebuiltDomain", + "parameters": [ + { + "name": "prebuiltDomainCreateObject", + "in": "body", + "required": true, + "description": "A prebuilt domain create object containing the name and culture of the domain.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainCreateObject" + } + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Add Custom Prebuilt Application request": { + "$ref": "./examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json" + } + } + } + }, + "/apps/customprebuiltdomains/{culture}": { + "get": { + "description": "Gets all the available prebuilt domains for a specific culture.", + "operationId": "Apps_ListAvailableCustomPrebuiltDomainsForCulture", + "parameters": [ + { + "name": "culture", + "in": "path", + "description": "Culture.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returns a list of all domains and their intents and entities for a specific culture.", + "schema": { + "$ref": "#/definitions/PrebuiltDomainsList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get AvailableCustomPrebuiltDomainsForCulture request": { + "$ref": "./examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/children": { + "post": { + "description": "Creates a single child in an existing entity model hierarchy in a version of the application.", + "operationId": "Model_AddEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "childEntityModelCreateObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ChildEntityModelCreateObject" + }, + "description": "A model object containing the name of the new child model and its children." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Entity Child Model request": { + "$ref": "./examples/model/SuccessfulCreateEntityChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/children/{hChildId}": { + "get": { + "description": "Gets information about the child's model contained in an hierarchical entity child model in a version of the application.", + "operationId": "Model_GetHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "The hierarchical entity child model info.", + "schema": { + "$ref": "#/definitions/HierarchicalChildEntity" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Hierarchical Entity Child Info request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json" + } + } + }, + "patch": { + "description": "Renames a single child in an existing hierarchical entity model in a version of the application.", + "operationId": "Model_UpdateHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "required": true, + "description": "The hierarchical entity extractor child ID.", + "type": "string", + "format": "uuid" + }, + { + "name": "hierarchicalChildModelUpdateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "Model object containing new name of the hierarchical entity child." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successfully updated entity child.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json" + } + } + }, + "delete": { + "description": "Deletes a hierarchical entity extractor child in a version of the application.", + "operationId": "Model_DeleteHierarchicalEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "hChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Hierarchical Entity Child Model request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children": { + "post": { + "description": "Creates a single child in an existing composite entity model in a version of the application.", + "operationId": "Model_AddCompositeEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "compositeChildModelCreateObject", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + }, + "description": "A model object containing the name of the new composite child model." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Create Composite Entity Child Model request": { + "$ref": "./examples/model/SuccessfulCreateCompositeChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/children/{cChildId}": { + "delete": { + "description": "Deletes a composite entity extractor child from a version of the application.", + "operationId": "Model_DeleteCompositeEntityChild", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "cChildId", + "in": "path", + "description": "The hierarchical entity extractor child ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully deleted entity.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Delete Composite Entity Child Model request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeChildModelRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities": { + "get": { + "summary": "Gets information about the regular expression entity models in a version of the application.", + "operationId": "Model_ListRegexEntityInfos", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of regular expression entity model infos.", + "schema": { + "$ref": "#/definitions/RegexEntityExtractorList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Models request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json" + } + } + }, + "post": { + "summary": "Adds a regular expression entity model to a version of the application.", + "operationId": "Model_CreateRegexEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityExtractorCreateObj", + "in": "body", + "description": "A model object containing the name and regex pattern for the new regular expression entity extractor.", + "required": true, + "schema": { + "$ref": "#/definitions/RegexModelCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulCreateRegexEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities": { + "get": { + "summary": "Get information about the Pattern.Any entity models in a version of the application.", + "operationId": "Model_ListPatternAnyEntityInfos", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "A list of Pattern.Any entity model infos.", + "schema": { + "$ref": "#/definitions/PatternAnyEntityExtractorList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json" + } + } + }, + "post": { + "summary": "Adds a pattern.any entity extractor to a version of the application.", + "operationId": "Model_CreatePatternAnyEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "extractorCreateObject", + "in": "body", + "description": "A model object containing the name and explicit list for the new Pattern.Any entity extractor.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternAnyModelCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created Pattern.Any entity model.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Model request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles": { + "get": { + "summary": "Get all roles for an entity in a version of the application", + "operationId": "Model_ListEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create an entity role in a version of the application.", + "operationId": "Model_CreateEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles": { + "get": { + "summary": "Get a prebuilt entity's roles in a version of the application.", + "operationId": "Model_ListPrebuiltEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Prebuilt Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a prebuilt entity in a version of the application.", + "operationId": "Model_CreatePrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles": { + "get": { + "summary": "Get all roles for a list entity in a version of the application.", + "operationId": "Model_ListClosedListEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Closed List Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a list entity in a version of the application.", + "operationId": "Model_CreateClosedListEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Closed List Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateClosedListEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles": { + "get": { + "summary": "Get all roles for a regular expression entity in a version of the application.", + "operationId": "Model_ListRegexEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for an regular expression entity in a version of the application.", + "operationId": "Model_CreateRegexEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateRegexEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles": { + "get": { + "summary": "Get all roles for a composite entity in a version of the application", + "operationId": "Model_ListCompositeEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Composite Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a composite entity in a version of the application.", + "operationId": "Model_CreateCompositeEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateCompositeEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles": { + "get": { + "summary": "Get all roles for a Pattern.any entity in a version of the application", + "operationId": "Model_ListPatternAnyEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for an Pattern.any entity in a version of the application.", + "operationId": "Model_CreatePatternAnyEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles": { + "get": { + "summary": "Get all roles for a hierarchical entity in a version of the application", + "operationId": "Model_ListHierarchicalEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Hierarchical Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for an hierarchical entity in a version of the application.", + "operationId": "Model_CreateHierarchicalEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles": { + "get": { + "summary": "Get all roles for a prebuilt entity in a version of the application", + "operationId": "Model_ListCustomPrebuiltEntityRoles", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity Id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the entity roles", + "schema": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Custom Prebuilt Entity Roles request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json" + } + } + }, + "post": { + "summary": "Create a role for a prebuilt entity in a version of the application.", + "operationId": "Model_CreateCustomPrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleCreateObject", + "in": "body", + "description": "An entity role object containing the name of role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created entity role", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist": { + "get": { + "summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.", + "operationId": "Model_GetExplicitList", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A list of the explicit list items", + "schema": { + "$ref": "#/definitions/ExplicitListItemList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Explicit List request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyExplicitListRequest.json" + } + } + }, + "post": { + "summary": "Add a new exception to the explicit list for the Pattern.Any entity in a version of the application.", + "operationId": "Model_AddExplicitListItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "item", + "in": "body", + "description": "The new explicit list item.", + "required": true, + "schema": { + "$ref": "#/definitions/ExplicitListItemCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The ID of the created explicit list item.", + "schema": { + "$ref": "#/definitions/ExplicitListItemIDResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{regexEntityId}": { + "get": { + "summary": "Gets information about a regular expression entity in a version of the application.", + "operationId": "Model_GetRegexEntityEntityInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regular expression entity model ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A regular expression entity model info.", + "schema": { + "$ref": "#/definitions/RegexEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityInfoRequest.json" + } + } + }, + "put": { + "summary": "Updates the regular expression entity in a version of the application.", + "operationId": "Model_UpdateRegexEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regular expression entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "regexEntityUpdateObject", + "in": "body", + "description": "An object containing the new entity name and regex pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/RegexModelUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the regular expression entity extractor.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Regex Entity request": { + "$ref": "./examples/model/SuccessfulUpdateRegexEntityModelRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a regular expression entity from a version of the application.", + "operationId": "Model_DeleteRegexEntityModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "regexEntityId", + "in": "path", + "description": "The regular expression entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Regex Entity request": { + "$ref": "./examples/model/SuccessfulDeleteRegexEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}": { + "get": { + "summary": "Gets information about the Pattern.Any model in a version of the application.", + "operationId": "Model_GetPatternAnyEntityInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "A regular expression entity model info.", + "schema": { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json" + } + } + }, + "put": { + "summary": "Updates the name and explicit (exception) list of a Pattern.Any entity model in a version of the application.", + "operationId": "Model_UpdatePatternAnyEntityModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "patternAnyUpdateObject", + "in": "body", + "description": "An object containing the explicit list of the Pattern.Any entity.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternAnyModelUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the Pattern.Any entity extractor.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a Pattern.Any entity extractor from a version of the application.", + "operationId": "Model_DeletePatternAnyEntityModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Entity request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyEntityRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/entities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given entity in a version of the application", + "operationId": "Model_GetEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulGetEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given entity in a version of the application.", + "operationId": "Model_UpdateEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete an entity role in a version of the application.", + "operationId": "Model_DeleteEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulDeleteEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/prebuilts/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given prebuilt entity in a version of the application", + "operationId": "Model_GetPrebuiltEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given prebuilt entity in a version of the application", + "operationId": "Model_UpdatePrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Prebuilt Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role in a prebuilt entity in a version of the application.", + "operationId": "Model_DeletePrebuiltEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/closedlists/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given list entity in a version of the application.", + "operationId": "Model_GetClosedListEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Closed List Entity Role request": { + "$ref": "./examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given list entity in a version of the application.", + "operationId": "Model_UpdateClosedListEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Closed List Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given list entity in a version of the application.", + "operationId": "Model_DeleteClosedListEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/regexentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given regular expression entity in a version of the application.", + "operationId": "Model_GetRegexEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given regular expression entity in a version of the application", + "operationId": "Model_UpdateRegexEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Regex Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateRegexEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given regular expression in a version of the application.", + "operationId": "Model_DeleteRegexEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Regex Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteRegexEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/compositeentities/{cEntityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given composite entity in a version of the application", + "operationId": "Model_GetCompositeEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given composite entity in a version of the application", + "operationId": "Model_UpdateCompositeEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Composite Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given composite entity in a version of the application.", + "operationId": "Model_DeleteCompositeEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/CEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Composite Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given Pattern.any entity in a version of the application.", + "operationId": "Model_GetPatternAnyEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given Pattern.any entity in a version of the application.", + "operationId": "Model_UpdatePatternAnyEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given Pattern.any entity in a version of the application.", + "operationId": "Model_DeletePatternAnyEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Entity Role request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/hierarchicalentities/{hEntityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given hierarchical entity in a version of the application.", + "operationId": "Model_GetHierarchicalEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given hierarchical entity in a version of the application.", + "operationId": "Model_UpdateHierarchicalEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Hierarchical Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given hierarchical role in a version of the application.", + "operationId": "Model_DeleteHierarchicalEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/HEntityIdInPath" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Hierarchical Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/customprebuiltentities/{entityId}/roles/{roleId}": { + "get": { + "summary": "Get one role for a given prebuilt entity in a version of the application.", + "operationId": "Model_GetCustomEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "An entity role", + "schema": { + "$ref": "#/definitions/EntityRole" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Custom Prebuilt Domain Entity Role request": { + "$ref": "./examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json" + } + } + }, + "put": { + "summary": "Update a role for a given prebuilt entity in a version of the application.", + "operationId": "Model_UpdateCustomPrebuiltEntityRole", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "entityRoleUpdateObject", + "in": "body", + "description": "The new entity role.", + "required": true, + "schema": { + "$ref": "#/definitions/EntityRoleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the entity role.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Custom Prebuilt Entity Extractor Role request": { + "$ref": "./examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json" + } + } + }, + "delete": { + "summary": "Delete a role for a given prebuilt entity in a version of the application.", + "operationId": "Model_DeleteCustomEntityRole", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The entity ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "roleId", + "in": "path", + "description": "The entity role Id.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Custom Prebuilt Entity Role request": { + "$ref": "./examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternanyentities/{entityId}/explicitlist/{itemId}": { + "get": { + "summary": "Get the explicit (exception) list of the pattern.any entity in a version of the application.", + "operationId": "Model_GetExplicitListItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity Id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item Id.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "An explicit list item info.", + "schema": { + "$ref": "#/definitions/ExplicitListItem" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Pattern.Any Explicit List Item request": { + "$ref": "./examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json" + } + } + }, + "put": { + "summary": "Updates an explicit (exception) list item for a Pattern.Any entity in a version of the application.", + "operationId": "Model_UpdateExplicitListItem", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The Pattern.Any entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item ID.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "item", + "in": "body", + "description": "The new explicit list item.", + "required": true, + "schema": { + "$ref": "#/definitions/ExplicitListItemUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated the explicit list item.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern.Any Entity Explicit List Item request": { + "$ref": "./examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json" + } + } + }, + "delete": { + "summary": "Delete an item from the explicit (exception) list for a Pattern.any entity in a version of the application.", + "operationId": "Model_DeleteExplicitListItem", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "entityId", + "in": "path", + "description": "The pattern.any entity id.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "itemId", + "in": "path", + "description": "The explicit list item which will be deleted.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern.Any Explicit List Item request": { + "$ref": "./examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrule": { + "post": { + "summary": "Adds a pattern to a version of the application.", + "operationId": "Pattern_AddPattern", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "pattern", + "in": "body", + "description": "The input pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternRuleCreateObject" + } + } + ], + "responses": { + "201": { + "description": "The created pattern", + "schema": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Add Pattern request": { + "$ref": "./examples/patterns/SuccessfulAddPatternRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrules": { + "get": { + "summary": "Gets patterns in a version of the application.", + "operationId": "Pattern_ListPatterns", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "The retrieved patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Application Version Patterns request": { + "$ref": "./examples/patterns/SuccessfulGetPatternsRequest.json" + } + } + }, + "put": { + "summary": "Updates patterns in a version of the application.", + "operationId": "Pattern_UpdatePatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patterns", + "in": "body", + "description": "An array represents the patterns.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleUpdateObject" + } + } + } + ], + "responses": { + "200": { + "description": "The updated patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Update Patterns request": { + "$ref": "./examples/patterns/SuccessfulUpdatePatternsRequest.json" + } + } + }, + "post": { + "summary": "Adds a batch of patterns in a version of the application.", + "operationId": "Pattern_BatchAddPatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patterns", + "in": "body", + "description": "A JSON array containing patterns.", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleCreateObject" + } + } + } + ], + "responses": { + "201": { + "description": "The created patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Add Patterns request": { + "$ref": "./examples/patterns/SuccessfulBatchAddLabelsRequest.json" + } + } + }, + "delete": { + "summary": "Deletes a list of patterns in a version of the application.", + "operationId": "Pattern_DeletePatterns", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternIds", + "in": "body", + "description": "The patterns IDs.", + "required": true, + "schema": { + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Batch Delete Patterns request": { + "$ref": "./examples/patterns/SuccessfulDeletePatternsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/patternrules/{patternId}": { + "put": { + "summary": "Updates a pattern in a version of the application.", + "operationId": "Pattern_UpdatePattern", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern ID.", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "name": "pattern", + "in": "body", + "description": "An object representing a pattern.", + "required": true, + "schema": { + "$ref": "#/definitions/PatternRuleUpdateObject" + } + } + ], + "responses": { + "200": { + "description": "The updated pattern", + "schema": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Update Pattern request": { + "$ref": "./examples/patterns/SuccessfulUpdatePatternRequest.json" + } + } + }, + "delete": { + "summary": "Deletes the pattern with the specified ID from a version of the application..", + "operationId": "Pattern_DeletePattern", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "patternId", + "in": "path", + "description": "The pattern ID.", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successfully operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Pattern request": { + "$ref": "./examples/patterns/SuccessfulDeletePatternRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/intents/{intentId}/patternrules": { + "get": { + "summary": "Returns patterns for the specific intent in a version of the application.", + "operationId": "Pattern_ListIntentPatterns", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "$ref": "#/parameters/IntentIdInPath" + }, + { + "$ref": "#/parameters/SkipInPath" + }, + { + "$ref": "#/parameters/TakeInPath" + } + ], + "responses": { + "200": { + "description": "The retrieved patterns", + "schema": { + "$ref": "#/definitions/PatternRuleList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Intent Patterns request": { + "$ref": "./examples/patterns/SuccessfulGetIntentPatternsRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/settings": { + "get": { + "description": "Gets the settings in a version of the application.", + "operationId": "Settings_List", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "A list of the application version settings.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AppVersionSettingObject" + } + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get Application Version settings request": { + "$ref": "./examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json" + } + } + }, + "put": { + "description": "Updates the settings in a version of the application.", + "operationId": "Settings_Update", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + }, + { + "name": "listOfAppVersionSettingObject", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AppVersionSettingObject" + } + }, + "description": "A list of the updated application version settings." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Update Application Version settings request": { + "$ref": "./examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json" + } + } + } + }, + "/apps/{appId}/azureaccounts": { + "post": { + "description": "Assigns an Azure account to the application.", + "operationId": "AzureAccounts_AssignToApp", + "summary": "apps - Assign a LUIS Azure account to an application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "$ref": "#/parameters/ArmTokenParameter" + }, + { + "name": "azureAccountInfoObject", + "in": "body", + "schema": { + "$ref": "#/definitions/AzureAccountInfoObject" + }, + "description": "The Azure account information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Assign azure account request": { + "$ref": "./examples/stats/SuccessfulAssignAzureAccountRequest.json" + } + } + }, + "get": { + "description": "Gets the LUIS Azure accounts assigned to the application for the user using his ARM token.", + "operationId": "AzureAccounts_GetAssigned", + "summary": "apps - Get LUIS Azure accounts assigned to the application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "$ref": "#/parameters/ArmTokenParameter" + } + ], + "responses": { + "200": { + "description": "A list of azure account information objects.", + "schema": { + "$ref": "#/definitions/AzureAccountInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get assigned azure accounts request": { + "$ref": "./examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json" + } + } + }, + "delete": { + "description": "Removes assigned Azure account from the application.", + "operationId": "AzureAccounts_RemoveFromApp", + "summary": "apps - Removes an assigned LUIS Azure account from an application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "$ref": "#/parameters/ArmTokenParameter" + }, + { + "name": "azureAccountInfoObject", + "in": "body", + "schema": { + "$ref": "#/definitions/AzureAccountInfoObject" + }, + "description": "The Azure account information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful delete assigned azure account request": { + "$ref": "./examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json" + } + } + } + }, + "/azureaccounts": { + "get": { + "description": "Gets the LUIS Azure accounts for the user using his ARM token.", + "operationId": "AzureAccounts_ListUserLUISAccounts", + "summary": "user - Get LUIS Azure accounts", + "parameters": [ + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "$ref": "#/parameters/ArmTokenParameter" + } + ], + "responses": { + "200": { + "description": "A list of Azure account information objects.", + "schema": { + "$ref": "#/definitions/AzureAccountInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get azure accounts request": { + "$ref": "./examples/stats/SuccessfulGetAzureAccountsRequest.json" + } + } + } + }, + "/package/{appId}/slot/{slotName}/gzip": { + "get": { + "description": "Packages a published LUIS application as a GZip file to be used in the LUIS container.", + "operationId": "Apps_PackagePublishedApplicationAsGzip", + "summary": "package - Gets published LUIS application package in binary stream GZip format", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SlotNameInPath" + } + ], + "responses": { + "200": { + "description": "The GZip binary stream of the published application package.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream", + "application/json" + ], + "x-ms-examples": { + "Successful Get published application package request": { + "$ref": "./examples/package/SuccessfulGetTrainedApplicationPackageRequest.json" + } + } + } + }, + "/package/{appId}/versions/{versionId}/gzip": { + "get": { + "description": "Packages trained LUIS application as GZip file to be used in the LUIS container.", + "operationId": "Apps_PackageTrainedApplicationAsGzip", + "summary": "package - Gets trained LUIS application package in binary stream GZip format", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "The GZip binary stream of the trained application package.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream", + "application/json" + ], + "x-ms-examples": { + "Successful Get published application package request": { + "$ref": "./examples/package/SuccessfulGetPublishedApplicationPackageRequest.json" + } + } + } + } + }, + "x-ms-paths": { + "/apps/import?JsonVersion=V2": { + "post": { + "description": "Imports an application to LUIS, the application's structure is included in the request body.", + "operationId": "Apps_ImportV2App", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.", + "type": "string" + }, + { + "name": "luisAppV2", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisAppV2" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The ID of the imported application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/apps/SuccessfulImportV2ApplicationRequest.json" + } + } + } + }, + "/apps/import?format=lu": { + "post": { + "description": "Imports an application to LUIS, the application's structure is included in the request body.", + "operationId": "Apps_ImportLuFormat", + "parameters": [ + { + "name": "appName", + "in": "query", + "description": "The application name to create. If not specified, the application name will be read from the imported object. If the application name already exists, an error is returned.", + "type": "string" + }, + { + "name": "luisAppLu", + "in": "body", + "required": true, + "schema": { + "type": "string" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "text/plain" + ], + "responses": { + "201": { + "description": "The ID of the imported application.", + "x-nullable": false, + "schema": { + "$ref": "#/definitions/GuidResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/apps/SuccessfulImportLuApplicationRequest.json" + } + } + } + }, + "/apps/{appId}/versions/import?JsonVersion=V2": { + "post": { + "description": "Imports a new version into a LUIS application.", + "operationId": "Versions_ImportV2App", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "versionId", + "in": "query", + "description": "The new versionId to import. If not specified, the versionId will be read from the imported object.", + "type": "string" + }, + { + "name": "luisAppV2", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LuisAppV2" + }, + "description": "A LUIS application structure." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "The created application version.", + "schema": { + "$ref": "#/definitions/VersionResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/versions/SuccessfulImportV2ApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/import?format=lu": { + "post": { + "description": "Imports a new version into a LUIS application.", + "operationId": "Versions_ImportLuFormat", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "name": "versionId", + "in": "query", + "description": "The new versionId to import. If not specified, the versionId will be read from the imported object.", + "type": "string" + }, + { + "name": "luisAppLu", + "in": "body", + "required": true, + "schema": { + "type": "string" + }, + "description": "An LU representing the LUIS application structure." + } + ], + "consumes": [ + "text/plain" + ], + "responses": { + "201": { + "description": "The created application version.", + "schema": { + "$ref": "#/definitions/VersionResponse" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Import Application": { + "$ref": "./examples/versions/SuccessfulImportLuApplicationVersionRequest.json" + } + } + } + }, + "/apps/{appId}/versions/{versionId}/export?format=lu": { + "get": { + "description": "Exports a LUIS application to text format.", + "operationId": "Versions_ExportLuFormat", + "parameters": [ + { + "in": "query", + "name": "format", + "required": true, + "description": "Lu format extension", + "type": "string", + "enum": [ + "lu" + ] + }, + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "The LUIS application structure in LU format.", + "schema": { + "description": "The LUIS application structure in LU format.", + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream" + ], + "x-ms-examples": { + "Successful Export Application Version": { + "$ref": "./examples/versions/SuccessfulExportLuApplicationVersionRequest.json" + } + } + } + } + }, + "definitions": { + "EntityLabelObject": { + "description": "Defines the entity type and position of the extracted entity within the example.", + "type": "object", + "required": [ + "entityName", + "startCharIndex", + "endCharIndex" + ], + "properties": { + "entityName": { + "description": "The entity type.", + "type": "string" + }, + "startCharIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endCharIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "role": { + "description": "The role the entity plays in the utterance.", + "type": "string" + }, + "children": { + "description": "The identified entities within the example utterance.", + "items": { + "type": "object", + "$ref": "#/definitions/EntityLabelObject" + }, + "type": "array", + "example": [ + { + "entityName": "child", + "startCharIndex": 0, + "endCharIndex": 0, + "children": [] + } + ] + } + } + }, + "ApplicationCreateObject": { + "description": "Properties for creating a new LUIS Application", + "type": "object", + "required": [ + "culture", + "name" + ], + "properties": { + "culture": { + "description": "The culture for the new application. It is the language that your app understands and speaks. E.g.: \"en-us\". Note: the culture cannot be changed after the app is created.", + "type": "string" + }, + "domain": { + "description": "The domain for the new application. Optional. E.g.: Comics.", + "type": "string" + }, + "description": { + "description": "Description of the new application. Optional.", + "type": "string" + }, + "initialVersionId": { + "description": "The initial version ID. Optional. Default value is: \"0.1\"", + "type": "string" + }, + "usageScenario": { + "description": "Defines the scenario for the new application. Optional. E.g.: IoT.", + "type": "string" + }, + "name": { + "description": "The name for the new application.", + "type": "string" + } + } + }, + "PrebuiltDomainCreateBaseObject": { + "description": "A model object containing the name of the custom prebuilt entity and the name of the domain to which this model belongs.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + } + } + }, + "PrebuiltDomainCreateObject": { + "description": "A prebuilt domain create object containing the name and culture of the domain.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "culture": { + "description": "The culture of the new domain.", + "type": "string" + } + } + }, + "PrebuiltDomainModelCreateObject": { + "description": "A model object containing the name of the custom prebuilt intent or entity and the name of the domain to which this model belongs.", + "type": "object", + "properties": { + "domainName": { + "description": "The domain name.", + "type": "string" + }, + "modelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "CompositeEntityModel": { + "description": "A composite entity extractor.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + } + } + }, + "EntityModelCreateObject": { + "description": "An entity extractor create object.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ChildEntityModelCreateObject" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + } + } + }, + "ChildEntityModelCreateObject": { + "description": "A child entity extractor create object.", + "type": "object", + "properties": { + "children": { + "description": "Child entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ChildEntityModelCreateObject" + }, + "type": "array" + }, + "name": { + "description": "Entity name.", + "type": "string" + }, + "instanceOf": { + "description": "The instance of model name", + "type": "string" + } + } + }, + "EntityModelUpdateObject": { + "description": "An entity extractor update object.", + "type": "object", + "properties": { + "name": { + "description": "Entity name.", + "type": "string" + }, + "instanceOf": { + "description": "The instance of model name", + "type": "string" + } + } + }, + "JSONEntity": { + "description": "Exported Model - Extracted Entity from utterance.", + "type": "object", + "required": [ + "startPos", + "endPos", + "entity" + ], + "properties": { + "startPos": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endPos": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "entity": { + "description": "The entity name.", + "type": "string" + }, + "role": { + "description": "The role the entity plays in the utterance.", + "type": "string" + }, + "children": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/JSONEntity" + }, + "example": [ + { + "entity": "child1", + "startPos": 0, + "endPos": 0, + "children": [] + } + ] + } + } + }, + "ApplicationSettingUpdateObject": { + "description": "Object model for updating an application's settings.", + "type": "object", + "properties": { + "public": { + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "isPublic" + } + } + }, + "PublishSettingUpdateObject": { + "description": "Object model for updating an application's publish settings.", + "type": "object", + "properties": { + "sentimentAnalysis": { + "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response", + "type": "boolean", + "x-nullable": false + }, + "speech": { + "description": "Setting speech as public enables speech priming in your app", + "type": "boolean", + "x-nullable": false + }, + "spellChecker": { + "description": "Setting spell checker as public enables spell checking the input utterance.", + "type": "boolean", + "x-nullable": false + } + } + }, + "ExampleLabelObject": { + "description": "A labeled example utterance.", + "type": "object", + "properties": { + "text": { + "description": "The example utterance.", + "type": "string" + }, + "entityLabels": { + "description": "The identified entities within the example utterance.", + "items": { + "type": "object", + "$ref": "#/definitions/EntityLabelObject" + }, + "type": "array" + }, + "intentName": { + "description": "The identified intent representing the example utterance.", + "type": "string" + } + } + }, + "PhraselistCreateObject": { + "description": "Object model for creating a phraselist model.", + "type": "object", + "properties": { + "phrases": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "isExchangeable": { + "description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.", + "default": true, + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the Phraselist is enabled for all models in the application.", + "default": true, + "type": "boolean" + } + } + }, + "SubClosedList": { + "description": "Sublist of items for a list entity.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "SubClosedListResponse": { + "description": "Sublist of items for a list entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SubClosedList" + } + ], + "properties": { + "id": { + "description": "The sublist ID", + "type": "integer", + "x-nullable": false + } + } + }, + "ApplicationUpdateObject": { + "description": "Object model for updating the name or description of an application.", + "type": "object", + "properties": { + "name": { + "description": "The application's new name.", + "type": "string" + }, + "description": { + "description": "The application's new description.", + "type": "string" + } + } + }, + "PrebuiltExtractorNames": { + "description": "Object model for adding a prebuilt entity to the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "JSONRegexFeature": { + "description": "Exported Model - A Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + }, + "activated": { + "description": "Indicates if the Pattern feature is enabled.", + "type": "boolean" + }, + "name": { + "description": "Name of the feature.", + "type": "string" + } + } + }, + "ClosedList": { + "description": "Exported Model - A list entity.", + "type": "object", + "properties": { + "name": { + "description": "Name of the list entity.", + "type": "string" + }, + "subLists": { + "description": "Sublists for the list entity.", + "items": { + "type": "object", + "$ref": "#/definitions/SubClosedList" + }, + "type": "array" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "ClosedListModelPatchObject": { + "description": "Object model for adding a batch of sublists to an existing list entity.", + "type": "object", + "properties": { + "subLists": { + "description": "Sublists to add.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + } + } + }, + "JSONModelFeature": { + "description": "Exported Model - Phraselist Model Feature.", + "type": "object", + "properties": { + "activated": { + "description": "Indicates if the feature is enabled.", + "type": "boolean" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "words": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "mode": { + "description": "An interchangeable phrase list feature serves as a list of synonyms for training. A non-exchangeable phrase list serves as separate features for training. So, if your non-interchangeable phrase list contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-interchangeable phrase list as an additional bag of words to add to LUIS existing vocabulary features. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Default value is true.", + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the Phraselist is enabled for all models in the application.", + "default": true, + "type": "boolean" + } + } + }, + "ModelCreateObject": { + "description": "Object model for creating a new entity extractor.", + "type": "object", + "properties": { + "name": { + "description": "Name of the new entity extractor.", + "type": "string" + } + } + }, + "WordListObject": { + "description": "Sublist of items for a list entity.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "WordListBaseUpdateObject": { + "description": "Object model for updating one of the list entity's sublists.", + "type": "object", + "properties": { + "canonicalForm": { + "description": "The standard form that the list represents.", + "type": "string" + }, + "list": { + "description": "List of synonym words.", + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "JSONUtterance": { + "description": "Exported Model - Utterance that was used to train the model.", + "type": "object", + "properties": { + "text": { + "description": "The utterance.", + "type": "string" + }, + "intent": { + "description": "The matched intent.", + "type": "string" + }, + "entities": { + "description": "The matched entities.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONEntity" + }, + "type": "array" + } + } + }, + "ModelUpdateObject": { + "description": "Object model for updating an intent classifier.", + "type": "object", + "properties": { + "name": { + "description": "The entity's new name.", + "type": "string" + } + } + }, + "ClosedListModelUpdateObject": { + "description": "Object model for updating a list entity.", + "type": "object", + "properties": { + "subLists": { + "description": "The new sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + }, + "name": { + "description": "The new name of the list entity.", + "type": "string" + }, + "fuzzyMatchingEnabled": { + "description": "Enables the fuzzy matching for the list of entities", + "x-nullable": true, + "type": "boolean" + } + } + }, + "ClosedListModelCreateObject": { + "description": "Object model for creating a list entity.", + "type": "object", + "properties": { + "subLists": { + "description": "Sublists for the feature.", + "items": { + "type": "object", + "$ref": "#/definitions/WordListObject" + }, + "type": "array" + }, + "name": { + "description": "Name of the list entity.", + "type": "string" + }, + "fuzzyMatchingEnabled": { + "description": "Enables the fuzzy matching for the list of entities", + "x-nullable": true, + "type": "boolean" + } + } + }, + "ExampleLabelObjectArray": { + "description": "Object model for adding a batch of labeled examples.", + "items": { + "type": "object", + "$ref": "#/definitions/ExampleLabelObject" + }, + "type": "array" + }, + "VersionInfo": { + "description": "Object model of an application version.", + "type": "object", + "required": [ + "version", + "trainingStatus" + ], + "properties": { + "version": { + "description": "The version ID. E.g.: \"0.1\"", + "type": "string" + }, + "createdDateTime": { + "description": "The version's creation timestamp.", + "type": "string", + "format": "date-time" + }, + "lastModifiedDateTime": { + "description": "Timestamp of the last update.", + "type": "string", + "format": "date-time" + }, + "lastTrainedDateTime": { + "description": "Timestamp of the last time the model was trained.", + "type": "string", + "format": "date-time" + }, + "lastPublishedDateTime": { + "description": "Timestamp when was last published.", + "type": "string", + "format": "date-time" + }, + "endpointUrl": { + "description": "The Runtime endpoint URL for this model version.", + "type": "string" + }, + "assignedEndpointKey": { + "description": "The endpoint key.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "externalApiKeys": { + "description": "External keys.", + "type": "object" + }, + "intentsCount": { + "description": "Number of intents in this model.", + "type": "integer" + }, + "entitiesCount": { + "description": "Number of entities in this model.", + "type": "integer" + }, + "endpointHitsCount": { + "description": "Number of calls made to this endpoint.", + "type": "integer" + }, + "trainingStatus": { + "description": "The current training status.", + "type": "string", + "enum": [ + "NeedsTraining", + "InProgress", + "Trained" + ], + "x-ms-enum": { + "name": "TrainingStatus" + } + } + } + }, + "TaskUpdateObject": { + "description": "Object model for cloning an application's version.", + "type": "object", + "properties": { + "version": { + "description": "The new version for the cloned model.", + "type": "string" + } + } + }, + "PhraselistUpdateObject": { + "description": "Object model for updating a Phraselist.", + "type": "object", + "properties": { + "phrases": { + "description": "List of comma-separated phrases that represent the Phraselist.", + "type": "string" + }, + "name": { + "description": "The Phraselist name.", + "type": "string" + }, + "isActive": { + "description": "Indicates if the Phraselist is enabled.", + "default": true, + "type": "boolean" + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "default": true, + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the Phraselist is enabled for all models in the application.", + "default": true, + "type": "boolean" + } + } + }, + "PrebuiltDomainObject": { + "type": "object", + "properties": { + "domain_name": { + "type": "string" + }, + "model_name": { + "type": "string" + } + } + }, + "JsonChild": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "instanceOf": { + "type": "string" + }, + "children": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonChild" + }, + "type": "array" + }, + "features": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonModelFeatureInformation" + }, + "type": "array" + } + } + }, + "HierarchicalModel": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "children": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonChild" + }, + "type": "array" + }, + "features": { + "items": { + "type": "object", + "$ref": "#/definitions/JsonModelFeatureInformation" + }, + "type": "array" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + } + }, + "inherits": { + "type": "object", + "$ref": "#/definitions/PrebuiltDomainObject" + } + } + }, + "HierarchicalModelV2": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "children": { + "items": { + "type": "string" + }, + "type": "array" + }, + "inherits": { + "type": "object", + "$ref": "#/definitions/PrebuiltDomainObject" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ApplicationPublishObject": { + "description": "Object model for publishing a specific application version.", + "type": "object", + "properties": { + "versionId": { + "description": "The version ID to publish.", + "type": "string" + }, + "isStaging": { + "description": "Indicates if the staging slot should be used, instead of the Production one.", + "default": false, + "type": "boolean" + } + } + }, + "LuisAppV2": { + "description": "Exported Model - An exported LUIS Application.", + "additionalProperties": true, + "type": "object", + "properties": { + "luis_schema_version": { + "description": "Luis schema deserialization version.", + "type": "string" + }, + "name": { + "description": "The name of the application.", + "type": "string" + }, + "versionId": { + "description": "The version ID of the application that was exported.", + "type": "string" + }, + "desc": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. E.g.: en-us.", + "type": "string" + }, + "intents": { + "description": "List of intents.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModelV2" + }, + "type": "array" + }, + "entities": { + "description": "List of entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModelV2" + }, + "type": "array" + }, + "closedLists": { + "description": "List of list entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ClosedList" + }, + "type": "array" + }, + "composites": { + "description": "List of composite entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModelV2" + }, + "type": "array" + }, + "patternAnyEntities": { + "description": "List of Pattern.Any entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternAny" + }, + "type": "array" + }, + "regex_entities": { + "description": "List of regular expression entities.", + "items": { + "type": "object", + "$ref": "#/definitions/RegexEntity" + }, + "type": "array" + }, + "prebuiltEntities": { + "description": "List of prebuilt entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PrebuiltEntity" + }, + "type": "array" + }, + "regex_features": { + "description": "List of pattern features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONRegexFeature" + }, + "type": "array" + }, + "model_features": { + "description": "List of model features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONModelFeature" + }, + "type": "array" + }, + "patterns": { + "description": "List of patterns.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternRule" + }, + "type": "array" + }, + "utterances": { + "description": "List of example utterances.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONUtterance" + }, + "type": "array" + } + } + }, + "LuisApp": { + "description": "Exported Model - An exported LUIS Application.", + "additionalProperties": true, + "type": "object", + "properties": { + "name": { + "description": "The name of the application.", + "type": "string" + }, + "versionId": { + "description": "The version ID of the application that was exported.", + "type": "string" + }, + "desc": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. E.g.: en-us.", + "type": "string" + }, + "intents": { + "description": "List of intents.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "entities": { + "description": "List of entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "closedLists": { + "description": "List of list entities.", + "items": { + "type": "object", + "$ref": "#/definitions/ClosedList" + }, + "type": "array" + }, + "composites": { + "description": "List of composite entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "hierarchicals": { + "description": "List of hierarchical entities.", + "items": { + "type": "object", + "$ref": "#/definitions/HierarchicalModel" + }, + "type": "array" + }, + "patternAnyEntities": { + "description": "List of Pattern.Any entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternAny" + }, + "type": "array" + }, + "regex_entities": { + "description": "List of regular expression entities.", + "items": { + "type": "object", + "$ref": "#/definitions/RegexEntity" + }, + "type": "array" + }, + "prebuiltEntities": { + "description": "List of prebuilt entities.", + "items": { + "type": "object", + "$ref": "#/definitions/PrebuiltEntity" + }, + "type": "array" + }, + "regex_features": { + "description": "List of pattern features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONRegexFeature" + }, + "type": "array" + }, + "phraselists": { + "description": "List of model features.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONModelFeature" + }, + "type": "array" + }, + "patterns": { + "description": "List of patterns.", + "items": { + "type": "object", + "$ref": "#/definitions/PatternRule" + }, + "type": "array" + }, + "utterances": { + "description": "List of example utterances.", + "items": { + "type": "object", + "$ref": "#/definitions/JSONUtterance" + }, + "type": "array" + } + } + }, + "GuidResponse": { + "description": "The ID (GUID) returned by an operation.", + "type": "string", + "format": "uuid" + }, + "VersionResponse": { + "description": "The new version ID returned by when importing a model version.", + "type": "string" + }, + "FeatureIDResponse": { + "description": "The ID of the created feature.", + "type": "integer", + "x-nullable": false + }, + "LabeledUtterances": { + "description": "A list of predictions and label pairs for every example in the application.", + "type": "array", + "items": { + "$ref": "#/definitions/LabeledUtterance" + } + }, + "LabeledUtterance": { + "description": "A prediction and label pair of an example.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of Labeled Utterance." + }, + "text": { + "type": "string", + "description": "The utterance. For example, \"What's the weather like in seattle?\"" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentLabel": { + "description": "The intent matching the example.", + "type": "string" + }, + "entityLabels": { + "description": "The entities matching the example.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityLabel" + } + }, + "intentPredictions": { + "description": "List of suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "List of suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "IntentsSuggestionExamples": { + "description": "List of predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentsSuggestionExample" + } + }, + "IntentsSuggestionExample": { + "description": "Predicted/suggested intent.", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The utterance. For example, \"What's the weather like in seattle?\"" + }, + "tokenizedText": { + "type": "array", + "description": "The tokenized utterance.", + "items": { + "type": "string" + } + }, + "intentPredictions": { + "description": "Predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "Predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "EntitiesSuggestionExamples": { + "description": "List of predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntitiesSuggestionExample" + } + }, + "EntitiesSuggestionExample": { + "description": "Predicted/suggested entity.", + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The utterance. For example, \"What's the weather like in seattle?\"" + }, + "tokenizedText": { + "type": "array", + "description": "The utterance tokenized.", + "items": { + "type": "string" + } + }, + "intentPredictions": { + "description": "Predicted/suggested intents.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentPrediction" + } + }, + "entityPredictions": { + "description": "Predicted/suggested entities.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityPrediction" + } + } + } + }, + "EntityLabel": { + "description": "Defines the entity type and position of the extracted entity within the example.", + "type": "object", + "properties": { + "entityName": { + "description": "The entity type.", + "type": "string" + }, + "startTokenIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endTokenIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "role": { + "type": "string", + "description": "The role of the predicted entity." + }, + "roleId": { + "type": "string", + "format": "uuid", + "description": "The role id for the predicted entity." + }, + "children": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/EntityLabel" + }, + "example": [ + { + "entityName": "child", + "startTokenIndex": 0, + "endTokenIndex": 0, + "children": [] + } + ] + } + }, + "required": [ + "entityName", + "startTokenIndex", + "endTokenIndex" + ] + }, + "IntentPrediction": { + "description": "A suggested intent.", + "type": "object", + "properties": { + "name": { + "description": "The intent's name", + "type": "string" + }, + "score": { + "description": "The intent's score, based on the prediction model.", + "type": "number" + } + } + }, + "EntityPrediction": { + "description": "A suggested entity.", + "type": "object", + "required": [ + "entityName", + "startTokenIndex", + "endTokenIndex", + "phrase" + ], + "properties": { + "entityName": { + "description": "The entity's name", + "type": "string" + }, + "startTokenIndex": { + "description": "The index within the utterance where the extracted entity starts.", + "type": "integer" + }, + "endTokenIndex": { + "description": "The index within the utterance where the extracted entity ends.", + "type": "integer" + }, + "phrase": { + "type": "string", + "description": "The actual token(s) that comprise the entity." + }, + "children": { + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/EntityPrediction" + }, + "example": [ + { + "entityName": "child", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "string" + } + ] + } + } + }, + "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 Authoring API key.", + "items": { + "type": "string", + "format": "uuid" + } + }, + "PersonalAssistantUrls": { + "type": "object", + "description": "Endpoint URLs for prebuilt Cortana applications.", + "additionalProperties": { + "type": "string" + } + }, + "ModelInfo": { + "description": "Base type used in entity types.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "integer", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + }, + "fuzzyMatchingEnabled": { + "description": "Enables the fuzzy matching for the list of entities", + "x-nullable": true, + "type": "boolean" + } + }, + "required": [ + "id", + "readableType" + ] + }, + "ModelsInfoResponseObject": { + "description": "A list of application model infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelInfoResponse" + } + }, + "ModelInfoResponse": { + "description": "An application model info.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID of the Entity Model." + }, + "name": { + "type": "string", + "description": "Name of the Entity Model." + }, + "typeId": { + "type": "integer", + "description": "The type ID of the Entity Model." + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "required": [ + "id", + "readableType" + ], + "allOf": [ + { + "$ref": "#/definitions/HierarchicalEntityExtractor" + }, + { + "$ref": "#/definitions/CompositeEntityExtractor" + }, + { + "$ref": "#/definitions/ClosedListEntityExtractor" + }, + { + "$ref": "#/definitions/IntentClassifier" + }, + { + "$ref": "#/definitions/EntityExtractor" + }, + { + "$ref": "#/definitions/RegexEntityExtractor" + }, + { + "$ref": "#/definitions/PatternAnyEntityExtractor" + }, + { + "$ref": "#/definitions/NDepthEntityExtractor" + } + ] + }, + "EntityModelInfo": { + "description": "An Entity Extractor model info.", + "type": "object", + "properties": { + "roles": { + "$ref": "#/definitions/EntityRoleList" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ] + }, + "ReadableType": { + "description": "Full name of the entity type.", + "type": "string", + "enum": [ + "Entity Extractor", + "Child Entity Extractor", + "Hierarchical Entity Extractor", + "Hierarchical Child Entity Extractor", + "Composite Entity Extractor", + "List Entity Extractor", + "Prebuilt Entity Extractor", + "Intent Classifier", + "Pattern.Any Entity Extractor", + "Closed List Entity Extractor", + "Regex Entity Extractor" + ] + }, + "HierarchicalEntityExtractor": { + "description": "Hierarchical Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Hierarchical Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "children": { + "description": "List of child entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "HierarchicalEntityExtractorsList": { + "description": "List of Hierarchical Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/HierarchicalEntityExtractor" + } + }, + "CompositeEntityExtractor": { + "description": "A Composite Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Composite Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "children": { + "description": "List of child entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "CompositeEntityExtractorsList": { + "description": "List of Composite Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/CompositeEntityExtractor" + } + }, + "ClosedListEntityExtractor": { + "description": "List Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "List Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "subLists": { + "description": "List of sublists.", + "type": "array", + "items": { + "$ref": "#/definitions/SubClosedListResponse" + } + } + } + }, + "ClosedListEntityExtractorsList": { + "description": "List of List Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/ClosedListEntityExtractor" + } + }, + "PrebuiltEntityExtractor": { + "description": "Prebuilt Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Prebuilt Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ] + }, + "PrebuiltEntityExtractorsList": { + "description": "List of Prebuilt Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltEntityExtractor" + } + }, + "ChildEntity": { + "type": "object", + "description": "The base child entity type.", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) belonging to a child entity." + }, + "name": { + "type": "string", + "description": "The name of a child entity." + }, + "instanceOf": { + "description": "Instance of Model.", + "type": "string" + }, + "typeId": { + "description": "The type ID of the Entity Model.", + "type": "integer" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + }, + "children": { + "description": "List of children", + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + }, + "required": [ + "id" + ] + }, + "HierarchicalChildEntity": { + "description": "A Hierarchical Child Entity.", + "type": "object", + "properties": { + "typeId": { + "description": "The type ID of the Entity Model.", + "type": "integer" + }, + "readableType": { + "$ref": "#/definitions/ReadableType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ChildEntity" + } + ] + }, + "CustomPrebuiltModel": { + "description": "A Custom Prebuilt model.", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/IntentClassifier" + }, + { + "$ref": "#/definitions/EntityExtractor" + } + ] + }, + "CustomPrebuiltModelList": { + "description": "A List of Custom Prebuilt models.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomPrebuiltModel" + } + }, + "IntentClassifier": { + "description": "Intent Classifier.", + "type": "object", + "x-ms-discriminator-value": "Intent Classifier", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "EntityExtractor": { + "description": "Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + } + } + }, + "NDepthEntityExtractor": { + "description": "N-Depth Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "N-Depth Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "customPrebuiltDomainName": { + "description": "The domain name.", + "type": "string" + }, + "customPrebuiltModelName": { + "description": "The intent name or entity name.", + "type": "string" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/ChildEntity" + } + } + } + }, + "IntentClassifiersList": { + "description": "List of Intent Classifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/IntentClassifier" + } + }, + "EntityExtractorsList": { + "description": "List of Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityExtractor" + } + }, + "NDepthEntityExtractorsList": { + "description": "List of N-Depth Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/NDepthEntityExtractor" + } + }, + "FeaturesResponseObject": { + "description": "Model Features, including Patterns and Phraselists.", + "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": "integer", + "description": "A six-digit ID used for Features." + }, + "name": { + "type": "string", + "description": "The name of the Feature." + }, + "isActive": { + "description": "Indicates if the feature is enabled.", + "type": "boolean" + }, + "enabledForAllModels": { + "description": "Indicates if the feature is enabled for all models in the application.", + "type": "boolean" + } + } + }, + "PatternFeatureInfo": { + "description": "Pattern feature.", + "type": "object", + "properties": { + "pattern": { + "description": "The Regular Expression to match.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/FeatureInfoObject" + } + ] + }, + "PatternFeatureInfoList": { + "description": "List of Pattern features.", + "type": "array", + "items": { + "$ref": "#/definitions/PatternFeatureInfo" + } + }, + "PhraseListFeatureInfo": { + "description": "Phraselist Feature.", + "type": "object", + "properties": { + "phrases": { + "type": "string", + "description": "A list of comma-separated values." + }, + "isExchangeable": { + "description": "An exchangeable phrase list feature are serves as single feature to the LUIS underlying training algorithm. It is used as a lexicon lookup feature where its value is 1 if the lexicon contains a given word or 0 if it doesn’t. Think of an exchangeable as a synonyms list. A non-exchangeable phrase list feature has all the phrases in the list serve as separate features to the underlying training algorithm. So, if you your phrase list feature contains 5 phrases, they will be mapped to 5 separate features. You can think of the non-exchangeable phrase list feature as an additional bag of words that you are willing to add to LUIS existing vocabulary features. Think of a non-exchangeable as set of different words. Default value is true.", + "type": "boolean" + } + }, + "allOf": [ + { + "$ref": "#/definitions/FeatureInfoObject" + } + ] + }, + "PhraseListFeatureInfoList": { + "description": "List of Phraselist Features.", + "type": "array", + "items": { + "$ref": "#/definitions/PhraseListFeatureInfo" + } + }, + "LabelExampleResponse": { + "description": "Response when adding a labeled example utterance.", + "type": "object", + "properties": { + "UtteranceText": { + "description": "The example utterance.", + "type": "string" + }, + "ExampleId": { + "description": "The newly created sample ID.", + "type": "integer", + "format": "int64" + } + } + }, + "BatchLabelExample": { + "description": "Response when adding a batch of labeled example utterances.", + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/LabelExampleResponse" + }, + "hasError": { + "type": "boolean" + }, + "error": { + "$ref": "#/definitions/OperationStatus" + } + } + }, + "BatchLabelExampleResponse": { + "description": "Response when adding a batch of labeled example utterances.", + "type": "array", + "items": { + "$ref": "#/definitions/BatchLabelExample" + } + }, + "ApplicationInfoResponse": { + "description": "Response containing the Application Info.", + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) of the application." + }, + "name": { + "description": "The name of the application.", + "type": "string" + }, + "description": { + "description": "The description of the application.", + "type": "string" + }, + "culture": { + "description": "The culture of the application. For example, \"en-us\".", + "type": "string" + }, + "usageScenario": { + "description": "Defines the scenario for the new application. Optional. For example, IoT.", + "type": "string" + }, + "domain": { + "description": "The domain for the new application. Optional. For example, Comics.", + "type": "string" + }, + "versionsCount": { + "description": "Amount of model versions within the application.", + "type": "integer" + }, + "createdDateTime": { + "description": "The version's creation timestamp.", + "type": "string" + }, + "endpoints": { + "description": "The Runtime endpoint URL for this model version.", + "type": "object" + }, + "endpointHitsCount": { + "description": "Number of calls made to this endpoint.", + "type": "integer" + }, + "activeVersion": { + "description": "The version ID currently marked as active.", + "type": "string" + } + } + }, + "ApplicationsInfoList": { + "description": "List of Application Infos.", + "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": { + "description": "The version ID to publish.", + "type": "string" + }, + "isStaging": { + "description": "Indicates if the staging slot should be used, instead of the Production one.", + "type": "boolean" + }, + "endpointUrl": { + "description": "The Runtime endpoint URL for this model version.", + "type": "string" + }, + "region": { + "description": "The target region that the application is published to.", + "type": "string" + }, + "assignedEndpointKey": { + "description": "The endpoint key.", + "type": "string" + }, + "endpointRegion": { + "type": "string", + "description": "The endpoint's region." + }, + "failedRegions": { + "type": "string", + "description": "Regions where publishing failed." + }, + "publishedDateTime": { + "description": "Timestamp when was last published.", + "type": "string" + } + } + }, + "AvailableEndpoints": { + "type": "object", + "description": "Collection of endpoint URLs where the selected application is deployed to.", + "additionalProperties": { + "type": "string" + } + }, + "AvailableCulture": { + "description": "Available culture for using in a new application.", + "type": "object", + "properties": { + "name": { + "description": "The language name.", + "type": "string" + }, + "code": { + "description": "The ISO value for the language.", + "type": "string" + } + } + }, + "AvailableCultures": { + "type": "array", + "description": "A list of available application cultures.", + "items": { + "$ref": "#/definitions/AvailableCulture" + } + }, + "AvailableDomains": { + "description": "A list of available application domains.", + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationUsageScenarios": { + "description": "A list of possible application usage scenarios.", + "type": "array", + "items": { + "type": "string" + } + }, + "ApplicationSettings": { + "description": "The application settings.", + "type": "object", + "properties": { + "id": { + "description": "The application ID.", + "type": "string", + "format": "uuid" + }, + "public": { + "description": "Setting your application as public allows other people to use your application's endpoint using their own keys for billing purposes.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "isPublic" + } + }, + "required": [ + "id", + "public" + ] + }, + "PublishSettings": { + "description": "The application publish settings.", + "type": "object", + "properties": { + "id": { + "description": "The application ID.", + "type": "string", + "format": "uuid" + }, + "sentimentAnalysis": { + "description": "Setting sentiment analysis as true returns the sentiment of the input utterance along with the response", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSentimentAnalysisEnabled" + }, + "speech": { + "description": "Enables speech priming in your app", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSpeechEnabled" + }, + "spellChecker": { + "description": "Enables spell checking of the utterance.", + "type": "boolean", + "x-nullable": false, + "x-ms-client-name": "IsSpellCheckerEnabled" + } + }, + "required": [ + "id", + "sentimentAnalysis", + "speech", + "spellChecker" + ] + }, + "AvailablePrebuiltEntityModel": { + "description": "Available Prebuilt entity model for using in an application.", + "type": "object", + "properties": { + "name": { + "description": "The entity name.", + "type": "string" + }, + "description": { + "description": "The entity description and usage information.", + "type": "string" + }, + "examples": { + "description": "Usage examples.", + "type": "string" + } + } + }, + "AvailablePrebuiltEntityModels": { + "description": "List of Available Prebuilt entity models.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrebuiltEntityModel" + } + }, + "EnqueueTrainingResponse": { + "description": "Response model when requesting to train the model.", + "type": "object", + "properties": { + "statusId": { + "description": "The train request status ID.", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + } + } + }, + "TrainingStatus": { + "description": "The Training status.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "UpToDate", + "Fail", + "Success" + ] + }, + "ModelTrainingInfo": { + "description": "Model Training Info.", + "type": "object", + "properties": { + "modelId": { + "type": "string", + "format": "uuid", + "description": "The ID (GUID) of the model." + }, + "details": { + "$ref": "#/definitions/ModelTrainingDetails" + } + } + }, + "ModelTrainingDetails": { + "description": "Model Training Details.", + "type": "object", + "properties": { + "statusId": { + "description": "The train request status ID.", + "type": "integer" + }, + "status": { + "$ref": "#/definitions/TrainingStatus" + }, + "exampleCount": { + "description": "The count of examples used to train the model.", + "type": "integer" + }, + "trainingDateTime": { + "description": "When the model was trained.", + "type": "string", + "format": "date-time" + }, + "failureReason": { + "description": "Reason for the training failure.", + "type": "string" + } + } + }, + "ModelTrainingInfoList": { + "description": "List of Model Training Infos.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelTrainingInfo" + } + }, + "UserAccessList": { + "description": "List of user permissions.", + "type": "object", + "properties": { + "owner": { + "type": "string", + "description": "The email address of owner of the application." + }, + "emails": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "UserCollaborator": { + "type": "object", + "properties": { + "email": { + "type": "string", + "description": "The email address of the user." + } + } + }, + "CollaboratorsArray": { + "type": "object", + "properties": { + "emails": { + "type": "array", + "description": "The email address of the users.", + "items": { + "type": "string" + } + } + } + }, + "OperationStatus": { + "description": "Response of an Operation status.", + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "Status Code.", + "enum": [ + "Failed", + "FAILED", + "Success" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OperationStatusType" + } + }, + "message": { + "type": "string", + "description": "Status details." + } + } + }, + "ErrorResponse": { + "description": "Error response when invoking an operation on the API.", + "type": "object", + "properties": { + "errorType": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "OperationError": { + "description": "Operation error details when invoking an operation on the API.", + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "PrebuiltDomainsList": { + "description": "List of Prebuilt Domains.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomain" + } + }, + "PrebuiltDomain": { + "description": "Prebuilt Domain.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "culture": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + }, + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainItem" + } + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltDomainItem" + } + } + } + }, + "PrebuiltDomainItem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "examples": { + "type": "string" + } + } + }, + "GuidList": { + "description": "List of IDs (GUID)", + "type": "array", + "items": { + "$ref": "#/definitions/GuidResponse" + } + }, + "EntityRoleCreateObject": { + "description": "Object model for creating an entity role.", + "type": "object", + "properties": { + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "RegexModelCreateObject": { + "description": "Model object for creating a regular expression entity model.", + "type": "object", + "properties": { + "regexPattern": { + "description": "The regular expression entity pattern.", + "type": "string" + }, + "name": { + "description": "The model name.", + "type": "string" + } + } + }, + "PatternAnyModelCreateObject": { + "description": "Model object for creating a Pattern.Any entity model.", + "type": "object", + "properties": { + "name": { + "description": "The model name.", + "type": "string" + }, + "explicitList": { + "description": "The Pattern.Any explicit list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExplicitListItemCreateObject": { + "description": "Object model for creating an explicit (exception) list item.", + "type": "object", + "properties": { + "explicitListItem": { + "description": "The explicit list item.", + "type": "string" + } + } + }, + "RegexModelUpdateObject": { + "description": "Model object for updating a regular expression entity model.", + "type": "object", + "properties": { + "regexPattern": { + "description": "The regular expression entity pattern.", + "type": "string" + }, + "name": { + "description": "The model name.", + "type": "string" + } + } + }, + "PatternAnyModelUpdateObject": { + "description": "Model object for updating a Pattern.Any entity model.", + "type": "object", + "properties": { + "name": { + "description": "The model name.", + "type": "string" + }, + "explicitList": { + "description": "The Pattern.Any explicit list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "EntityRoleUpdateObject": { + "description": "Object model for updating an entity role.", + "type": "object", + "properties": { + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "ExplicitListItemUpdateObject": { + "description": "Model object for updating an explicit (exception) list item.", + "type": "object", + "properties": { + "explicitListItem": { + "description": "The explicit list item.", + "type": "string" + } + } + }, + "PatternRuleCreateObject": { + "description": "Object model for creating a pattern", + "type": "object", + "properties": { + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name which the pattern belongs to.", + "type": "string" + } + } + }, + "PatternRuleUpdateObject": { + "description": "Object model for updating a pattern.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The pattern ID.", + "type": "string" + }, + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name which the pattern belongs to.", + "type": "string" + } + } + }, + "RegexEntityExtractor": { + "description": "Regular Expression Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Regex Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "regexPattern": { + "description": "The Regular Expression entity pattern.", + "type": "string" + } + } + }, + "RegexEntityExtractorList": { + "description": "List of Regular Expression Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/RegexEntityExtractor" + } + }, + "PatternAnyEntityExtractor": { + "description": "Pattern.Any Entity Extractor.", + "type": "object", + "x-ms-discriminator-value": "Pattern.Any Entity Extractor", + "allOf": [ + { + "$ref": "#/definitions/ModelInfo" + }, + { + "$ref": "#/definitions/EntityModelInfo" + } + ], + "properties": { + "explicitList": { + "$ref": "#/definitions/ExplicitListItemList" + } + } + }, + "PatternAnyEntityExtractorList": { + "description": "List of Pattern.Any Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/PatternAnyEntityExtractor" + } + }, + "EntityRole": { + "description": "Entity extractor role", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The entity role ID.", + "type": "string" + }, + "name": { + "description": "The entity role name.", + "type": "string" + } + } + }, + "EntityRoleList": { + "description": "List of Pattern.Any Entity Extractors.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityRole" + } + }, + "ExplicitListItem": { + "description": "Explicit (exception) list item", + "type": "object", + "properties": { + "id": { + "format": "int64", + "description": "The explicit list item ID.", + "type": "integer" + }, + "explicitListItem": { + "description": "The explicit list item value.", + "type": "string" + } + } + }, + "ExplicitListItemList": { + "description": "List of explicit (exception) list items", + "type": "array", + "items": { + "$ref": "#/definitions/ExplicitListItem" + } + }, + "ExplicitListItemIDResponse": { + "description": "The ID of the created explicit list item.", + "type": "integer", + "x-nullable": false + }, + "PatternRuleInfo": { + "description": "Pattern rule", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "The pattern ID.", + "type": "string" + }, + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name where the pattern belongs to.", + "type": "string" + } + } + }, + "PatternRuleList": { + "description": "List of patterns", + "type": "array", + "items": { + "$ref": "#/definitions/PatternRuleInfo" + } + }, + "ExamplesPerModelResponseObject": { + "description": "A list of example utterances per model.", + "type": "array", + "items": { + "$ref": "#/definitions/LabelTextObject" + } + }, + "LabelTextObject": { + "description": "An object containing the example utterance's text.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the Label." + }, + "text": { + "type": "string", + "description": "The text of the label." + } + } + }, + "FeaturesPerModelResponseObject": { + "description": "A list of feature information objects per model.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelFeatureInformation" + } + }, + "ModelFeatureInformation": { + "description": "An object containing the model feature information either the model name or feature name.", + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the model used." + }, + "featureName": { + "type": "string", + "description": "The name of the feature used." + }, + "isRequired": { + "type": "boolean" + } + } + }, + "JsonModelFeatureInformation": { + "description": "An object containing the model feature information either the model name or feature name.", + "type": "object", + "properties": { + "modelName": { + "type": "string", + "description": "The name of the model used." + }, + "featureName": { + "type": "string", + "description": "The name of the feature used." + } + } + }, + "PatternAny": { + "description": "Pattern.Any Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "explicitList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "RegexEntity": { + "description": "Regular Expression Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "regexPattern": { + "type": "string" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "PrebuiltEntity": { + "description": "Prebuilt Entity Extractor.", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "roles": { + "items": { + "type": "string" + }, + "type": "array" + } + } + }, + "PatternRule": { + "description": "Pattern", + "type": "object", + "properties": { + "pattern": { + "description": "The pattern text.", + "type": "string" + }, + "intent": { + "description": "The intent's name where the pattern belongs to.", + "type": "string" + } + } + }, + "AppVersionSettingObject": { + "description": "Object model of an application version setting.", + "type": "object", + "properties": { + "name": { + "description": "The application version setting name.", + "type": "string" + }, + "value": { + "description": "The application version setting value.", + "type": "string" + } + } + }, + "AzureAccountInfoList": { + "description": "List of Azure account info objects.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureAccountInfoObject" + } + }, + "AzureAccountInfoObject": { + "description": "Defines the Azure account information object.", + "type": "object", + "required": [ + "azureSubscriptionId", + "resourceGroup", + "accountName" + ], + "properties": { + "azureSubscriptionId": { + "description": "The id for the Azure subscription.", + "type": "string" + }, + "resourceGroup": { + "description": "The Azure resource group name.", + "type": "string" + }, + "accountName": { + "description": "The Azure account name.", + "type": "string" + } + } + } + }, + "parameters": { + "AppIdInPath": { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "The application ID.", + "x-ms-parameter-location": "method" + }, + "VersionIdInPath": { + "name": "versionId", + "in": "path", + "description": "The version ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "CEntityIdInPath": { + "name": "cEntityId", + "in": "path", + "description": "The composite entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "HEntityIdInPath": { + "name": "hEntityId", + "in": "path", + "description": "The hierarchical entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "IntentIdInPath": { + "name": "intentId", + "in": "path", + "description": "The intent classifier ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "EntityIdInPath": { + "name": "entityId", + "in": "path", + "description": "The entity extractor ID.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "SlotNameInPath": { + "name": "slotName", + "in": "path", + "description": "The publishing slot name.", + "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, + "minimum": 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, + "minimum": 0, + "maximum": 500, + "x-ms-parameter-location": "method" + }, + "ForcePath": { + "name": "force", + "in": "query", + "description": "A flag to indicate whether to force an operation.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "BearerAuthPath": { + "name": "Authorization", + "in": "header", + "description": "The bearer authorization header to use; containing the user's ARM token used to validate Azure accounts information.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ArmTokenParameter": { + "in": "header", + "name": "ArmToken", + "required": false, + "description": "The custom arm token header to use; containing the user's ARM token used to validate azure accounts information.", + "type": "string", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "EnableNestedChildren": { + "name": "enableNestedChildren", + "in": "query", + "type": "boolean", + "default": false, + "description": "Toggles nested/flat format", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulAddApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulAddApplicationRequest.json new file mode 100644 index 000000000000..9d4b4886cee5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulAddApplicationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "applicationCreateObject": { + "culture": "en-us", + "domain": "Comics", + "description": "New LUIS App", + "usageScenario": "IoT", + "name": "New LUIS App" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/9e6703ec-56fe-48ce-8a72-10d592f6056d" + }, + "body": "9e6703ec-56fe-48ce-8a72-10d592f6056d" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json new file mode 100644 index 000000000000..c4dccb5fdb37 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulAddCustomPrebuiltApplicationRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "prebuiltDomainCreateObject": { + "culture": "en-US", + "domainName": "Web" + } + }, + "responses": { + "201": { + "headers": { + "location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/customprebuiltdomains/00000000-0000-0000-0000-000000000000" + }, + "body": "00000000-0000-0000-0000-000000000000" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulDeleteApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulDeleteApplicationRequest.json new file mode 100644 index 000000000000..d4b87f77d103 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulDeleteApplicationRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json new file mode 100644 index 000000000000..97528c73eec3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/octet-stream" + }, + "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\"\": []}\"" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json new file mode 100644 index 000000000000..0ad1e00a6681 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationCulturesRequest.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "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" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json new file mode 100644 index 000000000000..7b30aa76981a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationDomainsRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "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" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationInfoRequest.json new file mode 100644 index 000000000000..5374060f0e95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationInfoRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "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 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json new file mode 100644 index 000000000000..1cf9c19dc47d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationSettingsRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", + "public": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json new file mode 100644 index 000000000000..4177f38f46e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationUsageScenariosListRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + "IoT", + "Bot", + "Mobile Application", + "Other" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationsListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationsListRequest.json new file mode 100644 index 000000000000..2cd6815f6b46 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetApplicationsListRequest.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "skip": 0, + "take": 100 + }, + "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 + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json new file mode 100644 index 000000000000..4248d6289988 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsForCultureRequest.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "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" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json new file mode 100644 index 000000000000..08ed90e3c9cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetAvailableCustomPrebuiltDomainsRequest.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "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" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetEndpointsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetEndpointsRequest.json new file mode 100644 index 000000000000..a85a3c60f003 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetEndpointsRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "westus": "https://westus.api.cognitive.microsoft.com/api/v3.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "eastus2": "https://eastus2.api.cognitive.microsoft.com/api/v3.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "westcentralus": "https://westcentralus.api.cognitive.microsoft.com/api/v3.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a", + "southeastasia": "https://southeastasia.api.cognitive.microsoft.com/api/v3.0/apps/bb25e72c-2279-46bb-a99b-89fcb921b58a" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json new file mode 100644 index 000000000000..9d62ff8c21d2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetPersonalAssistantApplications.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "endpointKeys": [], + "endpointUrls": { + "English": "EnglishDummyURL", + "Chinese": "ChineseDummyURL", + "French": "FrenchDummyURL", + "Spanish": "SpanishDummyURL", + "Italian": "ItalianDummyURL" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetPublishSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetPublishSettingsRequest.json new file mode 100644 index 000000000000..89f4df476993 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulGetPublishSettingsRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "51963bf0-08a1-44b7-9c69-735dbb92ce74", + "sentimentAnalysis": true, + "speech": true, + "spellChecker": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportApplicationRequest.json new file mode 100644 index 000000000000..a1b49bc45ca8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportApplicationRequest.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appName": "Test LUIS App", + "luisApp": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f" + }, + "body": "374fac89-ae12-4afd-8c21-8a6424ce1c1f" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportLuApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportLuApplicationRequest.json new file mode 100644 index 000000000000..b1e458fb7cee --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportLuApplicationRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appName": "Test LUIS App", + "luisAppLu": "> LUIS application information\r\n> !# @app.name = Json 600 App\r\n> !# @app.desc = Json 600 App\r\n> !# @app.versionId = 0.1\r\n> !# @app.culture = en-us\r\n> !# @app.luis_schema_version = 6.0.0\r\n\r\n\r\n> # Intent definitions\r\n\r\n> !# @intent.inherits = name : Calendar.AcceptEventEntry; domain_name : Calendar; model_name : AcceptEventEntry\r\n\r\n## Calendar.AcceptEventEntry\r\n- save the date may 17 {@Calendar.Subject=pictures party}\r\n- schedule {@Calendar.Subject=appointment} for tomorrow please\r\n- {@Calendar.Subject=Meeting My Manager}\r\n- The meeting will last for one hour\r\n- Add an event to visit 209 Nashville Gym\r\n- Add {@Calendar.Subject=imax theater} to my upcoming events\r\n- dunmore pa sonic sounds Friday morning please\r\n- Add a new task {@Calendar.Subject=finish assignment}\r\n- Add a new event on 27 - Apr\r\n- calendar i ' ll be at the garage from 8 till 3 this saturday\r\n- Add an event to {@Calendar.Subject=read about adam lambert news}\r\n\r\n\r\n> !# @intent.inherits = name : Communication.AddContact; domain_name : Communication; model_name : AddContact\r\n\r\n## Communication.AddContact\r\n\r\n\r\n@ intent Communication.AddContact usesFeatures simpleentity1,phraselist1\r\n\r\n> !# @intent.inherits = name : Communication.AddMore; domain_name : Communication; model_name : AddMore\r\n\r\n## Communication.AddMore\r\n\r\n\r\n> !# @intent.inherits = name : Communication.Confirm; domain_name : Communication; model_name : Confirm\r\n\r\n## Communication.Confirm\r\n\r\n\r\n## intent1\r\n\r\n\r\n## None\r\n- a\r\n- hi {@simpleentity1=guys}\r\n- Please just delete {@Calendar.Subject=my meeting}\r\n- Extend {@Calendar.Subject=lunch meeting} 30 minutes extra\r\n- {@Calendar.Subject=Marketing meetings} on Tuesdays will now be every Wednesday please change on my calendar\r\n- {@Calendar.Subject=Appointment with Johnson} needs to be next week\r\n- Search for {@Calendar.Subject=meetings with Chris}\r\n- I want to reschedule the {@Calendar.Subject=meeting at the air force club}\r\n- Move the {@Calendar.Subject=BBQ party} to Friday\r\n- Am i free to {@Calendar.Subject=be with friends} saturday ?\r\n- Delete {@Calendar.Subject=Helen Fred ' s birthday}\r\n- {@Calendar.Subject=Call dad Mike}\r\n- {@Calendar.Subject=The workshop} will last for 10 hours\r\n- {@Calendar.Subject=email cloney John}\r\n- Change {@Calendar.Subject=the meeting with Chris} to 9 : 00 am\r\n\r\n\r\n> # Entity definitions\r\n\r\n> !# @entity.inherits = name : Calendar.Subject; domain_name : Calendar; model_name : Subject\r\n\r\n@ ml Calendar.Subject usesFeatures simpleentity1\r\n\r\n@ ml simpleentity1\r\n\r\n@ ml a1 hasRole role_a1\r\n - @ datetimeV2 b1\r\n - @ ml c1\r\n - @ ml d1 usesFeatures phraselist1\r\n - @ datetimeV2 e1 usesFeatures phraselist1\r\n\r\n\r\n\r\n> # PREBUILT Entity definitions\r\n\r\n@ prebuilt age\r\n\r\n@ prebuilt datetimeV2\r\n\r\n\r\n> # Phrase list definitions\r\n\r\n@ phraselist phraselist1(interchangeable) = \r\n\t- why,where,when,what,how,who\r\n\r\n\r\n> # List entities\r\n\r\n@ list closedlist = \r\n\t- a :\r\n\t\t- b\r\n\t\t- c\r\n\t\t- d\r\n\r\n\r\n> # RegEx entities\r\n\r\n\r\n> # Composite entities\r\n\r\n@ composite compositeentity1 usesFeatures simpleentity1,Calendar.Subject = [simpleentity1, datetimeV2]\r\n" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f" + }, + "body": "374fac89-ae12-4afd-8c21-8a6424ce1c1f" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportV2ApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportV2ApplicationRequest.json new file mode 100644 index 000000000000..85cd4b385e8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulImportV2ApplicationRequest.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appName": "Test LUIS App", + "luisAppV2": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/374fac89-ae12-4afd-8c21-8a6424ce1c1f" + }, + "body": "374fac89-ae12-4afd-8c21-8a6424ce1c1f" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulPublishApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulPublishApplicationRequest.json new file mode 100644 index 000000000000..7131c8127ee2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulPublishApplicationRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "11be6373fca44ded80fbe2afa8597c18", + "applicationPublishObject": { + "versionId": "0.1", + "isStaging": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "isStaging": false, + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v3.0/apps/11be6373fca44ded80fbe2afa8597c18", + "assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18", + "endpointRegion": "westus, cus", + "failedRegions": null, + "publishedDateTime": "2017-11-28T19:20:28Z" + } + }, + "207": { + "headers": {}, + "body": { + "isStaging": false, + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v3.0/apps/11be6373fca44ded80fbe2afa8597c18", + "assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18", + "endpointRegion": "westus, cus", + "failedRegions": "cus", + "publishedDateTime": "2017-11-28T19:20:28Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulRenameApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulRenameApplicationRequest.json new file mode 100644 index 000000000000..52a47756fda7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulRenameApplicationRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "applicationUpdateObject": { + "name": "LUIS App name updated", + "description": "LUIS App description updated" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json new file mode 100644 index 000000000000..662d17154fda --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulUpdateApplicationSettingsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "applicationSettingUpdateObject": { + "public": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json new file mode 100644 index 000000000000..95f8c39bacf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/apps/SuccessfulUpdatePublishSettingsRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "publishSettingUpdateObject": { + "sentimentAnalysis": true, + "speech": true, + "spellChecker": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulAddLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulAddLabelRequest.json new file mode 100644 index 000000000000..5512edd005fc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulAddLabelRequest.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "enableNestedChildren": false, + "exampleLabelObject": { + "text": "whats the weather in buenos aires?", + "intentName": "WeatherInPlace", + "entityLabels": [ + { + "entityName": "Place", + "startCharIndex": 21, + "endCharIndex": 34 + } + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "UtteranceText": "whats the weather in buenos aires?", + "ExampleId": -11 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json new file mode 100644 index 000000000000..516369be8a7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "2370fb9d-7dbc-4898-a361-a742cf290766", + "versionId": "0.1", + "enableNestedChildren": false, + "exampleLabelObjectArray": [ + { + "text": "whats the weather in seattle?", + "entityLabels": [ + { + "entityName": "Place", + "startCharIndex": 21, + "endCharIndex": 29 + } + ], + "intentName": "WeatherInPlace" + }, + { + "text": "whats the weather in buenos aires?", + "entityLabels": [ + { + "entityName": "Place", + "startCharIndex": 21, + "endCharIndex": 34 + } + ], + "intentName": "WeatherInPlace" + } + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "value": { + "UtteranceText": "whats the weather in seattle?", + "ExampleId": -728104 + }, + "hasError": false + }, + { + "value": { + "UtteranceText": "whats the weather in buenos aires?", + "ExampleId": -5313943 + }, + "hasError": false + } + ] + }, + "207": { + "headers": {}, + "body": [ + { + "hasError": true, + "error": { + "code": "FAILED", + "message": "whats the weather in seattle?. Error: The intent classifier InvalidIntent does not exist in the selected application" + } + }, + { + "value": { + "UtteranceText": "whats the weather in buenos aires?", + "ExampleId": -5313943 + }, + "hasError": false + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json new file mode 100644 index 000000000000..8ee37c1f5b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulDeleteExampleLabelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "exampleId": -5313926 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json new file mode 100644 index 000000000000..49071d052202 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "enableNestedChildren": false + }, + "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", + "startTokenIndex": 7, + "endTokenIndex": 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", + "startTokenIndex": 7, + "endTokenIndex": 7, + "role": "To" + }, + { + "entityName": "Location", + "startTokenIndex": 5, + "endTokenIndex": 5, + "role": "from" + } + ], + "intentPredictions": [ + { + "name": "BookFlight", + "score": 0.93 + }, + { + "name": "None", + "score": 0.41 + }, + { + "name": "GetWeather", + "score": 0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 8, + "endTokenIndex": 9, + "phrase": "next thursday" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json new file mode 100644 index 000000000000..2ed286e00f91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulCreatePhraselistFeatureRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistCreateObject": { + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true + } + }, + "responses": { + "201": { + "headers": {}, + "body": 1823 + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..9a2cbf9d87f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulDeletePhraselistFeatureInfoRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistId": 178384 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json new file mode 100644 index 000000000000..3a70755fff0f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetApplicationVersionFeaturesRequest.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skipIn": 0, + "takeIn": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "phraselistFeatures": [ + { + "id": 5341, + "name": "Cities", + "phrases": "Seattle,New York,Paris,Moscow,Beijin", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + }, + { + "id": 74598, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + } + ], + "patternFeatures": [ + { + "id": 81231, + "name": "EmailPattern", + "pattern": "\\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\\.[A-Z]{2,}\\b", + "isActive": true, + "enabledForAllModels": true + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json new file mode 100644 index 000000000000..3a6f5e4b33e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetApplicationVersionPhraselistFeaturesRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 321421, + "name": "Cities", + "phrases": "Seattle,New York,Paris,Moscow,Beijin", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + }, + { + "id": 97832, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..52649ceb5c3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulGetPhraselistFeatureInfoRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistId": 178384 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 178384, + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isExchangeable": true, + "isActive": true, + "enabledForAllModels": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json new file mode 100644 index 000000000000..9faceb14a074 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/features/SuccessfulUpdatePhraselistFeatureInfoRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "phraselistId": 178384, + "phraselistUpdateObject": { + "name": "DaysOfWeek", + "phrases": "monday,tuesday,wednesday,thursday,friday,saturday,sunday", + "isActive": false, + "isExchangeable": true, + "enabledForAllModels": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..305e4023e1e6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddApplicationVersionPrebuiltInfosRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltExtractorNames": [ + "datetimeV2" + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json new file mode 100644 index 000000000000..d6673649257b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuildDomainToApplicationRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "prebuiltDomainObject": { + "domainName": "Web" + } + }, + "responses": { + "201": { + "headers": {}, + "body": [ + "2639049a-e41d-4285-a3c6-8a17ed299473", + "200d6173-ecfa-4967-bf95-3c319902dc52", + "f80aa9ba-64c8-4a36-8cc5-92010d0aadf1", + "f50d6f0f-b2dd-4973-9270-c114312b3a10" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json new file mode 100644 index 000000000000..f2399d68b3de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuildIntentRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0", + "prebuiltDomainModelCreateObject": { + "domainName": "Calendar", + "modelName": "Add" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json new file mode 100644 index 000000000000..f059dc322ee5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddCustomPrebuiltEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0", + "prebuiltDomainModelCreateObject": { + "domainName": "Camera", + "modelName": "AppName" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "1c2e70c1-3cbf-4e89-9703-9583b81102b9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddEntityFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddEntityFeatureRelationRequest.json new file mode 100644 index 000000000000..57e58c5c4f0c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddEntityFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationCreateObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddIntentFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddIntentFeatureRelationRequest.json new file mode 100644 index 000000000000..2d7ee0655191 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddIntentFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationCreateObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json new file mode 100644 index 000000000000..cdf1dfbc6747 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulAddSublistToClosedListEntityModelRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "wordListCreateObject": { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/28027e3b-8356-4cdf-b395-24afb94e9469/sublists/6134877" + }, + "body": 6134877 + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json new file mode 100644 index 000000000000..dace6ef7a4de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateClosedListEntityModelRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "closedListModelCreateObject": { + "name": "States", + "subLists": [ + { + "canonicalForm": "New York", + "list": [ + "NY", + "New York" + ] + }, + { + "canonicalForm": "Washington", + "list": [ + "Washington", + "WA" + ] + }, + { + "canonicalForm": "California", + "list": [ + "California", + "CA", + "Calif.", + "Cal." + ] + } + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": "8713b104-78ec-4c4f-9f96-f2e53562cc16" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json new file mode 100644 index 000000000000..c53665177eb2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateClosedListEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json new file mode 100644 index 000000000000..2bb04cce834e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCompositeChildModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "compositeChildModelCreateObject": { + "name": "dateFrame" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "891c235f-4f42-4320-bc36-b6256b6c3f2b" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..73ef2299a78b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCompositeEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/compositeentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..3803afb83656 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/customprebuiltentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityChildModelRequest.json new file mode 100644 index 000000000000..646d7054e2ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityChildModelRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "childEntityModelCreateObject": { + "name": "Day", + "children": [], + "instanceOf": "number" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "891c235f-4f42-4320-bc36-b6256b6c3f2b" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityExtractorRequest.json new file mode 100644 index 000000000000..21dd3cd74147 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityExtractorRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityModelCreateObject": { + "name": "DayOfWeek", + "children": [ + { + "name": "Day", + "instanceOf": "datetimeV2" + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/7e838199-a5db-47a6-8931-d79f1729a922" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityRoleRequest.json new file mode 100644 index 000000000000..635b60997a98 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/entities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..b561a13ea1e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateHierarchicalEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/hierarchicalentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateIntentClassifierRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateIntentClassifierRequest.json new file mode 100644 index 000000000000..360e9f0bc1aa --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateIntentClassifierRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentCreateObject": { + "name": "BookFlight" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "227a71ed-7d4b-4dce-8f3a-16c4e5cc06e8" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json new file mode 100644 index 000000000000..b213febc28f8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyEntityExtractorRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "extractorCreateObject": { + "name": "AirportCodeRegex", + "explicitList": [ + "item 1", + "item 2" + ] + } + }, + "responses": { + "201": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..5e3515782610 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json new file mode 100644 index 000000000000..9946ab555d94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePatternAnyExplicitListRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "item": { + "explicitListItem": "item 1" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/patternanyentities/fc821c4e-a2f8-4074-9410-7271b38a692d/explicitlist/8645" + }, + "body": 8645 + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..75f28692cf5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreatePrebuiltEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/prebuilts/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json new file mode 100644 index 000000000000..01886097f539 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateRegexEntityExtractorRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityExtractorCreateObj": { + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "bc1bae43-7904-48ad-a165-88b1910174f9" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json new file mode 100644 index 000000000000..ab629ac50e3c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulCreateRegexEntityRoleRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "fc821c4e-a2f8-4074-9410-7271b38a692d", + "entityRoleCreateObject": { + "name": "sample role" + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/regexentities/fc821c4e-a2f8-4074-9410-7271b38a692d/roles/3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "body": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json new file mode 100644 index 000000000000..51dc2f145c5c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteClosedListEntityModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json new file mode 100644 index 000000000000..7d3835d1c72c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeChildModelRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "cChildId": "891c235f-4f42-4320-bc36-b6256b6c3f2b" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json new file mode 100644 index 000000000000..36253c0b0e77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..eb058743cbdb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCompositeEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json new file mode 100644 index 000000000000..527791465895 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityExtractorRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json new file mode 100644 index 000000000000..77bcdbd7c486 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationDeleteObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json new file mode 100644 index 000000000000..160694dc02c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalChildModelRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "hChildId": "fe559c31-9778-42ea-ed45-94e0bd7cf767" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json new file mode 100644 index 000000000000..79283b0975b4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "hEntityId": "{hEntityId}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..22c45f4c81de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteHierarchicalEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json new file mode 100644 index 000000000000..90d8a50f666a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteIntentFeatureRelationRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationDeleteObject": { + "featureName": "Phraselist1" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteIntentModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteIntentModelRequest.json new file mode 100644 index 000000000000..396d8d3b3b23 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteIntentModelRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json new file mode 100644 index 000000000000..527791465895 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json new file mode 100644 index 000000000000..f5052475dd3f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePatternAnyExplicitListItemRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "itemId": 543211 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json new file mode 100644 index 000000000000..7557e0d93a28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltDomainFromApplicationRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "domainName": "Web" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json new file mode 100644 index 000000000000..208e4484deae --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeletePrebuiltEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteRegexEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteRegexEntityRequest.json new file mode 100644 index 000000000000..8a16ae29c73a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteRegexEntityRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json new file mode 100644 index 000000000000..bf989faebffc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteRegexEntityRoleRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteSublistRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteSublistRequest.json new file mode 100644 index 000000000000..0d3bf08baf1e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulDeleteSublistRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "subListId": 123 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json new file mode 100644 index 000000000000..0d50a283b553 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "11be6373fca44ded80fbe2afa8597c18", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "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." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json new file mode 100644 index 000000000000..488104e50742 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": 0, + "take": 100 + }, + "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" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json new file mode 100644 index 000000000000..4ee81b36ccf6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json new file mode 100644 index 000000000000..e3caf94b3199 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "{appId}", + "versionId": "{versionId}", + "skip": 0, + "take": 100 + }, + "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" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json new file mode 100644 index 000000000000..7bbe97aef02b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "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" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json new file mode 100644 index 000000000000..edab6c2a1d44 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json @@ -0,0 +1,183 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "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", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "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" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "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" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "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." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "$Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "9500536f-ffec-4fab-93ad-6268abb0f73c", + "name": "$Camera.CapturePhoto", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "CapturePhoto" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json new file mode 100644 index 000000000000..9b96c5e3b6f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionPatternAnyEntityInfosRequest.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any 1", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [ + { + "id": 456, + "explicitListItem": "item 1" + }, + { + "id": 457, + "explicitListItem": "item 2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any 2", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [], + "roles": [] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json new file mode 100644 index 000000000000..51985bdac0e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "a18eaa87-ecd9-4a67-a951-e70cf5b87c7e", + "name": "datetime", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json new file mode 100644 index 000000000000..1ae466748e94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetApplicationVersionRegexEntityInfosRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "Guid regex", + "regexPattern": "[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{3}-[0-9A-F]{12}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json new file mode 100644 index 000000000000..e1e9a393772e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "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" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json new file mode 100644 index 000000000000..e7a6acd06c8b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityInfoRequest.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "8713b104-78ec-4c4f-9f96-f2e53562cc16" + }, + "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." + ] + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetClosedListEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json new file mode 100644 index 000000000000..50832117a604 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "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" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json new file mode 100644 index 000000000000..03d1d14f36bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json new file mode 100644 index 000000000000..23455912afe2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCompositeEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json new file mode 100644 index 000000000000..ea428c098af3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuildIntentRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "Camera.AppName", + "typeId": 1, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Add" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json new file mode 100644 index 000000000000..df2704a27f18 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainEntitiesRequest.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "b8e31be4-300f-455e-894b-6f079abca0a2", + "name": "Camera.AppName", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Camera", + "customPrebuiltModelName": "AppName", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json new file mode 100644 index 000000000000..e81d514c3e5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltDomainModelsRequest.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "1.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "1aa813da-8d36-4d16-bb13-d6f193290fea", + "name": "Calendar.Find", + "typeId": 0, + "readableType": "Intent Classifier", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Find" + }, + { + "id": "d02b2e38-6b3c-412e-bf9e-f6770a40c9a0", + "name": "Calendar.Location", + "typeId": 1, + "readableType": "Entity Extractor", + "customPrebuiltDomainName": "Calendar", + "customPrebuiltModelName": "Location", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetCustomPrebuiltEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityFeaturesInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityFeaturesInfoRequest.json new file mode 100644 index 000000000000..6bc5840cc97f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityFeaturesInfoRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityInfoRequest.json new file mode 100644 index 000000000000..2a90b679eea1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityInfoRequest.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "DayOfWeek", + "typeId": 1, + "readableType": "Entity Extractor", + "children": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "typeId": 1, + "readableType": "Child Entity Extractor", + "name": "Day", + "instanceOf": "datetimeV2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json new file mode 100644 index 000000000000..f6605ccf44e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json @@ -0,0 +1,2644 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "enableNestedChildren": false + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "text": "hey", + "tokenizedText": [ + "hey" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "2-2-2017", + "tokenizedText": [ + "2", + "-", + "2", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.88 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "2-2-2017" + } + ] + }, + { + "text": "maybe find me an airport first", + "tokenizedText": [ + "maybe", + "find", + "me", + "an", + "airport", + "first" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "as", + "tokenizedText": [ + "as" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.98 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in barcelona", + "tokenizedText": [ + "find", + "hotel", + "in", + "barcelona" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + } + ] + }, + { + "text": "find airport with code atl", + "tokenizedText": [ + "find", + "airport", + "with", + "code", + "atl" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "atl" + } + ] + }, + { + "text": "change hotel location to madrid", + "tokenizedText": [ + "change", + "hotel", + "location", + "to", + "madrid" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.24 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "madrid" + } + ] + }, + { + "text": "ok, find me an airport", + "tokenizedText": [ + "ok", + ",", + "find", + "me", + "an", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "eze", + "tokenizedText": [ + "eze" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.68 + }, + { + "name": "None", + "score": 0.29 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "eze" + } + ] + }, + { + "text": "today", + "tokenizedText": [ + "today" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.64 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "today" + } + ] + }, + { + "text": "buenos aires", + "tokenizedText": [ + "buenos", + "aires" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.16 + }, + { + "name": "WeatherInPlace", + "score": 0.07 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "hi there", + "tokenizedText": [ + "hi", + "there" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.37 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "05-28-2017", + "tokenizedText": [ + "05", + "-", + "28", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.85 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "05-28-2017" + } + ] + }, + { + "text": "tomorrow", + "tokenizedText": [ + "tomorrow" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.6 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "tomorrow" + } + ] + }, + { + "text": "tell me the weather in san francisco", + "tokenizedText": [ + "tell", + "me", + "the", + "weather", + "in", + "san", + "francisco" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 0.99 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "san francisco" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "san francisco" + } + ] + }, + { + "text": "find me a hotel in barcelona", + "tokenizedText": [ + "find", + "me", + "a", + "hotel", + "in", + "barcelona" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "barcelona" + } + ] + }, + { + "text": "dme", + "tokenizedText": [ + "dme" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.62 + }, + { + "name": "FindAirportByCode", + "score": 0.09 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "dude", + "tokenizedText": [ + "dude" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "sorry, find me airport juj", + "tokenizedText": [ + "sorry", + ",", + "find", + "me", + "airport", + "juj" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "juj" + } + ] + }, + { + "text": "madrid", + "tokenizedText": [ + "madrid" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.52 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "search for airport", + "tokenizedText": [ + "search", + "for", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "what's the time in miami?", + "tokenizedText": [ + "what", + "'", + "s", + "the", + "time", + "in", + "miami", + "?" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "miami" + }, + { + "entityName": "geography", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "miami" + } + ] + }, + { + "text": "next monday", + "tokenizedText": [ + "next", + "monday" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.3 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 1, + "phrase": "next monday" + } + ] + }, + { + "text": "search hotels, seattle", + "tokenizedText": [ + "search", + "hotels", + ",", + "seattle" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "None", + "score": 0.02 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "seattle" + } + ] + }, + { + "text": "change location to madrid", + "tokenizedText": [ + "change", + "location", + "to", + "madrid" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "None", + "score": 0.03 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "madrid" + } + ] + }, + { + "text": "search hotels, \"next day\"", + "tokenizedText": [ + "search", + "hotels", + ",", + "\"", + "next", + "day", + "\"" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 0.99 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find a deluxe room in a 3 stars hotel in barcelona please", + "tokenizedText": [ + "find", + "a", + "deluxe", + "room", + "in", + "a", + "3", + "stars", + "hotel", + "in", + "barcelona", + "please" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "RoomType", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "deluxe" + }, + { + "entityName": "Category", + "startTokenIndex": 6, + "endTokenIndex": 7, + "phrase": "3 stars" + }, + { + "entityName": "Renamed Entity", + "startTokenIndex": 10, + "endTokenIndex": 10, + "phrase": "barcelona" + }, + { + "entityName": "geography", + "startTokenIndex": 10, + "endTokenIndex": 10, + "phrase": "barcelona" + } + ] + }, + { + "text": "time miami", + "tokenizedText": [ + "time", + "miami" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "None", + "score": 0.14 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in barcelona from today", + "tokenizedText": [ + "find", + "hotel", + "in", + "barcelona", + "from", + "today" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + }, + { + "entityName": "Checkin", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + } + ] + }, + { + "text": "search for 5 start hotels in jujuy", + "tokenizedText": [ + "search", + "for", + "5", + "start", + "hotels", + "in", + "jujuy" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "5" + }, + { + "entityName": "Category", + "startTokenIndex": 2, + "endTokenIndex": 3, + "phrase": "5 start" + }, + { + "entityName": "Renamed Entity", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "jujuy" + } + ] + }, + { + "text": "search hotels, past tomorrow", + "tokenizedText": [ + "search", + "hotels", + ",", + "past", + "tomorrow" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "tomorrow" + } + ] + }, + { + "text": "loz", + "tokenizedText": [ + "loz" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "loz" + } + ] + }, + { + "text": "show me the weather", + "tokenizedText": [ + "show", + "me", + "the", + "weather" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "dme airport", + "tokenizedText": [ + "dme", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "None", + "score": 0.04 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "dme" + } + ] + }, + { + "text": "find zzz airport", + "tokenizedText": [ + "find", + "zzz", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 1, + "endTokenIndex": 1, + "phrase": "zzz" + } + ] + }, + { + "text": "change location to miami", + "tokenizedText": [ + "change", + "location", + "to", + "miami" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "None", + "score": 0.08 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "miami" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "miami" + } + ] + }, + { + "text": "find hotel from today till next monday", + "tokenizedText": [ + "find", + "hotel", + "from", + "today", + "till", + "next", + "monday" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Checkin", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "today" + }, + { + "entityName": "Checkout", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "next monday" + }, + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "next monday" + } + ] + }, + { + "text": "sorry, find me airport with code bcn", + "tokenizedText": [ + "sorry", + ",", + "find", + "me", + "airport", + "with", + "code", + "bcn" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.02 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 7, + "endTokenIndex": 7, + "phrase": "bcn" + } + ] + }, + { + "text": "actionresult = \"weather in aisjj3o9f2\"", + "tokenizedText": [ + "actionresult", + "=", + "\"", + "weather", + "in", + "aisjj3o9f2", + "\"" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 0.82 + }, + { + "name": "FindHotels", + "score": 0.02 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "aisjj3o9f2" + } + ] + }, + { + "text": "[object object]", + "tokenizedText": [ + "[", + "object", + "object", + "]" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.06 + }, + { + "name": "FindHotels", + "score": 0.05 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "05-27-2017", + "tokenizedText": [ + "05", + "-", + "27", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.84 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "05-27-2017" + } + ] + }, + { + "text": "change hotel location", + "tokenizedText": [ + "change", + "hotel", + "location" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "FindHotels", + "score": 0.03 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "asdttt", + "tokenizedText": [ + "asdttt" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "whats the time in miami", + "tokenizedText": [ + "whats", + "the", + "time", + "in", + "miami" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "miami" + }, + { + "entityName": "geography", + "startTokenIndex": 4, + "endTokenIndex": 4, + "phrase": "miami" + } + ] + }, + { + "text": "time in brasil", + "tokenizedText": [ + "time", + "in", + "brasil" + ], + "intentPredictions": [ + { + "name": "TimeInPlace", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "brasil" + } + ] + }, + { + "text": "mia", + "tokenizedText": [ + "mia" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "3-3-2017", + "tokenizedText": [ + "3", + "-", + "3", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.87 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "3-3-2017" + } + ] + }, + { + "text": "how is the weather in buenos aires?", + "tokenizedText": [ + "how", + "is", + "the", + "weather", + "in", + "buenos", + "aires", + "?" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 0.97 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "buenos aires" + } + ] + }, + { + "text": "n", + "tokenizedText": [ + "n" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.98 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find aaa airport", + "tokenizedText": [ + "find", + "aaa", + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 1, + "endTokenIndex": 1, + "phrase": "aaa" + } + ] + }, + { + "text": "find airport lhr", + "tokenizedText": [ + "find", + "airport", + "lhr" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "lhr" + } + ] + }, + { + "text": "juj", + "tokenizedText": [ + "juj" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 0, + "endTokenIndex": 0, + "phrase": "juj" + } + ] + }, + { + "text": "adweqwe", + "tokenizedText": [ + "adweqwe" + ], + "intentPredictions": [ + { + "name": "None", + "score": 1.0 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in madrid for today", + "tokenizedText": [ + "find", + "hotel", + "in", + "madrid", + "for", + "today" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "madrid" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "madrid" + }, + { + "entityName": "Checkin", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + }, + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "today" + } + ] + }, + { + "text": "find airport zzz", + "tokenizedText": [ + "find", + "airport", + "zzz" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Code", + "startTokenIndex": 2, + "endTokenIndex": 2, + "phrase": "zzz" + } + ] + }, + { + "text": "search hotels, \"past tomorrow\"", + "tokenizedText": [ + "search", + "hotels", + ",", + "\"", + "past", + "tomorrow", + "\"" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 5, + "endTokenIndex": 5, + "phrase": "tomorrow" + } + ] + }, + { + "text": "search for 5 stars hotels in barcelo", + "tokenizedText": [ + "search", + "for", + "5", + "stars", + "hotels", + "in", + "barcelo" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Category", + "startTokenIndex": 2, + "endTokenIndex": 3, + "phrase": "5 stars" + }, + { + "entityName": "Renamed Entity", + "startTokenIndex": 6, + "endTokenIndex": 6, + "phrase": "barcelo" + } + ] + }, + { + "text": "airport", + "tokenizedText": [ + "airport" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 1.0 + }, + { + "name": "None", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "change location", + "tokenizedText": [ + "change", + "location" + ], + "intentPredictions": [ + { + "name": "FindHotels-ChangeLocation", + "score": 1.0 + }, + { + "name": "None", + "score": 0.19 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "11/11/2017", + "tokenizedText": [ + "11", + "/", + "11", + "/", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.9 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "11/11/2017" + } + ] + }, + { + "text": "tell me the weather in new york", + "tokenizedText": [ + "tell", + "me", + "the", + "weather", + "in", + "new", + "york" + ], + "intentPredictions": [ + { + "name": "WeatherInPlace", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "new york" + }, + { + "entityName": "geography", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "new york" + }, + { + "entityName": "Retrieve Sample List", + "startTokenIndex": 5, + "endTokenIndex": 6, + "phrase": "new york" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetExamplesPerModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetExamplesPerModelRequest.json new file mode 100644 index 000000000000..0bd9783b948a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetExamplesPerModelRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000}", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "modelId": "e4770e43-233a-48ad-a1fa-54f4f97eff9f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 10002, + "text": "Lorem ipsum dolor sit amet" + }, + { + "id": 10003, + "text": "consectetur adipiscing elit" + }, + { + "id": 10004, + "text": "sed do eiusmod tempor incididunt" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json new file mode 100644 index 000000000000..cb3138df0672 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json new file mode 100644 index 000000000000..85d6eba6f6f1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "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" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json new file mode 100644 index 000000000000..dd9c6f7f42ba --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json new file mode 100644 index 000000000000..1b0fc00770de --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetHierarchicalEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentFeaturesInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentFeaturesInfoRequest.json new file mode 100644 index 000000000000..8836884506bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentFeaturesInfoRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentInfoRequest.json new file mode 100644 index 000000000000..1716e6373d98 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentInfoRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "8285a9ee-6bc0-4409-87f4-82d539f70529", + "name": "TestIntent", + "typeId": 0, + "readableType": "Intent Classifier" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json new file mode 100644 index 000000000000..260784bda5d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "enableNestedChildren": false + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "text": "hey", + "tokenizedText": [ + "hey" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.65 + }, + { + "name": "FindAirportByCode", + "score": 0.02 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "2-2-2017", + "tokenizedText": [ + "2", + "-", + "2", + "-", + "2017" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.88 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "datetime", + "startTokenIndex": 0, + "endTokenIndex": 4, + "phrase": "2-2-2017" + } + ] + }, + { + "text": "maybe find me an airport first", + "tokenizedText": [ + "maybe", + "find", + "me", + "an", + "airport", + "first" + ], + "intentPredictions": [ + { + "name": "FindAirportByCode", + "score": 0.99 + }, + { + "name": "FindHotels", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "as", + "tokenizedText": [ + "as" + ], + "intentPredictions": [ + { + "name": "None", + "score": 0.98 + }, + { + "name": "FindAirportByCode", + "score": 0.01 + }, + { + "name": "WeatherInPlace", + "score": 0.01 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "FindHotels", + "score": 0.0 + } + ], + "entityPredictions": [] + }, + { + "text": "find hotel in barcelona", + "tokenizedText": [ + "find", + "hotel", + "in", + "barcelona" + ], + "intentPredictions": [ + { + "name": "FindHotels", + "score": 1.0 + }, + { + "name": "TimeInPlace", + "score": 0.0 + }, + { + "name": "None", + "score": 0.0 + }, + { + "name": "FindAirportByCode", + "score": 0.0 + }, + { + "name": "FindHotels-ChangeLocation", + "score": 0.0 + }, + { + "name": "WeatherInPlace", + "score": 0.0 + } + ], + "entityPredictions": [ + { + "entityName": "Renamed Entity", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + }, + { + "entityName": "geography", + "startTokenIndex": 3, + "endTokenIndex": 3, + "phrase": "barcelona" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json new file mode 100644 index 000000000000..e0431eda30b8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityInfoRequest.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "any", + "typeId": 7, + "readableType": "Pattern.Any Entity Extractor", + "explicitList": [ + { + "id": 456, + "explicitListItem": "item 1" + }, + { + "id": 457, + "explicitListItem": "item 2" + } + ], + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json new file mode 100644 index 000000000000..71f5e66dd804 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListItemRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a", + "itemId": 76451 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": 76451, + "explicitListItem": "item 2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json new file mode 100644 index 000000000000..04ca5d9a5ea2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPatternAnyExplicitListRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": 48674, + "explicitListItem": "item 1" + }, + { + "id": 76451, + "explicitListItem": "item 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json new file mode 100644 index 000000000000..22b050172373 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetPrebuiltInfoRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "prebuiltId": "a065c863-918e-4c56-a267-9aaae3c7dced" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a065c863-918e-4c56-a267-9aaae3c7dced", + "name": "datetimeV2", + "typeId": 2, + "readableType": "Prebuilt Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json new file mode 100644 index 000000000000..675614962014 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityInfoRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "AirportCodeRegex", + "regexPattern": "[a-z]{3}", + "typeId": 8, + "readableType": "Regex Entity Extractor", + "roles": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json new file mode 100644 index 000000000000..2052c08d2652 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityRoleInfoRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "a682a962-1f92-4ae7-b8b8-398414e30c12" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "a682a962-1f92-4ae7-b8b8-398414e30c12", + "name": "role 1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json new file mode 100644 index 000000000000..503a2725e69a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulGetRegexEntityRolesRequest.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "2d3173b0-983c-43ae-92f8-6f5b5d09a11a" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 1" + }, + { + "id": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "name": "role 2" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json new file mode 100644 index 000000000000..dc5341bcfcc7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulPatchClosedListEntityModelRequest.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "closedListModelPatchObject": { + "subLists": [ + { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulRenameIntentModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulRenameIntentModelRequest.json new file mode 100644 index 000000000000..41a8e651e259 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulRenameIntentModelRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "modelUpdateObject": { + "name": "newTest" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulReplaceEntityFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulReplaceEntityFeaturesRequest.json new file mode 100644 index 000000000000..816fd7bb83d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulReplaceEntityFeaturesRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationsUpdateObject": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulReplaceIntentFeaturesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulReplaceIntentFeaturesRequest.json new file mode 100644 index 000000000000..64834fe5bd24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulReplaceIntentFeaturesRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "d7a08f1a-d276-4364-b2d5-b0235c61e37f", + "featureRelationsUpdateObject": [ + { + "featureName": "Phraselist1" + }, + { + "modelName": "None" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json new file mode 100644 index 000000000000..be1354932eff --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateClosedListEntityModelRequest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "closedListModelUpdateObject": { + "name": "States", + "subLists": [ + { + "canonicalForm": "Texas", + "list": [ + "TX", + "Texas" + ] + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateClosedListEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json new file mode 100644 index 000000000000..78be03fe4f4d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{apiKey}", + "appId": "{appId}", + "versionId": "{versionId}", + "cEntityId": "{cEntityId}", + "compositeModelUpdateObject": { + "name": "Renamed Entity" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json new file mode 100644 index 000000000000..1a460ea7216c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCompositeEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "cEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateCustomPrebuiltEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateEntityExtractorRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateEntityExtractorRequest.json new file mode 100644 index 000000000000..5a4558d9e82a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateEntityExtractorRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "entityModelUpdateObject": { + "name": "New Name", + "instanceOf": "number" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json new file mode 100644 index 000000000000..3f65e0bdc0a6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalChildModelRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "hChildId": "fe559c31-9778-42ea-ed45-94e0bd7cf767", + "hierarchicalChildModelUpdateObject": { + "name": "Location::To" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json new file mode 100644 index 000000000000..3ab3ac76e1df --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityModelRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "fe559c31-9778-42ea-ba45-94e0bd7cf767", + "modelUpdateObject": { + "name": "Reservation" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json new file mode 100644 index 000000000000..797154c47969 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateHierarchicalEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "hEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json new file mode 100644 index 000000000000..a0f7b69a69f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityExplicitListItemRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "itemId": 53435, + "item": { + "explicitListItem": "new item" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json new file mode 100644 index 000000000000..580470d46af4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRequest.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "patternAnyUpdateObject": { + "name": "New Name", + "explicitList": [ + "item1", + "item2" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePatternAnyEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdatePrebuiltEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json new file mode 100644 index 000000000000..ff26f5a7cffb --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateRegexEntityModelRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "regexEntityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "regexEntityUpdateObject": { + "name": "New Name", + "regexPattern": "[a-z]{3}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json new file mode 100644 index 000000000000..7169ee6ae797 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateRegexEntityRoleRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "roleId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "entityRoleUpdateObject": { + "name": "New Name" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateSublistRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateSublistRequest.json new file mode 100644 index 000000000000..cdb7a3de86bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/model/SuccessfulUpdateSublistRequest.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "clEntityId": "d1f95436-57ac-4524-ae81-5bdd32668ccf", + "subListId": 123, + "wordListBaseUpdateObject": { + "canonicalForm": "Texas", + "list": [ + "tx", + "texas" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json new file mode 100644 index 000000000000..57e0c9be86e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "slotName": "PRODUCTION" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json new file mode 100644 index 000000000000..57e0c9be86e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "slotName": "PRODUCTION" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulAddPatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulAddPatternRequest.json new file mode 100644 index 000000000000..663859dde70d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulAddPatternRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "pattern": { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json new file mode 100644 index 000000000000..ff74e0a38dff --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulBatchAddLabelsRequest.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "2370fb9d-7dbc-4898-a361-a742cf290766", + "versionId": "0.1", + "patterns": [ + { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + }, + { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + ] + }, + "responses": { + "201": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulDeletePatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulDeletePatternRequest.json new file mode 100644 index 000000000000..d2d9eb298075 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulDeletePatternRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulDeletePatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulDeletePatternsRequest.json new file mode 100644 index 000000000000..a6c9168abd4e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulDeletePatternsRequest.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternIds": [ + "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "2126479d-2a98-4d06-a65e-b8799df2dd53" + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json new file mode 100644 index 000000000000..269cebf9bd61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulGetIntentPatternsRequest.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "intentId": "6dbed7e2-7df6-4cd6-a225-97e6fbe4493d", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08", + "pattern": "who's reporting to {Name}?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulGetPatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulGetPatternsRequest.json new file mode 100644 index 000000000000..1829a2e8cdee --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulGetPatternsRequest.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "58077d3a-4bbb-47ba-8aa9-31c0ead0bf08", + "pattern": "who's reporting to {Name}?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulUpdatePatternRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulUpdatePatternRequest.json new file mode 100644 index 000000000000..67ccc3717e0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulUpdatePatternRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patternId": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": { + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulUpdatePatternsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulUpdatePatternsRequest.json new file mode 100644 index 000000000000..fb3997aa2024 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/patterns/SuccessfulUpdatePatternsRequest.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1", + "patterns": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "Who's {Name} reporting to?", + "intent": "report to" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + }, + { + "id": "cc8fa554-cc6c-4bcc-97eb-c8e5bc2091b3", + "pattern": "who's {Name} reporting to?", + "intent": "report to" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulAssignAzureAccountRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulAssignAzureAccountRequest.json new file mode 100644 index 000000000000..82d9f72a4578 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulAssignAzureAccountRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "azureAccountInfoObject": { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json new file mode 100644 index 000000000000..91903957a95b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "azureAccountInfoObject": { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json new file mode 100644 index 000000000000..bab6b4a286f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "Authorization": "Bearer {ARM Token}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulGetAzureAccountsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulGetAzureAccountsRequest.json new file mode 100644 index 000000000000..7f98282b81d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/stats/SuccessfulGetAzureAccountsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json new file mode 100644 index 000000000000..d89c56ce2895 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/train/SuccessfulGetApplicationVersionTrainingStatusRequest.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "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 + } + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/train/SuccessfulTrainApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/train/SuccessfulTrainApplicationVersionRequest.json new file mode 100644 index 000000000000..67484006a612 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/train/SuccessfulTrainApplicationVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", + "versionId": "0.1" + }, + "responses": { + "202": { + "headers": {}, + "body": { + "statusId": 9, + "status": "Queued" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json new file mode 100644 index 000000000000..c819676e66ff --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulCloneApplicatioVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "versionCloneObject": { + "version": "1.0" + } + }, + "responses": { + "201": { + "headers": {}, + "body": "1.0" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json new file mode 100644 index 000000000000..0fc41319fb8e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulDeleteApplicationVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json new file mode 100644 index 000000000000..0d0c02e2995e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulDeleteUnlabelledUtteranceRequest.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "utterance": "dummy text" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulExportApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulExportApplicationVersionRequest.json new file mode 100644 index 000000000000..388d2eb738e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulExportApplicationVersionRequest.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulExportLuApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulExportLuApplicationVersionRequest.json new file mode 100644 index 000000000000..dd8f887ccf3e --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulExportLuApplicationVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2", + "format": "lu" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/octet-stream" + }, + "body": "> LUIS application information\\n> !# @app.name = App\\n> !# @app.versionId = 0.2\\n> !# @app.culture = en-us\\n> !# @app.luis_schema_version = 6.0.0\\n\\n\\n> # Intent definitions\\n\\n## intent1\\n\\n\\n@ intent intent1 usesFeature phraselist1\\n\\n## None\\n- a\\n- hi {@simpleentity1=guys}\\n\\n\\n@ intent None usesFeature phraselist1\\n\\n> # Entity definitions\\n\\n@ ml simpleentity1 usesFeature phraselist1\\n\\n\\n> # PREBUILT Entity definitions\\n\\n@ prebuilt datetimeV2\\n\\n\\n> # Phrase list definitions\\n\\n@ phraselist phraselist1(interchangeable) = \\n\t- why,where,when,what,how,who\\n\\n\\n> # List entities\\n\\n@ list closedlist = \\n\t- a :\\n\t\t- b\\n\t\t- c\\n\t\t- d\\n\\n\\n> # RegEx entities\"" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json new file mode 100644 index 000000000000..5b0ad8dbf9ad --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionInfoRequest.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "version": "0.1", + "createdDateTime": "2017-08-01T14:34:15Z", + "lastModifiedDateTime": "2017-11-28T20:12:09Z", + "lastTrainedDateTime": "2017-11-28T20:12:12Z", + "lastPublishedDateTime": "2017-11-28T20:12:35Z", + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v3.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e", + "assignedEndpointKey": { + "SubscriptionKey": "", + "SubscriptionRegion": "westus", + "SubscriptionName": "" + }, + "externalApiKeys": {}, + "intentsCount": 4, + "entitiesCount": 0, + "endpointHitsCount": 175, + "trainingStatus": "Trained" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json new file mode 100644 index 000000000000..c1afa5393351 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionSettingsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "name": "UseAllTrainingData", + "value": "false" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json new file mode 100644 index 000000000000..1880948bc243 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "skip": 0, + "take": 100 + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "version": "0.1", + "createdDateTime": "2017-08-01T14:34:15Z", + "lastModifiedDateTime": "2017-11-28T20:12:09Z", + "lastTrainedDateTime": "2017-11-28T20:12:12Z", + "lastPublishedDateTime": "2017-11-28T20:12:35Z", + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v3.0/apps/363187f1-c573-46b3-bc4c-ae01d686e68e", + "assignedEndpointKey": { + "SubscriptionKey": "", + "SubscriptionRegion": "westus", + "SubscriptionName": "" + }, + "externalApiKeys": {}, + "intentsCount": 4, + "entitiesCount": 0, + "endpointHitsCount": 175, + "trainingStatus": "Trained" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportApplicationVersionRequest.json new file mode 100644 index 000000000000..c211f270d075 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportApplicationVersionRequest.json @@ -0,0 +1,308 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2", + "luisApp": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2" + }, + "body": "0.2" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportLuApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportLuApplicationVersionRequest.json new file mode 100644 index 000000000000..0072e80ed5a5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportLuApplicationVersionRequest.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2", + "luisAppLu": "> LUIS application information\r\n> !# @app.name = Json 600 App\r\n> !# @app.desc = Json 600 App\r\n> !# @app.versionId = 0.1\r\n> !# @app.culture = en-us\r\n> !# @app.luis_schema_version = 6.0.0\r\n\r\n\r\n> # Intent definitions\r\n\r\n> !# @intent.inherits = name : Calendar.AcceptEventEntry; domain_name : Calendar; model_name : AcceptEventEntry\r\n\r\n## Calendar.AcceptEventEntry\r\n- save the date may 17 {@Calendar.Subject=pictures party}\r\n- schedule {@Calendar.Subject=appointment} for tomorrow please\r\n- {@Calendar.Subject=Meeting My Manager}\r\n- The meeting will last for one hour\r\n- Add an event to visit 209 Nashville Gym\r\n- Add {@Calendar.Subject=imax theater} to my upcoming events\r\n- dunmore pa sonic sounds Friday morning please\r\n- Add a new task {@Calendar.Subject=finish assignment}\r\n- Add a new event on 27 - Apr\r\n- calendar i ' ll be at the garage from 8 till 3 this saturday\r\n- Add an event to {@Calendar.Subject=read about adam lambert news}\r\n\r\n\r\n> !# @intent.inherits = name : Communication.AddContact; domain_name : Communication; model_name : AddContact\r\n\r\n## Communication.AddContact\r\n\r\n\r\n@ intent Communication.AddContact usesFeatures simpleentity1,phraselist1\r\n\r\n> !# @intent.inherits = name : Communication.AddMore; domain_name : Communication; model_name : AddMore\r\n\r\n## Communication.AddMore\r\n\r\n\r\n> !# @intent.inherits = name : Communication.Confirm; domain_name : Communication; model_name : Confirm\r\n\r\n## Communication.Confirm\r\n\r\n\r\n## intent1\r\n\r\n\r\n## None\r\n- a\r\n- hi {@simpleentity1=guys}\r\n- Please just delete {@Calendar.Subject=my meeting}\r\n- Extend {@Calendar.Subject=lunch meeting} 30 minutes extra\r\n- {@Calendar.Subject=Marketing meetings} on Tuesdays will now be every Wednesday please change on my calendar\r\n- {@Calendar.Subject=Appointment with Johnson} needs to be next week\r\n- Search for {@Calendar.Subject=meetings with Chris}\r\n- I want to reschedule the {@Calendar.Subject=meeting at the air force club}\r\n- Move the {@Calendar.Subject=BBQ party} to Friday\r\n- Am i free to {@Calendar.Subject=be with friends} saturday ?\r\n- Delete {@Calendar.Subject=Helen Fred ' s birthday}\r\n- {@Calendar.Subject=Call dad Mike}\r\n- {@Calendar.Subject=The workshop} will last for 10 hours\r\n- {@Calendar.Subject=email cloney John}\r\n- Change {@Calendar.Subject=the meeting with Chris} to 9 : 00 am\r\n\r\n\r\n> # Entity definitions\r\n\r\n> !# @entity.inherits = name : Calendar.Subject; domain_name : Calendar; model_name : Subject\r\n\r\n@ ml Calendar.Subject usesFeatures simpleentity1\r\n\r\n@ ml simpleentity1\r\n\r\n@ ml a1 hasRole role_a1\r\n - @ datetimeV2 b1\r\n - @ ml c1\r\n - @ ml d1 usesFeatures phraselist1\r\n - @ datetimeV2 e1 usesFeatures phraselist1\r\n\r\n\r\n\r\n> # PREBUILT Entity definitions\r\n\r\n@ prebuilt age\r\n\r\n@ prebuilt datetimeV2\r\n\r\n\r\n> # Phrase list definitions\r\n\r\n@ phraselist phraselist1(interchangeable) = \r\n\t- why,where,when,what,how,who\r\n\r\n\r\n> # List entities\r\n\r\n@ list closedlist = \r\n\t- a :\r\n\t\t- b\r\n\t\t- c\r\n\t\t- d\r\n\r\n\r\n> # RegEx entities\r\n\r\n\r\n> # Composite entities\r\n\r\n@ composite compositeentity1 usesFeatures simpleentity1,Calendar.Subject = [simpleentity1, datetimeV2]\r\n" + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2" + }, + "body": "0.2" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportV2ApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportV2ApplicationVersionRequest.json new file mode 100644 index 000000000000..38d4e2bdcb35 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulImportV2ApplicationVersionRequest.json @@ -0,0 +1,308 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "bd72e8d7-62b8-48f5-9dcb-e3b0588b803a", + "versionId": "0.2", + "luisAppV2": { + "luis_schema_version": "3.0.0", + "versionId": "0.1", + "name": "LuisBot", + "desc": "", + "culture": "en-us", + "intents": [ + { + "name": "HomeAutomation.TurnOff", + "inherits": { + "domain_name": "HomeAutomation", + "model_name": "TurnOff" + } + }, + { + "name": "dateintent" + }, + { + "name": "Help" + }, + { + "name": "None" + }, + { + "name": "SearchHotels" + }, + { + "name": "ShowHotelsReviews" + } + ], + "entities": [ + { + "name": "AirportCode", + "roles": [ + "destination" + ] + }, + { + "name": "Hotel", + "roles": [] + } + ], + "composites": [], + "closedLists": [], + "patternAnyEntities": [ + { + "name": "patternAny1", + "explicitList": [], + "roles": [ + "role1", + "role2" + ] + } + ], + "regex_entities": [ + { + "name": "regex1", + "regexPattern": "[^a]+", + "roles": [ + "regex role" + ] + } + ], + "prebuiltEntities": [ + { + "name": "datetimeV2", + "roles": [ + "datetime role" + ] + } + ], + "model_features": [ + { + "name": "Near", + "mode": true, + "words": "near,around,close,nearby", + "activated": true + }, + { + "name": "Show", + "mode": true, + "words": "show,find,look,search", + "activated": true + } + ], + "regex_features": [ + { + "name": "AirportCodeRegex", + "pattern": "[a-z]{3}", + "activated": true + } + ], + "patterns": [ + { + "pattern": "this is [a test] {patternAny1:role1}", + "intent": "Help" + } + ], + "utterances": [ + { + "text": "i need help", + "intent": "Help", + "entities": [] + }, + { + "text": "help me", + "intent": "Help", + "entities": [] + }, + { + "text": "tomorrow", + "intent": "dateintent", + "entities": [] + }, + { + "text": "search for hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "what can i do?", + "intent": "Help", + "entities": [] + }, + { + "text": "next monday", + "intent": "dateintent", + "entities": [] + }, + { + "text": "next year", + "intent": "dateintent", + "entities": [] + }, + { + "text": "look for hotels in miami", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me hotels in california", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "show me the reviews of the amazing bot resort", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 23, + "endPos": 44 + } + ] + }, + { + "text": "can i see the reviews of extended bot hotel?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 25, + "endPos": 42 + } + ] + }, + { + "text": "find reviews of hotelxya", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 16, + "endPos": 23 + } + ] + }, + { + "text": "show me reviews of the amazing hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 19, + "endPos": 35 + } + ] + }, + { + "text": "what are the available options?", + "intent": "Help", + "entities": [] + }, + { + "text": "best hotels in seattle", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "hotels in los angeles", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me hotels from los angeles?", + "intent": "SearchHotels", + "entities": [] + }, + { + "text": "can you show me the reviews of the amazing resort & hotel", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 31, + "endPos": 56 + } + ] + }, + { + "text": "what are the reviews of the hotel bot framework?", + "intent": "ShowHotelsReviews", + "entities": [ + { + "entity": "Hotel", + "startPos": 24, + "endPos": 46 + } + ] + }, + { + "text": "find hotels near eze", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "where can i stay near nnn?", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 22, + "endPos": 24 + } + ] + }, + { + "text": "show hotels near att airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels near agl", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 17, + "endPos": 19 + } + ] + }, + { + "text": "find hotels around eze airport", + "intent": "SearchHotels", + "entities": [ + { + "entity": "AirportCode", + "startPos": 19, + "endPos": 21 + } + ] + }, + { + "text": "01/7", + "intent": "dateintent", + "entities": [] + } + ] + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://westus.api.cognitive.microsoft.com/luis/api/v3.0/bd72e8d7-62b8-48f5-9dcb-e3b0588b803a/versions/0.2" + }, + "body": "0.2" + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json new file mode 100644 index 000000000000..27f8a7a8e279 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulRenameApplicationVersionRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "versionUpdateObject": { + "version": "1.0" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json new file mode 100644 index 000000000000..e6e76349b17f --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v3.0/examples/versions/SuccessfulUpdateApplicationVersionSettingsRequest.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "listOfAppVersionSettingObject": [ + { + "name": "UseAllTrainingData", + "value": "false" + } + ] + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +}