Examples Interface

Package:

com.microsoft.azure.cognitiveservices.language.luis.authoring

public interface Examples

An instance of this class provides access to all the operations defined in Examples.

Method Summary

Modifier and Type	Method and Description
ExamplesAddDefinitionStages.WithAppId	add() Adds a labeled example utterance in a version of the application.
LabelExampleResponse	add(UUID appId, String versionId, ExampleLabelObject exampleLabelObject, AddExamplesOptionalParameter addOptionalParameter) Adds a labeled example utterance in a version of the application.
Observable<LabelExampleResponse>	addAsync(UUID appId, String versionId, ExampleLabelObject exampleLabelObject, AddExamplesOptionalParameter addOptionalParameter) Adds a labeled example utterance in a version of the application.
ExamplesBatchDefinitionStages.WithAppId	batch() Adds a batch of labeled example utterances to a version of the application.
List<BatchLabelExample>	batch(UUID appId, String versionId, List<ExampleLabelObject> exampleLabelObjectArray, BatchOptionalParameter batchOptionalParameter) Adds a batch of labeled example utterances to a version of the application.
Observable<List<BatchLabelExample>>	batchAsync(UUID appId, String versionId, List<ExampleLabelObject> exampleLabelObjectArray, BatchOptionalParameter batchOptionalParameter) Adds a batch of labeled example utterances to a version of the application.
OperationStatus	delete(UUID appId, String versionId, int exampleId) Deletes the labeled example utterances with the specified ID from a version of the application.
Observable<OperationStatus>	deleteAsync(UUID appId, String versionId, int exampleId) Deletes the labeled example utterances with the specified ID from a version of the application.
ExamplesListDefinitionStages.WithAppId	list() Returns example utterances to be reviewed from a version of the application.
List<LabeledUtterance>	list(UUID appId, String versionId, ListExamplesOptionalParameter listOptionalParameter) Returns example utterances to be reviewed from a version of the application.
Observable<List<LabeledUtterance>>	listAsync(UUID appId, String versionId, ListExamplesOptionalParameter listOptionalParameter) Returns example utterances to be reviewed from a version of the application.

Method Details

add

public ExamplesAddDefinitionStages.WithAppId add()

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

Returns:

the first stage of the add call

add

public LabelExampleResponse add(UUID appId, String versionId, ExampleLabelObject exampleLabelObject, AddExamplesOptionalParameter addOptionalParameter)

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

Parameters:

appId - The application ID.

versionId - The version ID.

exampleLabelObject - A labeled example utterance with the expected intent and entities.

addOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the LabelExampleResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addAsync

public Observable addAsync(UUID appId, String versionId, ExampleLabelObject exampleLabelObject, AddExamplesOptionalParameter addOptionalParameter)

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

Parameters:

appId - The application ID.

versionId - The version ID.

exampleLabelObject - A labeled example utterance with the expected intent and entities.

addOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the LabelExampleResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

batch

public ExamplesBatchDefinitionStages.WithAppId batch()

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

Returns:

the first stage of the batch call

batch

public List batch(UUID appId, String versionId, List exampleLabelObjectArray, BatchOptionalParameter batchOptionalParameter)

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

Parameters:

appId - The application ID.

versionId - The version ID.

exampleLabelObjectArray - Array of example utterances.

batchOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<BatchLabelExample> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

batchAsync

public Observable> batchAsync(UUID appId, String versionId, List exampleLabelObjectArray, BatchOptionalParameter batchOptionalParameter)

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

Parameters:

appId - The application ID.

versionId - The version ID.

exampleLabelObjectArray - Array of example utterances.

batchOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<BatchLabelExample> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public OperationStatus delete(UUID appId, String versionId, int exampleId)

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

Parameters:

appId - The application ID.

versionId - The version ID.

exampleId - The example ID.

Returns:

the OperationStatus object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(UUID appId, String versionId, int exampleId)

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

Parameters:

appId - The application ID.

versionId - The version ID.

exampleId - The example ID.

Returns:

the observable to the OperationStatus object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public ExamplesListDefinitionStages.WithAppId list()

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

Returns:

the first stage of the list call

list

public List list(UUID appId, String versionId, ListExamplesOptionalParameter listOptionalParameter)

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

Parameters:

appId - The application ID.

versionId - The version ID.

listOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the List<LabeledUtterance> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable> listAsync(UUID appId, String versionId, ListExamplesOptionalParameter listOptionalParameter)

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

Parameters:

appId - The application ID.

versionId - The version ID.

listOptionalParameter - the object representing the optional parameters to be set before calling this API

Returns:

the observable to the List<LabeledUtterance> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation