@azure/cognitiveservices-customvision-training package
Classes
| TrainingAPIClient | |
| TrainingAPIClientContext |
Interfaces
| BoundingBox |
Bounding box that defines a region of an image. |
| CreateProjectOptions |
Options used for createProject. |
| CustomBaseModelInfo |
An interface representing CustomBaseModelInfo. |
| CustomVisionError |
An interface representing CustomVisionError. |
| Domain |
Domains are used as the starting point for your project. Each domain is optimized for specific types of images. Domains with compact in their name can be exported. For more information visit the domain documentation. |
| ExportModel |
An interface representing ExportModel. |
| Image |
Image model to be sent as JSON. |
| ImageCreateResult |
An interface representing ImageCreateResult. |
| ImageCreateSummary |
An interface representing ImageCreateSummary. |
| ImageFileCreateBatch |
An interface representing ImageFileCreateBatch. |
| ImageFileCreateEntry |
An interface representing ImageFileCreateEntry. |
| ImageIdCreateBatch |
An interface representing ImageIdCreateBatch. |
| ImageIdCreateEntry |
An interface representing ImageIdCreateEntry. |
| ImageMetadataUpdateEntry |
Entry associating a metadata to an image. |
| ImageMetadataUpdateSummary |
An interface representing ImageMetadataUpdateSummary. |
| ImagePerformance |
Image performance model. |
| ImagePrediction |
Result of an image prediction request. |
| ImageProcessingSettings |
Represents image preprocessing settings used by image augmentation. |
| ImageRegion |
An interface representing ImageRegion. |
| ImageRegionCreateBatch |
Batch of image region information to create. |
| ImageRegionCreateEntry |
Entry associating a region to an image. |
| ImageRegionCreateResult |
An interface representing ImageRegionCreateResult. |
| ImageRegionCreateSummary |
An interface representing ImageRegionCreateSummary. |
| ImageRegionProposal |
An interface representing ImageRegionProposal. |
| ImageTag |
An interface representing ImageTag. |
| ImageTagCreateBatch |
Batch of image tags. |
| ImageTagCreateEntry |
Entry associating a tag to an image. |
| ImageTagCreateSummary |
An interface representing ImageTagCreateSummary. |
| ImageUrl |
Image url. |
| ImageUrlCreateBatch |
An interface representing ImageUrlCreateBatch. |
| ImageUrlCreateEntry |
An interface representing ImageUrlCreateEntry. |
| Iteration |
Iteration model to be sent over JSON. |
| IterationPerformance |
Represents the detailed performance data for a trained iteration. |
| ModelInformation |
Model information. |
| Prediction |
Prediction result. |
| PredictionQueryResult |
Query result of the prediction images that were sent to your prediction endpoint. |
| PredictionQueryTag |
An interface representing PredictionQueryTag. |
| PredictionQueryToken |
An interface representing PredictionQueryToken. |
| Project |
Represents a project. |
| ProjectExport |
Represents information about a project export. |
| ProjectSettings |
Represents settings associated with a project. |
| Region |
An interface representing Region. |
| RegionProposal |
An interface representing RegionProposal. |
| StoredImagePrediction |
Result of an image prediction request. |
| StoredSuggestedTagAndRegion |
Result of a suggested tags and regions request of the untagged image. |
| SuggestedTagAndRegion |
Result of a suggested tags and regions request. |
| SuggestedTagAndRegionQuery |
The array of result images and token containing session and continuation Ids for the next query. |
| SuggestedTagAndRegionQueryToken |
Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null. Then on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results. |
| Tag |
Represents a Tag. |
| TagFilter |
Model that query for counting of images whose suggested tags match given tags and their probability are greater than or equal to the given threshold. |
| TagPerformance |
Represents performance data for a particular tag in a trained iteration. |
| TrainingAPIClientCreateImagesFromDataOptionalParams |
Optional Parameters. |
| TrainingAPIClientCreateProjectOptionalParams |
Optional Parameters. |
| TrainingAPIClientCreateTagOptionalParams |
Optional Parameters. |
| TrainingAPIClientDeleteImagesOptionalParams |
Optional Parameters. |
| TrainingAPIClientExportIterationOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetImageCountOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetImagePerformanceCountOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetImagePerformancesOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetImagesByIdsOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetImagesOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetIterationPerformanceOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetTaggedImageCountOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetTaggedImagesOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetTagOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetTagsOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetUntaggedImageCountOptionalParams |
Optional Parameters. |
| TrainingAPIClientGetUntaggedImagesOptionalParams |
Optional Parameters. |
| TrainingAPIClientImportProjectOptionalParams |
Optional Parameters. |
| TrainingAPIClientPublishIterationOptionalParams |
Optional Parameters. |
| TrainingAPIClientQuickTestImageOptionalParams |
Optional Parameters. |
| TrainingAPIClientQuickTestImageUrlOptionalParams |
Optional Parameters. |
| TrainingAPIClientTrainProjectOptionalParams |
Optional Parameters. |
| TrainingParameters |
Parameters used for training. |
Type Aliases
| ClassificationType |
Defines values for ClassificationType. Possible values include: 'Multiclass', 'Multilabel' |
| Classifier |
Defines values for Classifier. Possible values include: 'Multiclass', 'Multilabel' |
| CreateImageRegionsResponse |
Contains response data for the createImageRegions operation. |
| CreateImagesFromDataResponse |
Contains response data for the createImagesFromData operation. |
| CreateImagesFromFilesResponse |
Contains response data for the createImagesFromFiles operation. |
| CreateImagesFromPredictionsResponse |
Contains response data for the createImagesFromPredictions operation. |
| CreateImagesFromUrlsResponse |
Contains response data for the createImagesFromUrls operation. |
| CreateImageTagsResponse |
Contains response data for the createImageTags operation. |
| CreateProjectResponse |
Contains response data for the createProject operation. |
| CreateTagResponse |
Contains response data for the createTag operation. |
| CustomVisionErrorCodes |
Defines values for CustomVisionErrorCodes. Possible values include: 'NoError', 'BadRequest', 'BadRequestExceededBatchSize', 'BadRequestNotSupported', 'BadRequestInvalidIds', 'BadRequestProjectName', 'BadRequestProjectNameNotUnique', 'BadRequestProjectDescription', 'BadRequestProjectUnknownDomain', 'BadRequestProjectUnknownClassification', 'BadRequestProjectUnsupportedDomainTypeChange', 'BadRequestProjectUnsupportedExportPlatform', 'BadRequestProjectImagePreprocessingSettings', 'BadRequestProjectDuplicated', 'BadRequestIterationName', 'BadRequestIterationNameNotUnique', 'BadRequestIterationDescription', 'BadRequestIterationIsNotTrained', 'BadRequestIterationValidationFailed', 'BadRequestWorkspaceCannotBeModified', 'BadRequestWorkspaceNotDeletable', 'BadRequestTagName', 'BadRequestTagNameNotUnique', 'BadRequestTagDescription', 'BadRequestTagType', 'BadRequestMultipleNegativeTag', 'BadRequestMultipleGeneralProductTag', 'BadRequestImageTags', 'BadRequestImageRegions', 'BadRequestNegativeAndRegularTagOnSameImage', 'BadRequestUnsupportedDomain', 'BadRequestRequiredParamIsNull', 'BadRequestIterationIsPublished', 'BadRequestInvalidPublishName', 'BadRequestInvalidPublishTarget', 'BadRequestUnpublishFailed', 'BadRequestIterationNotPublished', 'BadRequestSubscriptionApi', 'BadRequestExceedProjectLimit', 'BadRequestExceedIterationPerProjectLimit', 'BadRequestExceedTagPerProjectLimit', 'BadRequestExceedTagPerImageLimit', 'BadRequestExceededQuota', 'BadRequestCannotMigrateProjectWithName', 'BadRequestNotLimitedTrial', 'BadRequestImageBatch', 'BadRequestImageStream', 'BadRequestImageUrl', 'BadRequestImageFormat', 'BadRequestImageSizeBytes', 'BadRequestImageDimensions', 'BadRequestImageAspectRatio', 'BadRequestImageExceededCount', 'BadRequestTrainingNotNeeded', 'BadRequestTrainingNotNeededButTrainingPipelineUpdated', 'BadRequestTrainingValidationFailed', 'BadRequestClassificationTrainingValidationFailed', 'BadRequestMultiClassClassificationTrainingValidationFailed', 'BadRequestMultiLabelClassificationTrainingValidationFailed', 'BadRequestDetectionTrainingValidationFailed', 'BadRequestTrainingAlreadyInProgress', 'BadRequestDetectionTrainingNotAllowNegativeTag', 'BadRequestInvalidEmailAddress', 'BadRequestRetiredDomainNotSupportedForTraining', 'BadRequestDomainNotSupportedForAdvancedTraining', 'BadRequestExportPlatformNotSupportedForAdvancedTraining', 'BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining', 'BadRequestCustomBaseModelIterationStatusNotCompleted', 'BadRequestCustomBaseModelDomainNotCompatible', 'BadRequestCustomBaseModelArchitectureRetired', 'BadRequestExportValidationFailed', 'BadRequestExportAlreadyInProgress', 'BadRequestPredictionIdsMissing', 'BadRequestPredictionIdsExceededCount', 'BadRequestPredictionTagsExceededCount', 'BadRequestPredictionResultsExceededCount', 'BadRequestPredictionInvalidApplicationName', 'BadRequestPredictionInvalidQueryParameters', 'BadRequestInvalidImportToken', 'BadRequestExportWhileTraining', 'BadRequestImageMetadataKey', 'BadRequestImageMetadataValue', 'BadRequestOperationNotSupported', 'BadRequestInvalidArtifactUri', 'BadRequestCustomerManagedKeyRevoked', 'BadRequestInvalidUri', 'BadRequestInvalid', 'UnsupportedMediaType', 'Forbidden', 'ForbiddenUser', 'ForbiddenUserResource', 'ForbiddenUserSignupDisabled', 'ForbiddenUserSignupAllowanceExceeded', 'ForbiddenUserDoesNotExist', 'ForbiddenUserDisabled', 'ForbiddenUserInsufficientCapability', 'ForbiddenDRModeEnabled', 'ForbiddenInvalid', 'NotFound', 'NotFoundProject', 'NotFoundProjectDefaultIteration', 'NotFoundIteration', 'NotFoundIterationPerformance', 'NotFoundTag', 'NotFoundImage', 'NotFoundDomain', 'NotFoundApimSubscription', 'NotFoundInvalid', 'Conflict', 'ConflictInvalid', 'ErrorUnknown', 'ErrorIterationCopyFailed', 'ErrorPreparePerformanceMigrationFailed', 'ErrorProjectInvalidWorkspace', 'ErrorProjectInvalidPipelineConfiguration', 'ErrorProjectInvalidDomain', 'ErrorProjectTrainingRequestFailed', 'ErrorProjectImportRequestFailed', 'ErrorProjectExportRequestFailed', 'ErrorFeaturizationServiceUnavailable', 'ErrorFeaturizationQueueTimeout', 'ErrorFeaturizationInvalidFeaturizer', 'ErrorFeaturizationAugmentationUnavailable', 'ErrorFeaturizationUnrecognizedJob', 'ErrorFeaturizationAugmentationError', 'ErrorExporterInvalidPlatform', 'ErrorExporterInvalidFeaturizer', 'ErrorExporterInvalidClassifier', 'ErrorPredictionServiceUnavailable', 'ErrorPredictionModelNotFound', 'ErrorPredictionModelNotCached', 'ErrorPrediction', 'ErrorPredictionStorage', 'ErrorRegionProposal', 'ErrorUnknownBaseModel', 'ErrorServerTimeOut', 'ErrorInvalid' |
| DomainType |
Defines values for DomainType. Possible values include: 'Classification', 'ObjectDetection' |
| ExportFlavor |
Defines values for ExportFlavor. Possible values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12', 'ARM', 'TensorFlowNormal', 'TensorFlowLite' |
| ExportIterationResponse |
Contains response data for the exportIteration operation. |
| ExportPlatform |
Defines values for ExportPlatform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK', 'OpenVino' |
| ExportProjectResponse |
Contains response data for the exportProject operation. |
| ExportStatus |
Defines values for ExportStatus. Possible values include: 'Exporting', 'Failed', 'Done' |
| Flavor |
Defines values for Flavor. Possible values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12', 'ARM', 'TensorFlowNormal', 'TensorFlowLite' |
| GetArtifactResponse |
Contains response data for the getArtifact operation. |
| GetDomainResponse |
Contains response data for the getDomain operation. |
| GetDomainsResponse |
Contains response data for the getDomains operation. |
| GetExportsResponse |
Contains response data for the getExports operation. |
| GetImageCountResponse |
Contains response data for the getImageCount operation. |
| GetImagePerformanceCountResponse |
Contains response data for the getImagePerformanceCount operation. |
| GetImagePerformancesResponse |
Contains response data for the getImagePerformances operation. |
| GetImageRegionProposalsResponse |
Contains response data for the getImageRegionProposals operation. |
| GetImagesByIdsResponse |
Contains response data for the getImagesByIds operation. |
| GetImagesResponse |
Contains response data for the getImages operation. |
| GetIterationPerformanceResponse |
Contains response data for the getIterationPerformance operation. |
| GetIterationResponse |
Contains response data for the getIteration operation. |
| GetIterationsResponse |
Contains response data for the getIterations operation. |
| GetProjectResponse |
Contains response data for the getProject operation. |
| GetProjectsResponse |
Contains response data for the getProjects operation. |
| GetTaggedImageCountResponse |
Contains response data for the getTaggedImageCount operation. |
| GetTaggedImagesResponse |
Contains response data for the getTaggedImages operation. |
| GetTagResponse |
Contains response data for the getTag operation. |
| GetTagsResponse |
Contains response data for the getTags operation. |
| GetUntaggedImageCountResponse |
Contains response data for the getUntaggedImageCount operation. |
| GetUntaggedImagesResponse |
Contains response data for the getUntaggedImages operation. |
| ImageCreateStatus |
Defines values for ImageCreateStatus. Possible values include: 'OK', 'OKDuplicate', 'ErrorSource', 'ErrorImageFormat', 'ErrorImageSize', 'ErrorStorage', 'ErrorLimitExceed', 'ErrorTagLimitExceed', 'ErrorRegionLimitExceed', 'ErrorUnknown', 'ErrorNegativeAndRegularTagOnSameImage', 'ErrorImageDimensions', 'ErrorInvalidTag' |
| ImageMetadataUpdateStatus |
Defines values for ImageMetadataUpdateStatus. Possible values include: 'OK', 'ErrorImageNotFound', 'ErrorLimitExceed', 'ErrorUnknown' |
| ImportProjectResponse |
Contains response data for the importProject operation. |
| OrderBy |
Defines values for OrderBy. Possible values include: 'Newest', 'Oldest', 'Suggested' |
| OrderBy1 |
Defines values for OrderBy1. Possible values include: 'Newest', 'Oldest' |
| OrderBy2 |
Defines values for OrderBy2. Possible values include: 'Newest', 'Oldest' |
| OrderBy3 |
Defines values for OrderBy3. Possible values include: 'Newest', 'Oldest' |
| OrderBy4 |
Defines values for OrderBy4. Possible values include: 'Newest', 'Oldest' |
| Platform |
Defines values for Platform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK', 'OpenVino' |
| ProjectStatus |
Defines values for ProjectStatus. Possible values include: 'Succeeded', 'Importing', 'Failed' |
| PublishIterationResponse |
Contains response data for the publishIteration operation. |
| QueryPredictionsResponse |
Contains response data for the queryPredictions operation. |
| QuerySuggestedImageCountResponse |
Contains response data for the querySuggestedImageCount operation. |
| QuerySuggestedImagesResponse |
Contains response data for the querySuggestedImages operation. |
| QuickTestImageResponse |
Contains response data for the quickTestImage operation. |
| QuickTestImageUrlResponse |
Contains response data for the quickTestImageUrl operation. |
| SortBy |
Defines values for SortBy. Possible values include: 'UncertaintyAscending', 'UncertaintyDescending' |
| SuggestTagsAndRegionsResponse |
Contains response data for the suggestTagsAndRegions operation. |
| TaggingStatus |
Defines values for TaggingStatus. Possible values include: 'All', 'Tagged', 'Untagged' |
| TaggingStatus1 |
Defines values for TaggingStatus1. Possible values include: 'All', 'Tagged', 'Untagged' |
| TagType |
Defines values for TagType. Possible values include: 'Regular', 'Negative', 'GeneralProduct' |
| TrainingType |
Defines values for TrainingType. Possible values include: 'Regular', 'Advanced' |
| TrainingType1 |
Defines values for TrainingType1. Possible values include: 'Regular', 'Advanced' |
| TrainProjectResponse |
Contains response data for the trainProject operation. |
| Type |
Defines values for Type. Possible values include: 'Regular', 'Negative', 'GeneralProduct' |
| UpdateImageMetadataResponse |
Contains response data for the updateImageMetadata operation. |
| UpdateIterationResponse |
Contains response data for the updateIteration operation. |
| UpdateProjectResponse |
Contains response data for the updateProject operation. |
| UpdateTagResponse |
Contains response data for the updateTag operation. |