Examples class

Package:

@azure/cognitiveservices-luis-authoring

Class representing a Examples.

Constructors

Examples(LUISAuthoringClientContext)

Create a Examples.

Methods

add(string, string, ExampleLabelObject, ExamplesAddOptionalParams)	Adds a labeled example utterance in a version of the application.
add(string, string, ExampleLabelObject, ExamplesAddOptionalParams, ServiceCallback<LabelExampleResponse>)
add(string, string, ExampleLabelObject, ServiceCallback<LabelExampleResponse>)
batch(string, string, ExampleLabelObject[], ExamplesBatchOptionalParams)	Adds a batch of labeled example utterances to a version of the application.
batch(string, string, ExampleLabelObject[], ExamplesBatchOptionalParams, ServiceCallback<BatchLabelExample[]>)
batch(string, string, ExampleLabelObject[], ServiceCallback<BatchLabelExample[]>)
deleteMethod(string, string, number, RequestOptionsBase)	Deletes the labeled example utterances with the specified ID from a version of the application.
deleteMethod(string, string, number, RequestOptionsBase, ServiceCallback<OperationStatus>)
deleteMethod(string, string, number, ServiceCallback<OperationStatus>)
list(string, string, ExamplesListOptionalParams)	Returns example utterances to be reviewed from a version of the application.
list(string, string, ExamplesListOptionalParams, ServiceCallback<LabeledUtterance[]>)
list(string, string, ServiceCallback<LabeledUtterance[]>)

Constructor Details

Examples(LUISAuthoringClientContext)

Create a Examples.

new Examples(client: LUISAuthoringClientContext)

Parameters

client

LUISAuthoringClientContext

Reference to the service client.

Method Details

add(string, string, ExampleLabelObject, ExamplesAddOptionalParams)

Adds a labeled example utterance in a version of the application.

function add(appId: string, versionId: string, exampleLabelObject: ExampleLabelObject, options?: ExamplesAddOptionalParams): Promise<ExamplesAddResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleLabelObject

ExampleLabelObject

A labeled example utterance with the expected intent and entities.

options

ExamplesAddOptionalParams

The optional parameters

Returns

Promise<ExamplesAddResponse>

Promise<Models.ExamplesAddResponse>

add(string, string, ExampleLabelObject, ExamplesAddOptionalParams, ServiceCallback<LabelExampleResponse>)

function add(appId: string, versionId: string, exampleLabelObject: ExampleLabelObject, options: ExamplesAddOptionalParams, callback: ServiceCallback<LabelExampleResponse>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleLabelObject

ExampleLabelObject

A labeled example utterance with the expected intent and entities.

options

ExamplesAddOptionalParams

The optional parameters

callback

ServiceCallback<LabelExampleResponse>

The callback

add(string, string, ExampleLabelObject, ServiceCallback<LabelExampleResponse>)

function add(appId: string, versionId: string, exampleLabelObject: ExampleLabelObject, callback: ServiceCallback<LabelExampleResponse>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleLabelObject

ExampleLabelObject

A labeled example utterance with the expected intent and entities.

callback

ServiceCallback<LabelExampleResponse>

The callback

batch(string, string, ExampleLabelObject[], ExamplesBatchOptionalParams)

Adds a batch of labeled example utterances to a version of the application.

function batch(appId: string, versionId: string, exampleLabelObjectArray: ExampleLabelObject[], options?: ExamplesBatchOptionalParams): Promise<ExamplesBatchResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleLabelObjectArray

ExampleLabelObject[]

Array of example utterances.

options

ExamplesBatchOptionalParams

The optional parameters

Returns

Promise<ExamplesBatchResponse>

Promise<Models.ExamplesBatchResponse>

batch(string, string, ExampleLabelObject[], ExamplesBatchOptionalParams, ServiceCallback<BatchLabelExample[]>)

function batch(appId: string, versionId: string, exampleLabelObjectArray: ExampleLabelObject[], options: ExamplesBatchOptionalParams, callback: ServiceCallback<BatchLabelExample[]>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleLabelObjectArray

ExampleLabelObject[]

Array of example utterances.

options

ExamplesBatchOptionalParams

The optional parameters

callback

ServiceCallback<BatchLabelExample[]>

The callback

batch(string, string, ExampleLabelObject[], ServiceCallback<BatchLabelExample[]>)

function batch(appId: string, versionId: string, exampleLabelObjectArray: ExampleLabelObject[], callback: ServiceCallback<BatchLabelExample[]>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleLabelObjectArray

ExampleLabelObject[]

Array of example utterances.

callback

ServiceCallback<BatchLabelExample[]>

The callback

deleteMethod(string, string, number, RequestOptionsBase)

Deletes the labeled example utterances with the specified ID from a version of the application.

function deleteMethod(appId: string, versionId: string, exampleId: number, options?: RequestOptionsBase): Promise<ExamplesDeleteMethodResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleId

number

The example ID.

options

RequestOptionsBase

The optional parameters

Returns

Promise<ExamplesDeleteMethodResponse>

Promise<Models.ExamplesDeleteMethodResponse>

deleteMethod(string, string, number, RequestOptionsBase, ServiceCallback<OperationStatus>)

function deleteMethod(appId: string, versionId: string, exampleId: number, options: RequestOptionsBase, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleId

number

The example ID.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<OperationStatus>

The callback

deleteMethod(string, string, number, ServiceCallback<OperationStatus>)

function deleteMethod(appId: string, versionId: string, exampleId: number, callback: ServiceCallback<OperationStatus>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

exampleId

number

The example ID.

callback

ServiceCallback<OperationStatus>

The callback

list(string, string, ExamplesListOptionalParams)

Returns example utterances to be reviewed from a version of the application.

function list(appId: string, versionId: string, options?: ExamplesListOptionalParams): Promise<ExamplesListResponse>

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options

ExamplesListOptionalParams

The optional parameters

Returns

Promise<ExamplesListResponse>

Promise<Models.ExamplesListResponse>

list(string, string, ExamplesListOptionalParams, ServiceCallback<LabeledUtterance[]>)

function list(appId: string, versionId: string, options: ExamplesListOptionalParams, callback: ServiceCallback<LabeledUtterance[]>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

options

ExamplesListOptionalParams

The optional parameters

callback

ServiceCallback<LabeledUtterance[]>

The callback

list(string, string, ServiceCallback<LabeledUtterance[]>)

function list(appId: string, versionId: string, callback: ServiceCallback<LabeledUtterance[]>)

Parameters

appId

string

The application ID.

versionId

string

The version ID.

callback

ServiceCallback<LabeledUtterance[]>

The callback