Share via

Model - Add Sub List

Service:
Azure AI Services
API Version:
3.0-preview

Adds a sublist to an existing list entity in a version of the application.

POST {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/closedlists/{clEntityId}/sublists

URI Parameters

Name In Required Type Description
appId
 path True

string (uuid)

The application ID.
clEntityId
 path True

string (uuid)

The list entity extractor ID.
Endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
versionId
 path True

string

The version ID.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
canonicalForm

string

The standard form that the list represents.
list

string[]

List of synonym words.

Responses

Name Type Description
201 Created

integer

The ID of the newly created sublist.
Other Status Codes

ErrorResponse

Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Add Sublist request

Sample request

POST {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/d1f95436-57ac-4524-ae81-5bdd32668ccf/sublists


{
  "canonicalForm": "Texas",
  "list": [
    "tx",
    "texas"
  ]
}

Sample response

Status code:
201 
Location: https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/closedlists/28027e3b-8356-4cdf-b395-24afb94e9469/sublists/6134877
6134877

Definitions

Name Description
ErrorResponse

Error response when invoking an operation on the API.
WordListObject

Sublist of items for a list entity.

ErrorResponse

Object

Error response when invoking an operation on the API.

Name Type Description
errorType

string

WordListObject

Object

Sublist of items for a list entity.

Name Type Description
canonicalForm

string

The standard form that the list represents.
list

string[]

List of synonym words.