diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json index a7335b87f6b5..02fe2bdb6ec7 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json @@ -303,6 +303,9 @@ { "$ref": "#/parameters/VersionIdInPath" }, + { + "$ref": "#/parameters/EnableNestedChildren" + }, { "name": "exampleLabelObject", "in": "body", @@ -351,6 +354,9 @@ { "$ref": "#/parameters/VersionIdInPath" }, + { + "$ref": "#/parameters/EnableNestedChildren" + }, { "name": "exampleLabelObjectArray", "in": "body", @@ -408,6 +414,9 @@ }, { "$ref": "#/parameters/TakeInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" } ], "responses": { @@ -2342,6 +2351,9 @@ }, { "$ref": "#/parameters/TakeInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" } ], "responses": { @@ -2389,6 +2401,9 @@ }, { "$ref": "#/parameters/TakeInPath" + }, + { + "$ref": "#/parameters/EnableNestedChildren" } ], "responses": { @@ -3413,168 +3428,6 @@ } } }, - "/apps/{appId}/permissions": { - "get": { - "description": "Gets the list of user emails that have permissions to access your application.", - "operationId": "Permissions_List", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - } - ], - "responses": { - "200": { - "description": "The list includes a single owner. All collaborators are listed in the emails array.", - "schema": { - "$ref": "#/definitions/UserAccessList" - } - }, - "default": { - "description": "Error Response.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "produces": [ - "application/json" - ], - "x-ms-examples": { - "Successful Get Application User Access List": { - "$ref": "./examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json" - } - } - }, - "post": { - "description": "Adds a user to the allowed list of users to access this LUIS application. Users are added using their email address.", - "operationId": "Permissions_Add", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "userToAdd", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UserCollaborator" - }, - "description": "A model containing the user's email address." - } - ], - "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 User To Access List": { - "$ref": "./examples/permissions/SuccessfulAddUserToAccessListRequest.json" - } - } - }, - "delete": { - "description": "Removes a user from the allowed list of users to access this LUIS application. Users are removed using their email address.", - "operationId": "Permissions_Delete", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "userToDelete", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/UserCollaborator" - }, - "description": "A model containing the user's email address." - } - ], - "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 Remove User From Access List": { - "$ref": "./examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json" - } - } - }, - "put": { - "description": "Replaces the current user access list with the new list sent in the body. If an empty list is sent, all access to other users will be removed.", - "operationId": "Permissions_Update", - "parameters": [ - { - "$ref": "#/parameters/AppIdInPath" - }, - { - "name": "collaborators", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/CollaboratorsArray" - }, - "description": "A model containing a list of user email addresses." - } - ], - "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 Replaces Users From Access List": { - "$ref": "./examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json" - } - } - } - }, "/apps/{appId}/endpoints": { "get": { "description": "Returns the available endpoint deployment regions and URLs.", @@ -8149,6 +8002,22 @@ "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": [] + } + ] } } }, @@ -8319,6 +8188,21 @@ "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": [] + } + ] } } }, @@ -9278,6 +9162,21 @@ "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": [ @@ -9325,6 +9224,21 @@ "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" + } + ] } } }, @@ -10604,6 +10518,9 @@ "featureName": { "type": "string", "description": "The name of the feature used." + }, + "isRequired": { + "type": "boolean" } } }, @@ -10847,6 +10764,14 @@ "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/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json index 9a7220daa4e3..5512edd005fc 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json @@ -4,6 +4,7 @@ "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", diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json index bc2a357b807a..516369be8a7c 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json @@ -4,6 +4,7 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "2370fb9d-7dbc-4898-a361-a742cf290766", "versionId": "0.1", + "enableNestedChildren": false, "exampleLabelObjectArray": [ { "text": "whats the weather in seattle?", diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json index a0a43d373b31..49071d052202 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json @@ -3,7 +3,8 @@ "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", - "versionId": "0.1" + "versionId": "0.1", + "enableNestedChildren": false }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json index 0c103cc44e24..f6605ccf44e3 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json @@ -4,7 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + "entityId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "enableNestedChildren": false }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json index a0cd5f3a1bbc..260784bda5d1 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json @@ -4,7 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73" + "intentId": "3d73462d-98f0-4dcd-8d30-fab9e65f2e73", + "enableNestedChildren": false }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json deleted file mode 100644 index 868818ea0bda..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "userToAdd": { - "email": "guest@outlook.com" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "code": "Success", - "message": "Operation Successful" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json deleted file mode 100644 index bca79c6b986c..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulGetApplicationUserAccessListRequest.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "owner": "owner@email.com", - "emails": [ - "yourname@outlook.com" - ] - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json deleted file mode 100644 index e07a94cd0393..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulRemoveUserFromAccessListRequest.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "userToDelete": { - "email": "guest@outlook.com" - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "code": "Success", - "message": "Operation Successful" - } - } - } -} diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json deleted file mode 100644 index 34444826b73b..000000000000 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/examples/permissions/SuccessfulReplacesUsersFromAccessListRequest.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "collaborators": { - "emails": [ - "guest@outlook.com", - "invited.user@live.com" - ] - } - }, - "responses": { - "200": { - "headers": {}, - "body": { - "code": "Success", - "message": "Operation Successful" - } - } - } -}