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

Interface Examples

All Known Implementing Classes:

ExamplesImpl

public interface Examples

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Examples.ExamplesAddDefinition	The entirety of add definition.
static interface	Examples.ExamplesAddDefinitionStages	Grouping of add definition stages.
static interface	Examples.ExamplesBatchDefinition	The entirety of batch definition.
static interface	Examples.ExamplesBatchDefinitionStages	Grouping of batch definition stages.
static interface	Examples.ExamplesListDefinition	The entirety of list definition.
static interface	Examples.ExamplesListDefinitionStages	Grouping of list definition stages.

Method Summary

Modifier and Type	Method	Description
Examples.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.
rx.Observable<LabelExampleResponse>	addAsync(UUID appId, String versionId, ExampleLabelObject exampleLabelObject, AddExamplesOptionalParameter addOptionalParameter)	Adds a labeled example utterance in a version of the application.
Examples.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.
rx.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.
rx.Observable<OperationStatus>	deleteAsync(UUID appId, String versionId, int exampleId)	Deletes the labeled example utterances with the specified ID from a version of the application.
Examples.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.
rx.Observable<List<LabeledUtterance>>	listAsync(UUID appId, String versionId, ListExamplesOptionalParameter listOptionalParameter)	Returns example utterances to be reviewed from a version of the application.

Method Detail

add

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

rx.Observable<LabelExampleResponse> 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

add

Examples.ExamplesAddDefinitionStages.WithAppId add()

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

Returns:

the first stage of the add call

batch

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.

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

rx.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.

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

batch

Examples.ExamplesBatchDefinitionStages.WithAppId batch()

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

Returns:

the first stage of the batch call

list

List<LabeledUtterance> 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

rx.Observable<List<LabeledUtterance>> 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

list

Examples.ExamplesListDefinitionStages.WithAppId list()

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

Returns:

the first stage of the list call

delete

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

rx.Observable<OperationStatus> 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