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

Class ExamplesImpl

  • All Implemented Interfaces:
    Examples
    public class ExamplesImpl
extends Object
implements Examples
    An instance of this class provides access to all the operations defined in Examples.

    • Constructor Detail

      • ExamplesImpl

        public ExamplesImpl​(retrofit2.Retrofit retrofit,
                    LUISAuthoringClientImpl client)
        Initializes an instance of ExamplesImpl.
        Parameters:
        retrofit - the Retrofit instance built from a Retrofit Builder.
        client - the instance of the service client containing this operation class.

    • Method Detail

      • add

        public LabelExampleResponse add​(UUID appId,
                                String versionId,
                                ExampleLabelObject exampleLabelObject,
                                AddExamplesOptionalParameter addOptionalParameter)
        Adds a labeled example utterance in a version of the application.
        Specified by:
        add in interface Examples
        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 com.microsoft.rest.ServiceFuture<LabelExampleResponse> addAsync​(UUID appId,
                                                                       String versionId,
                                                                       ExampleLabelObject exampleLabelObject,
                                                                       AddExamplesOptionalParameter addOptionalParameter,
                                                                       com.microsoft.rest.ServiceCallback<LabelExampleResponse> serviceCallback)
        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
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • addAsync

        public rx.Observable<LabelExampleResponse> addAsync​(UUID appId,
                                                    String versionId,
                                                    ExampleLabelObject exampleLabelObject,
                                                    AddExamplesOptionalParameter addOptionalParameter)
        Adds a labeled example utterance in a version of the application.
        Specified by:
        addAsync in interface Examples
        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

      • addWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<LabelExampleResponse>> addWithServiceResponseAsync​(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

      • addWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<LabelExampleResponse>> addWithServiceResponseAsync​(UUID appId,
                                                                                                           String versionId,
                                                                                                           ExampleLabelObject exampleLabelObject,
                                                                                                           Boolean enableNestedChildren)
        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.
        enableNestedChildren - Toggles nested/flat format
        Returns:
        the observable to the LabelExampleResponse object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • add

        public com.microsoft.azure.cognitiveservices.language.luis.authoring.implementation.ExamplesImpl.ExamplesAddParameters add()
        Description copied from interface: Examples
        Adds a labeled example utterance in a version of the application.
        Specified by:
        add in interface Examples
        Returns:
        the first stage of the add call

      • batch

        public 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.
        Specified by:
        batch in interface Examples
        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 com.microsoft.rest.ServiceFuture<List<BatchLabelExample>> batchAsync​(UUID appId,
                                                                            String versionId,
                                                                            List<ExampleLabelObject> exampleLabelObjectArray,
                                                                            BatchOptionalParameter batchOptionalParameter,
                                                                            com.microsoft.rest.ServiceCallback<List<BatchLabelExample>> serviceCallback)
        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
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • batchAsync

        public 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.
        Specified by:
        batchAsync in interface Examples
        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

      • batchWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<List<BatchLabelExample>>> batchWithServiceResponseAsync​(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

      • batchWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<List<BatchLabelExample>>> batchWithServiceResponseAsync​(UUID appId,
                                                                                                                String versionId,
                                                                                                                List<ExampleLabelObject> exampleLabelObjectArray,
                                                                                                                Boolean enableNestedChildren)
        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.
        enableNestedChildren - Toggles nested/flat format
        Returns:
        the observable to the List<BatchLabelExample> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • batch

        public com.microsoft.azure.cognitiveservices.language.luis.authoring.implementation.ExamplesImpl.ExamplesBatchParameters batch()
        Description copied from interface: Examples
        Adds a batch of labeled example utterances to a version of the application.
        Specified by:
        batch in interface Examples
        Returns:
        the first stage of the batch call

      • list

        public List<LabeledUtterance> list​(UUID appId,
                                   String versionId,
                                   ListExamplesOptionalParameter listOptionalParameter)
        Returns example utterances to be reviewed from a version of the application.
        Specified by:
        list in interface Examples
        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 com.microsoft.rest.ServiceFuture<List<LabeledUtterance>> listAsync​(UUID appId,
                                                                          String versionId,
                                                                          ListExamplesOptionalParameter listOptionalParameter,
                                                                          com.microsoft.rest.ServiceCallback<List<LabeledUtterance>> serviceCallback)
        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
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • listAsync

        public rx.Observable<List<LabeledUtterance>> listAsync​(UUID appId,
                                                       String versionId,
                                                       ListExamplesOptionalParameter listOptionalParameter)
        Returns example utterances to be reviewed from a version of the application.
        Specified by:
        listAsync in interface Examples
        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

      • listWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<List<LabeledUtterance>>> listWithServiceResponseAsync​(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

      • listWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<List<LabeledUtterance>>> listWithServiceResponseAsync​(UUID appId,
                                                                                                              String versionId,
                                                                                                              Integer skip,
                                                                                                              Integer take,
                                                                                                              Boolean enableNestedChildren)
        Returns example utterances to be reviewed from a version of the application.
        Parameters:
        appId - The application ID.
        versionId - The version ID.
        skip - The number of entries to skip. Default value is 0.
        take - The number of entries to return. Maximum page size is 500. Default is 100.
        enableNestedChildren - Toggles nested/flat format
        Returns:
        the observable to the List<LabeledUtterance> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • list

        public com.microsoft.azure.cognitiveservices.language.luis.authoring.implementation.ExamplesImpl.ExamplesListParameters list()
        Description copied from interface: Examples
        Returns example utterances to be reviewed from a version of the application.
        Specified by:
        list in interface Examples
        Returns:
        the first stage of the list call

      • 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.
        Specified by:
        delete in interface Examples
        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 com.microsoft.rest.ServiceFuture<OperationStatus> deleteAsync​(UUID appId,
                                                                     String versionId,
                                                                     int exampleId,
                                                                     com.microsoft.rest.ServiceCallback<OperationStatus> serviceCallback)
        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.
        serviceCallback - the async ServiceCallback to handle successful and failed responses.
        Returns:
        the ServiceFuture object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteAsync

        public 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.
        Specified by:
        deleteAsync in interface Examples
        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

      • deleteWithServiceResponseAsync

        public rx.Observable<com.microsoft.rest.ServiceResponse<OperationStatus>> deleteWithServiceResponseAsync​(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