Package com.microsoft.azure.cognitiveservices.vision.customvision.training

Interface Trainings

  • public interface Trainings
    An instance of this class provides access to all the operations defined in Trainings.

    • Method Detail

      • createTag

        Tag createTag​(UUID projectId,
              String name,
              CreateTagOptionalParameter createTagOptionalParameter)
        Create a tag for the project.
        Parameters:
        projectId - The project id.
        name - The tag name.
        createTagOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the Tag object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createTagAsync

        rx.Observable<Tag> createTagAsync​(UUID projectId,
                                  String name,
                                  CreateTagOptionalParameter createTagOptionalParameter)
        Create a tag for the project.
        Parameters:
        projectId - The project id.
        name - The tag name.
        createTagOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the Tag object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getTags

        List<Tag> getTags​(UUID projectId,
                  GetTagsOptionalParameter getTagsOptionalParameter)
        Get the tags for a given project and iteration.
        Parameters:
        projectId - The project id.
        getTagsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the List<Tag> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getTagsAsync

        rx.Observable<List<Tag>> getTagsAsync​(UUID projectId,
                                      GetTagsOptionalParameter getTagsOptionalParameter)
        Get the tags for a given project and iteration.
        Parameters:
        projectId - The project id.
        getTagsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the List<Tag> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • updateTag

        Tag updateTag​(UUID projectId,
              UUID tagId,
              Tag updatedTag)
        Update a tag.
        Parameters:
        projectId - The project id.
        tagId - The id of the target tag.
        updatedTag - The updated tag model.
        Returns:
        the Tag object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • updateTagAsync

        rx.Observable<Tag> updateTagAsync​(UUID projectId,
                                  UUID tagId,
                                  Tag updatedTag)
        Update a tag.
        Parameters:
        projectId - The project id.
        tagId - The id of the target tag.
        updatedTag - The updated tag model.
        Returns:
        the observable to the Tag object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteTag

        void deleteTag​(UUID projectId,
               UUID tagId)
        Delete a tag from the project.
        Parameters:
        projectId - The project id.
        tagId - Id of the tag to be deleted.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteTagAsync

        rx.Observable<Void> deleteTagAsync​(UUID projectId,
                                   UUID tagId)
        Delete a tag from the project.
        Parameters:
        projectId - The project id.
        tagId - Id of the tag to be deleted.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getTag

        Tag getTag​(UUID projectId,
           UUID tagId,
           GetTagOptionalParameter getTagOptionalParameter)
        Get information about a specific tag.
        Parameters:
        projectId - The project this tag belongs to.
        tagId - The tag id.
        getTagOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the Tag object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getTagAsync

        rx.Observable<Tag> getTagAsync​(UUID projectId,
                               UUID tagId,
                               GetTagOptionalParameter getTagOptionalParameter)
        Get information about a specific tag.
        Parameters:
        projectId - The project this tag belongs to.
        tagId - The tag id.
        getTagOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the Tag object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • exportIteration

        Export exportIteration​(UUID projectId,
                       UUID iterationId,
                       String platform,
                       ExportIterationOptionalParameter exportIterationOptionalParameter)
        Export a trained iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        platform - The target platform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK'.
        exportIterationOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the Export object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • exportIterationAsync

        rx.Observable<Export> exportIterationAsync​(UUID projectId,
                                           UUID iterationId,
                                           String platform,
                                           ExportIterationOptionalParameter exportIterationOptionalParameter)
        Export a trained iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        platform - The target platform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK'.
        exportIterationOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the Export object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getExports

        List<Export> getExports​(UUID projectId,
                        UUID iterationId)
        Get the list of exports for a specific iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        Returns:
        the List<Export> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getExportsAsync

        rx.Observable<List<Export>> getExportsAsync​(UUID projectId,
                                            UUID iterationId)
        Get the list of exports for a specific iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        Returns:
        the observable to the List<Export> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • unpublishIteration

        void unpublishIteration​(UUID projectId,
                        UUID iterationId)
        Unpublish a specific iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • unpublishIterationAsync

        rx.Observable<Void> unpublishIterationAsync​(UUID projectId,
                                            UUID iterationId)
        Unpublish a specific iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • publishIteration

        boolean publishIteration​(UUID projectId,
                         UUID iterationId,
                         String publishName,
                         String predictionId)
        Publish a specific iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        publishName - The name to give the published iteration.
        predictionId - The id of the prediction resource to publish to.
        Returns:
        the boolean object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • publishIterationAsync

        rx.Observable<Boolean> publishIterationAsync​(UUID projectId,
                                             UUID iterationId,
                                             String publishName,
                                             String predictionId)
        Publish a specific iteration.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        publishName - The name to give the published iteration.
        predictionId - The id of the prediction resource to publish to.
        Returns:
        the observable to the boolean object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • updateIteration

        Iteration updateIteration​(UUID projectId,
                          UUID iterationId,
                          String name)
        Update a specific iteration.
        Parameters:
        projectId - Project id.
        iterationId - Iteration id.
        name - Gets or sets the name of the iteration.
        Returns:
        the Iteration object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • updateIterationAsync

        rx.Observable<Iteration> updateIterationAsync​(UUID projectId,
                                              UUID iterationId,
                                              String name)
        Update a specific iteration.
        Parameters:
        projectId - Project id.
        iterationId - Iteration id.
        name - Gets or sets the name of the iteration.
        Returns:
        the observable to the Iteration object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteIteration

        void deleteIteration​(UUID projectId,
                     UUID iterationId)
        Delete a specific iteration of a project.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteIterationAsync

        rx.Observable<Void> deleteIterationAsync​(UUID projectId,
                                         UUID iterationId)
        Delete a specific iteration of a project.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getIteration

        Iteration getIteration​(UUID projectId,
                       UUID iterationId)
        Get a specific iteration.
        Parameters:
        projectId - The id of the project the iteration belongs to.
        iterationId - The id of the iteration to get.
        Returns:
        the Iteration object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getIterationAsync

        rx.Observable<Iteration> getIterationAsync​(UUID projectId,
                                           UUID iterationId)
        Get a specific iteration.
        Parameters:
        projectId - The id of the project the iteration belongs to.
        iterationId - The id of the iteration to get.
        Returns:
        the observable to the Iteration object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getIterations

        List<Iteration> getIterations​(UUID projectId)
        Get iterations for the project.
        Parameters:
        projectId - The project id.
        Returns:
        the List<Iteration> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getIterationsAsync

        rx.Observable<List<Iteration>> getIterationsAsync​(UUID projectId)
        Get iterations for the project.
        Parameters:
        projectId - The project id.
        Returns:
        the observable to the List<Iteration> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • trainProject

        Iteration trainProject​(UUID projectId,
                       TrainProjectOptionalParameter trainProjectOptionalParameter)
        Queues project for training.
        Parameters:
        projectId - The project id.
        trainProjectOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the Iteration object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • trainProjectAsync

        rx.Observable<Iteration> trainProjectAsync​(UUID projectId,
                                           TrainProjectOptionalParameter trainProjectOptionalParameter)
        Queues project for training.
        Parameters:
        projectId - The project id.
        trainProjectOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the Iteration object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • updateProject

        Project updateProject​(UUID projectId,
                      Project updatedProject)
        Update a specific project.
        Parameters:
        projectId - The id of the project to update.
        updatedProject - The updated project model.
        Returns:
        the Project object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • updateProjectAsync

        rx.Observable<Project> updateProjectAsync​(UUID projectId,
                                          Project updatedProject)
        Update a specific project.
        Parameters:
        projectId - The id of the project to update.
        updatedProject - The updated project model.
        Returns:
        the observable to the Project object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteProject

        void deleteProject​(UUID projectId)
        Delete a specific project.
        Parameters:
        projectId - The project id.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteProjectAsync

        rx.Observable<Void> deleteProjectAsync​(UUID projectId)
        Delete a specific project.
        Parameters:
        projectId - The project id.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getProject

        Project getProject​(UUID projectId)
        Get a specific project.
        Parameters:
        projectId - The id of the project to get.
        Returns:
        the Project object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getProjectAsync

        rx.Observable<Project> getProjectAsync​(UUID projectId)
        Get a specific project.
        Parameters:
        projectId - The id of the project to get.
        Returns:
        the observable to the Project object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createProject

        Project createProject​(String name,
                      CreateProjectOptionalParameter createProjectOptionalParameter)
        Create a project.
        Parameters:
        name - Name of the project.
        createProjectOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the Project object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createProjectAsync

        rx.Observable<Project> createProjectAsync​(String name,
                                          CreateProjectOptionalParameter createProjectOptionalParameter)
        Create a project.
        Parameters:
        name - Name of the project.
        createProjectOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the Project object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getProjectsAsync

        rx.Observable<List<Project>> getProjectsAsync()
        Get your projects.
        Returns:
        the observable to the List<Project> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getImagePerformanceCount

        int getImagePerformanceCount​(UUID projectId,
                             UUID iterationId,
                             GetImagePerformanceCountOptionalParameter getImagePerformanceCountOptionalParameter)
        Gets the number of images tagged with the provided {tagIds} that have prediction results from training for the provided iteration {iterationId}. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id. Defaults to workspace.
        getImagePerformanceCountOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the int object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getImagePerformanceCountAsync

        rx.Observable<Integer> getImagePerformanceCountAsync​(UUID projectId,
                                                     UUID iterationId,
                                                     GetImagePerformanceCountOptionalParameter getImagePerformanceCountOptionalParameter)
        Gets the number of images tagged with the provided {tagIds} that have prediction results from training for the provided iteration {iterationId}. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id. Defaults to workspace.
        getImagePerformanceCountOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the int object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getImagePerformanceCount

        Trainings.TrainingsGetImagePerformanceCountDefinitionStages.WithProjectId getImagePerformanceCount()
        Gets the number of images tagged with the provided {tagIds} that have prediction results from training for the provided iteration {iterationId}. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Returns:
        the first stage of the getImagePerformanceCount call

      • getImagePerformances

        List<ImagePerformance> getImagePerformances​(UUID projectId,
                                            UUID iterationId,
                                            GetImagePerformancesOptionalParameter getImagePerformancesOptionalParameter)
        Get image with its prediction for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id. Defaults to workspace.
        getImagePerformancesOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the List<ImagePerformance> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getImagePerformancesAsync

        rx.Observable<List<ImagePerformance>> getImagePerformancesAsync​(UUID projectId,
                                                                UUID iterationId,
                                                                GetImagePerformancesOptionalParameter getImagePerformancesOptionalParameter)
        Get image with its prediction for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        iterationId - The iteration id. Defaults to workspace.
        getImagePerformancesOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the List<ImagePerformance> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getImagePerformances

        Trainings.TrainingsGetImagePerformancesDefinitionStages.WithProjectId getImagePerformances()
        Get image with its prediction for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Returns:
        the first stage of the getImagePerformances call

      • getIterationPerformance

        IterationPerformance getIterationPerformance​(UUID projectId,
                                             UUID iterationId,
                                             GetIterationPerformanceOptionalParameter getIterationPerformanceOptionalParameter)
        Get detailed performance information about an iteration.
        Parameters:
        projectId - The id of the project the iteration belongs to.
        iterationId - The id of the iteration to get.
        getIterationPerformanceOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the IterationPerformance object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getIterationPerformanceAsync

        rx.Observable<IterationPerformance> getIterationPerformanceAsync​(UUID projectId,
                                                                 UUID iterationId,
                                                                 GetIterationPerformanceOptionalParameter getIterationPerformanceOptionalParameter)
        Get detailed performance information about an iteration.
        Parameters:
        projectId - The id of the project the iteration belongs to.
        iterationId - The id of the iteration to get.
        getIterationPerformanceOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the IterationPerformance object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • queryPredictions

        PredictionQueryResult queryPredictions​(UUID projectId,
                                       PredictionQueryToken query)
        Get images that were sent to your prediction endpoint.
        Parameters:
        projectId - The project id.
        query - Parameters used to query the predictions. Limited to combining 2 tags.
        Returns:
        the PredictionQueryResult object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • queryPredictionsAsync

        rx.Observable<PredictionQueryResult> queryPredictionsAsync​(UUID projectId,
                                                           PredictionQueryToken query)
        Get images that were sent to your prediction endpoint.
        Parameters:
        projectId - The project id.
        query - Parameters used to query the predictions. Limited to combining 2 tags.
        Returns:
        the observable to the PredictionQueryResult object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • quickTestImage

        ImagePrediction quickTestImage​(UUID projectId,
                               byte[] imageData,
                               QuickTestImageOptionalParameter quickTestImageOptionalParameter)
        Quick test an image.
        Parameters:
        projectId - The project id.
        imageData - Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
        quickTestImageOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the ImagePrediction object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • quickTestImageAsync

        rx.Observable<ImagePrediction> quickTestImageAsync​(UUID projectId,
                                                   byte[] imageData,
                                                   QuickTestImageOptionalParameter quickTestImageOptionalParameter)
        Quick test an image.
        Parameters:
        projectId - The project id.
        imageData - Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
        quickTestImageOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the ImagePrediction object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • quickTestImageUrl

        ImagePrediction quickTestImageUrl​(UUID projectId,
                                  String url,
                                  QuickTestImageUrlOptionalParameter quickTestImageUrlOptionalParameter)
        Quick test an image url.
        Parameters:
        projectId - The project to evaluate against.
        url - Url of the image.
        quickTestImageUrlOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the ImagePrediction object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • quickTestImageUrlAsync

        rx.Observable<ImagePrediction> quickTestImageUrlAsync​(UUID projectId,
                                                      String url,
                                                      QuickTestImageUrlOptionalParameter quickTestImageUrlOptionalParameter)
        Quick test an image url.
        Parameters:
        projectId - The project to evaluate against.
        url - Url of the image.
        quickTestImageUrlOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the ImagePrediction object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deletePrediction

        void deletePrediction​(UUID projectId,
                      List<UUID> ids)
        Delete a set of predicted images and their associated prediction results.
        Parameters:
        projectId - The project id.
        ids - The prediction ids. Limited to 64.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deletePredictionAsync

        rx.Observable<Void> deletePredictionAsync​(UUID projectId,
                                          List<UUID> ids)
        Delete a set of predicted images and their associated prediction results.
        Parameters:
        projectId - The project id.
        ids - The prediction ids. Limited to 64.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getImageRegionProposals

        ImageRegionProposal getImageRegionProposals​(UUID projectId,
                                            UUID imageId)
        Get region proposals for an image. Returns empty array if no proposals are found. This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
        Parameters:
        projectId - The project id.
        imageId - The image id.
        Returns:
        the ImageRegionProposal object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getImageRegionProposalsAsync

        rx.Observable<ImageRegionProposal> getImageRegionProposalsAsync​(UUID projectId,
                                                                UUID imageId)
        Get region proposals for an image. Returns empty array if no proposals are found. This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
        Parameters:
        projectId - The project id.
        imageId - The image id.
        Returns:
        the observable to the ImageRegionProposal object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImagesFromPredictions

        ImageCreateSummary createImagesFromPredictions​(UUID projectId,
                                               ImageIdCreateBatch batch)
        Add the specified predicted images to the set of training images. This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.
        Parameters:
        projectId - The project id.
        batch - Image and tag ids. Limited to 64 images and 20 tags per batch.
        Returns:
        the ImageCreateSummary object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createImagesFromPredictionsAsync

        rx.Observable<ImageCreateSummary> createImagesFromPredictionsAsync​(UUID projectId,
                                                                   ImageIdCreateBatch batch)
        Add the specified predicted images to the set of training images. This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.
        Parameters:
        projectId - The project id.
        batch - Image and tag ids. Limited to 64 images and 20 tags per batch.
        Returns:
        the observable to the ImageCreateSummary object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImagesFromUrls

        ImageCreateSummary createImagesFromUrls​(UUID projectId,
                                        ImageUrlCreateBatch batch)
        Add the provided images urls to the set of training images. This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
        Parameters:
        projectId - The project id.
        batch - Image urls and tag ids. Limited to 64 images and 20 tags per batch.
        Returns:
        the ImageCreateSummary object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createImagesFromUrlsAsync

        rx.Observable<ImageCreateSummary> createImagesFromUrlsAsync​(UUID projectId,
                                                            ImageUrlCreateBatch batch)
        Add the provided images urls to the set of training images. This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
        Parameters:
        projectId - The project id.
        batch - Image urls and tag ids. Limited to 64 images and 20 tags per batch.
        Returns:
        the observable to the ImageCreateSummary object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImagesFromFiles

        ImageCreateSummary createImagesFromFiles​(UUID projectId,
                                         ImageFileCreateBatch batch)
        Add the provided batch of images to the set of training images. This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
        Parameters:
        projectId - The project id.
        batch - The batch of image files to add. Limited to 64 images and 20 tags per batch.
        Returns:
        the ImageCreateSummary object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createImagesFromFilesAsync

        rx.Observable<ImageCreateSummary> createImagesFromFilesAsync​(UUID projectId,
                                                             ImageFileCreateBatch batch)
        Add the provided batch of images to the set of training images. This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.
        Parameters:
        projectId - The project id.
        batch - The batch of image files to add. Limited to 64 images and 20 tags per batch.
        Returns:
        the observable to the ImageCreateSummary object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • deleteImages

        void deleteImages​(UUID projectId,
                  List<UUID> imageIds)
        Delete images from the set of training images.
        Parameters:
        projectId - The project id.
        imageIds - Ids of the images to be deleted. Limited to 256 images per batch.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteImagesAsync

        rx.Observable<Void> deleteImagesAsync​(UUID projectId,
                                      List<UUID> imageIds)
        Delete images from the set of training images.
        Parameters:
        projectId - The project id.
        imageIds - Ids of the images to be deleted. Limited to 256 images per batch.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImagesFromData

        ImageCreateSummary createImagesFromData​(UUID projectId,
                                        byte[] imageData,
                                        CreateImagesFromDataOptionalParameter createImagesFromDataOptionalParameter)
        Add the provided images to the set of training images. This API accepts body content as multipart/form-data and application/octet-stream. When using multipart multiple image files can be sent at once, with a maximum of 64 files.
        Parameters:
        projectId - The project id.
        imageData - Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
        createImagesFromDataOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the ImageCreateSummary object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createImagesFromDataAsync

        rx.Observable<ImageCreateSummary> createImagesFromDataAsync​(UUID projectId,
                                                            byte[] imageData,
                                                            CreateImagesFromDataOptionalParameter createImagesFromDataOptionalParameter)
        Add the provided images to the set of training images. This API accepts body content as multipart/form-data and application/octet-stream. When using multipart multiple image files can be sent at once, with a maximum of 64 files.
        Parameters:
        projectId - The project id.
        imageData - Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
        createImagesFromDataOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the ImageCreateSummary object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImagesFromData

        Trainings.TrainingsCreateImagesFromDataDefinitionStages.WithProjectId createImagesFromData()
        Add the provided images to the set of training images. This API accepts body content as multipart/form-data and application/octet-stream. When using multipart multiple image files can be sent at once, with a maximum of 64 files.
        Returns:
        the first stage of the createImagesFromData call

      • getImagesByIds

        List<Image> getImagesByIds​(UUID projectId,
                           GetImagesByIdsOptionalParameter getImagesByIdsOptionalParameter)
        Get images by id for a given project iteration. This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.
        Parameters:
        projectId - The project id.
        getImagesByIdsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the List<Image> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getImagesByIdsAsync

        rx.Observable<List<Image>> getImagesByIdsAsync​(UUID projectId,
                                               GetImagesByIdsOptionalParameter getImagesByIdsOptionalParameter)
        Get images by id for a given project iteration. This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.
        Parameters:
        projectId - The project id.
        getImagesByIdsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the List<Image> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getImagesByIds

        Trainings.TrainingsGetImagesByIdsDefinitionStages.WithProjectId getImagesByIds()
        Get images by id for a given project iteration. This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.
        Returns:
        the first stage of the getImagesByIds call

      • getUntaggedImages

        List<Image> getUntaggedImages​(UUID projectId,
                              GetUntaggedImagesOptionalParameter getUntaggedImagesOptionalParameter)
        Get untagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch.
        Parameters:
        projectId - The project id.
        getUntaggedImagesOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the List<Image> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getUntaggedImagesAsync

        rx.Observable<List<Image>> getUntaggedImagesAsync​(UUID projectId,
                                                  GetUntaggedImagesOptionalParameter getUntaggedImagesOptionalParameter)
        Get untagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch.
        Parameters:
        projectId - The project id.
        getUntaggedImagesOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the List<Image> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getUntaggedImages

        Trainings.TrainingsGetUntaggedImagesDefinitionStages.WithProjectId getUntaggedImages()
        Get untagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch.
        Returns:
        the first stage of the getUntaggedImages call

      • getTaggedImages

        List<Image> getTaggedImages​(UUID projectId,
                            GetTaggedImagesOptionalParameter getTaggedImagesOptionalParameter)
        Get tagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        getTaggedImagesOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the List<Image> object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getTaggedImagesAsync

        rx.Observable<List<Image>> getTaggedImagesAsync​(UUID projectId,
                                                GetTaggedImagesOptionalParameter getTaggedImagesOptionalParameter)
        Get tagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        getTaggedImagesOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the List<Image> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getTaggedImages

        Trainings.TrainingsGetTaggedImagesDefinitionStages.WithProjectId getTaggedImages()
        Get tagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Returns:
        the first stage of the getTaggedImages call

      • deleteImageRegions

        void deleteImageRegions​(UUID projectId,
                        List<UUID> regionIds)
        Delete a set of image regions.
        Parameters:
        projectId - The project id.
        regionIds - Regions to delete. Limited to 64.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteImageRegionsAsync

        rx.Observable<Void> deleteImageRegionsAsync​(UUID projectId,
                                            List<UUID> regionIds)
        Delete a set of image regions.
        Parameters:
        projectId - The project id.
        regionIds - Regions to delete. Limited to 64.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImageRegions

        ImageRegionCreateSummary createImageRegions​(UUID projectId,
                                            CreateImageRegionsOptionalParameter createImageRegionsOptionalParameter)
        Create a set of image regions. This API accepts a batch of image regions, and optionally tags, to update existing images with region information. There is a limit of 64 entries in the batch.
        Parameters:
        projectId - The project id.
        createImageRegionsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the ImageRegionCreateSummary object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createImageRegionsAsync

        rx.Observable<ImageRegionCreateSummary> createImageRegionsAsync​(UUID projectId,
                                                                CreateImageRegionsOptionalParameter createImageRegionsOptionalParameter)
        Create a set of image regions. This API accepts a batch of image regions, and optionally tags, to update existing images with region information. There is a limit of 64 entries in the batch.
        Parameters:
        projectId - The project id.
        createImageRegionsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the ImageRegionCreateSummary object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImageRegions

        Trainings.TrainingsCreateImageRegionsDefinitionStages.WithProjectId createImageRegions()
        Create a set of image regions. This API accepts a batch of image regions, and optionally tags, to update existing images with region information. There is a limit of 64 entries in the batch.
        Returns:
        the first stage of the createImageRegions call

      • deleteImageTags

        void deleteImageTags​(UUID projectId,
                     List<UUID> imageIds,
                     List<UUID> tagIds)
        Remove a set of tags from a set of images.
        Parameters:
        projectId - The project id.
        imageIds - Image ids. Limited to 64 images.
        tagIds - Tags to be deleted from the specified images. Limited to 20 tags.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • deleteImageTagsAsync

        rx.Observable<Void> deleteImageTagsAsync​(UUID projectId,
                                         List<UUID> imageIds,
                                         List<UUID> tagIds)
        Remove a set of tags from a set of images.
        Parameters:
        projectId - The project id.
        imageIds - Image ids. Limited to 64 images.
        tagIds - Tags to be deleted from the specified images. Limited to 20 tags.
        Returns:
        a representation of the deferred computation of this call if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • createImageTags

        ImageTagCreateSummary createImageTags​(UUID projectId,
                                      CreateImageTagsOptionalParameter createImageTagsOptionalParameter)
        Associate a set of images with a set of tags.
        Parameters:
        projectId - The project id.
        createImageTagsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the ImageTagCreateSummary object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • createImageTagsAsync

        rx.Observable<ImageTagCreateSummary> createImageTagsAsync​(UUID projectId,
                                                          CreateImageTagsOptionalParameter createImageTagsOptionalParameter)
        Associate a set of images with a set of tags.
        Parameters:
        projectId - The project id.
        createImageTagsOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the ImageTagCreateSummary object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getUntaggedImageCount

        int getUntaggedImageCount​(UUID projectId,
                          GetUntaggedImageCountOptionalParameter getUntaggedImageCountOptionalParameter)
        Gets the number of untagged images. This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the current workspace is used.
        Parameters:
        projectId - The project id.
        getUntaggedImageCountOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the int object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getUntaggedImageCountAsync

        rx.Observable<Integer> getUntaggedImageCountAsync​(UUID projectId,
                                                  GetUntaggedImageCountOptionalParameter getUntaggedImageCountOptionalParameter)
        Gets the number of untagged images. This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the current workspace is used.
        Parameters:
        projectId - The project id.
        getUntaggedImageCountOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the int object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getUntaggedImageCount

        Trainings.TrainingsGetUntaggedImageCountDefinitionStages.WithProjectId getUntaggedImageCount()
        Gets the number of untagged images. This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the current workspace is used.
        Returns:
        the first stage of the getUntaggedImageCount call

      • getTaggedImageCount

        int getTaggedImageCount​(UUID projectId,
                        GetTaggedImageCountOptionalParameter getTaggedImageCountOptionalParameter)
        Gets the number of images tagged with the provided {tagIds}. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        getTaggedImageCountOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the int object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getTaggedImageCountAsync

        rx.Observable<Integer> getTaggedImageCountAsync​(UUID projectId,
                                                GetTaggedImageCountOptionalParameter getTaggedImageCountOptionalParameter)
        Gets the number of images tagged with the provided {tagIds}. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Parameters:
        projectId - The project id.
        getTaggedImageCountOptionalParameter - the object representing the optional parameters to be set before calling this API
        Returns:
        the observable to the int object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getTaggedImageCount

        Trainings.TrainingsGetTaggedImageCountDefinitionStages.WithProjectId getTaggedImageCount()
        Gets the number of images tagged with the provided {tagIds}. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned.
        Returns:
        the first stage of the getTaggedImageCount call

      • getDomain

        Domain getDomain​(UUID domainId)
        Get information about a specific domain.
        Parameters:
        domainId - The id of the domain to get information about.
        Returns:
        the Domain object if successful.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation
        CustomVisionErrorException - thrown if the request is rejected by server
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent

      • getDomainAsync

        rx.Observable<Domain> getDomainAsync​(UUID domainId)
        Get information about a specific domain.
        Parameters:
        domainId - The id of the domain to get information about.
        Returns:
        the observable to the Domain object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation

      • getDomainsAsync

        rx.Observable<List<Domain>> getDomainsAsync()
        Get a list of the available domains.
        Returns:
        the observable to the List<Domain> object
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation