Model - Examples

Reference

Service:: Azure AI Services

API Version:: 3.0-preview

Gets the example utterances for the given intent or entity model in a version of the application.

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/models/{modelId}/examples

With optional parameters:

GET {Endpoint}/luis/authoring/v3.0-preview/apps/{appId}/versions/{versionId}/models/{modelId}/examples?skip={skip}&take={take}

URI Parameters

Name	In	Required	Type	Description
appId	path	True	string uuid	The application ID.
Endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
modelId	path	True	string	The ID (GUID) of the model.
versionId	path	True	string	The version ID.
skip	query		integer	The number of entries to skip. Default value is 0.
take	query		integer	The number of entries to return. Maximum page size is 500. Default is 100.

Request Header

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

Responses

Name	Type	Description
200 OK	LabelTextObject[]	A list of example utterances for the model.
Other Status Codes	ErrorResponse	Error Response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Get Examples Per Model Request

Sample request

HTTP

GET {Endpoint}/luis/authoring/v3.0-preview/apps/86226c53-b7a6-416f-876b-226b2b5ab07b/versions/0.1/models/e4770e43-233a-48ad-a1fa-54f4f97eff9f/examples

Sample response

Status code:: 200

[
  {
    "id": 10002,
    "text": "Lorem ipsum dolor sit amet"
  },
  {
    "id": 10003,
    "text": "consectetur adipiscing elit"
  },
  {
    "id": 10004,
    "text": "sed do eiusmod tempor incididunt"
  }
]

Definitions

Name	Description
ErrorResponse	Error response when invoking an operation on the API.
LabelTextObject	An object containing the example utterance's text.

ErrorResponse

Error response when invoking an operation on the API.

Name	Type	Description
errorType	string

LabelTextObject

An object containing the example utterance's text.

Name	Type	Description
id	integer	The ID of the Label.
text	string	The text of the label.

Dela via