Skip to content

luis authoring api updates for nested children and required features #9405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmazuel merged 5 commits into from
May 14, 2020
Merged

luis authoring api updates for nested children and required features #9405

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8522fed
luis authoring api updates for nested children and required features
May 10, 2020
f77a4f2
fix examples
May 11, 2020
e68f951
change required field "enableNestedChildren" to optional
May 12, 2020
c34790f
add default value for enableNestedChildren
May 12, 2020
4848d42
remove deprecated permissions API
May 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 87 additions & 162 deletions specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,9 @@
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/EnableNestedChildren"
},
{
"name": "exampleLabelObject",
"in": "body",
Expand Down Expand Up @@ -351,6 +354,9 @@
{
"$ref": "#/parameters/VersionIdInPath"
},
{
"$ref": "#/parameters/EnableNestedChildren"
},
{
"name": "exampleLabelObjectArray",
"in": "body",
Expand Down Expand Up @@ -408,6 +414,9 @@
},
{
"$ref": "#/parameters/TakeInPath"
},
{
"$ref": "#/parameters/EnableNestedChildren"
}
],
"responses": {
Expand Down Expand Up @@ -2342,6 +2351,9 @@
},
{
"$ref": "#/parameters/TakeInPath"
},
{
"$ref": "#/parameters/EnableNestedChildren"
}
],
"responses": {
Expand Down Expand Up @@ -2389,6 +2401,9 @@
},
{
"$ref": "#/parameters/TakeInPath"
},
{
"$ref": "#/parameters/EnableNestedChildren"
}
],
"responses": {
Expand Down Expand Up @@ -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.",
Expand Down Expand Up @@ -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": []
}
]
}
}
},
Expand Down Expand Up @@ -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": []
}
]
}
}
},
Expand Down Expand Up @@ -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": [
Expand Down Expand Up @@ -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"
}
]
}
}
},
Expand Down Expand Up @@ -10604,6 +10518,9 @@
"featureName": {
"type": "string",
"description": "The name of the feature used."
},
"isRequired": {
"type": "boolean"
}
}
},
Expand Down Expand Up @@ -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"
}
}
}
1 change: 1 addition & 0 deletions ...s/data-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulAddLabelRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions ...-plane/LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulBatchAddLabelsRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?",
Expand Down
3 changes: 2 additions & 1 deletion ...LUIS/Authoring/preview/v3.0/examples/examples/SuccessfulReviewLabeledExamplesRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
3 changes: 2 additions & 1 deletion ...ane/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetEntitySuggestionExamples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
3 changes: 2 additions & 1 deletion ...ne/LUIS/Authoring/preview/v3.0/examples/model/SuccessfulGetIntentsSuggestionExamples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
19 changes: 0 additions & 19 deletions ...UIS/Authoring/preview/v3.0/examples/permissions/SuccessfulAddUserToAccessListRequest.json
View file
Open in desktop

This file was deleted.

Loading