TrainingAPIClient class
- Extends
Constructors
| Training |
Initializes a new instance of the TrainingAPIClient class. |
Inherited Properties
| credentials | |
| endpoint |
Methods
Inherited Methods
| send |
Send an HTTP request that is populated using the provided OperationSpec. |
| send |
Send the provided httpRequest. |
Constructor Details
TrainingAPIClient(ServiceClientCredentials, string, ServiceClientOptions)
Initializes a new instance of the TrainingAPIClient class.
new TrainingAPIClient(credentials: ServiceClientCredentials, endpoint: string, options?: ServiceClientOptions)Parameters
- credentials
- ServiceClientCredentials
Subscription credentials which uniquely identify client subscription.
- endpoint
-
string
Supported Cognitive Services endpoints.
- options
- ServiceClientOptions
The parameter options
Inherited Property Details
credentials
credentials: ServiceClientCredentialsProperty Value
Inherited From TrainingAPIClientContext.credentials
endpoint
Method Details
createImageRegions(string, ImageRegionCreateBatch, RequestOptionsBase)
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. If all regions are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each region will be listed in the response payload.
function createImageRegions(projectId: string, batch: ImageRegionCreateBatch, options?: RequestOptionsBase): Promise<CreateImageRegionsResponse>Parameters
- projectId
-
string
The project id.
- batch
- ImageRegionCreateBatch
Batch of image regions which include a tag and bounding box. Limited to 64.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<CreateImageRegionsResponse>
Promise<Models.CreateImageRegionsResponse>
createImageRegions(string, ImageRegionCreateBatch, RequestOptionsBase, ServiceCallback<ImageRegionCreateSummary>)
function createImageRegions(projectId: string, batch: ImageRegionCreateBatch, options: RequestOptionsBase, callback: ServiceCallback<ImageRegionCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageRegionCreateBatch
Batch of image regions which include a tag and bounding box. Limited to 64.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createImageRegions(string, ImageRegionCreateBatch, ServiceCallback<ImageRegionCreateSummary>)
function createImageRegions(projectId: string, batch: ImageRegionCreateBatch, callback: ServiceCallback<ImageRegionCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageRegionCreateBatch
Batch of image regions which include a tag and bounding box. Limited to 64.
- callback
The callback
createImagesFromData(string, HttpRequestBody, ServiceCallback<ImageCreateSummary>)
function createImagesFromData(projectId: string, imageData: HttpRequestBody, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- imageData
- HttpRequestBody
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
- callback
The callback
createImagesFromData(string, HttpRequestBody, TrainingAPIClientCreateImagesFromDataOptionalParams)
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. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
function createImagesFromData(projectId: string, imageData: HttpRequestBody, options?: TrainingAPIClientCreateImagesFromDataOptionalParams): Promise<CreateImagesFromDataResponse>Parameters
- projectId
-
string
The project id.
- imageData
- HttpRequestBody
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
The optional parameters
Returns
Promise<CreateImagesFromDataResponse>
Promise<Models.CreateImagesFromDataResponse>
createImagesFromData(string, HttpRequestBody, TrainingAPIClientCreateImagesFromDataOptionalParams, ServiceCallback<ImageCreateSummary>)
function createImagesFromData(projectId: string, imageData: HttpRequestBody, options: TrainingAPIClientCreateImagesFromDataOptionalParams, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- imageData
- HttpRequestBody
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
The optional parameters
- callback
The callback
createImagesFromFiles(string, ImageFileCreateBatch, RequestOptionsBase)
This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
function createImagesFromFiles(projectId: string, batch: ImageFileCreateBatch, options?: RequestOptionsBase): Promise<CreateImagesFromFilesResponse>Parameters
- projectId
-
string
The project id.
- batch
- ImageFileCreateBatch
The batch of image files to add. Limited to 64 images and 20 tags per batch.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<CreateImagesFromFilesResponse>
Promise<Models.CreateImagesFromFilesResponse>
createImagesFromFiles(string, ImageFileCreateBatch, RequestOptionsBase, ServiceCallback<ImageCreateSummary>)
function createImagesFromFiles(projectId: string, batch: ImageFileCreateBatch, options: RequestOptionsBase, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageFileCreateBatch
The batch of image files to add. Limited to 64 images and 20 tags per batch.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createImagesFromFiles(string, ImageFileCreateBatch, ServiceCallback<ImageCreateSummary>)
function createImagesFromFiles(projectId: string, batch: ImageFileCreateBatch, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageFileCreateBatch
The batch of image files to add. Limited to 64 images and 20 tags per batch.
- callback
The callback
createImagesFromPredictions(string, ImageIdCreateBatch, RequestOptionsBase)
This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
function createImagesFromPredictions(projectId: string, batch: ImageIdCreateBatch, options?: RequestOptionsBase): Promise<CreateImagesFromPredictionsResponse>Parameters
- projectId
-
string
The project id.
- batch
- ImageIdCreateBatch
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<CreateImagesFromPredictionsResponse>
Promise<Models.CreateImagesFromPredictionsResponse>
createImagesFromPredictions(string, ImageIdCreateBatch, RequestOptionsBase, ServiceCallback<ImageCreateSummary>)
function createImagesFromPredictions(projectId: string, batch: ImageIdCreateBatch, options: RequestOptionsBase, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageIdCreateBatch
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createImagesFromPredictions(string, ImageIdCreateBatch, ServiceCallback<ImageCreateSummary>)
function createImagesFromPredictions(projectId: string, batch: ImageIdCreateBatch, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageIdCreateBatch
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
- callback
The callback
createImagesFromUrls(string, ImageUrlCreateBatch, RequestOptionsBase)
This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.
function createImagesFromUrls(projectId: string, batch: ImageUrlCreateBatch, options?: RequestOptionsBase): Promise<CreateImagesFromUrlsResponse>Parameters
- projectId
-
string
The project id.
- batch
- ImageUrlCreateBatch
Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<CreateImagesFromUrlsResponse>
Promise<Models.CreateImagesFromUrlsResponse>
createImagesFromUrls(string, ImageUrlCreateBatch, RequestOptionsBase, ServiceCallback<ImageCreateSummary>)
function createImagesFromUrls(projectId: string, batch: ImageUrlCreateBatch, options: RequestOptionsBase, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageUrlCreateBatch
Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createImagesFromUrls(string, ImageUrlCreateBatch, ServiceCallback<ImageCreateSummary>)
function createImagesFromUrls(projectId: string, batch: ImageUrlCreateBatch, callback: ServiceCallback<ImageCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageUrlCreateBatch
Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
- callback
The callback
createImageTags(string, ImageTagCreateBatch, RequestOptionsBase)
function createImageTags(projectId: string, batch: ImageTagCreateBatch, options?: RequestOptionsBase): Promise<CreateImageTagsResponse>Parameters
- projectId
-
string
The project id.
- batch
- ImageTagCreateBatch
Batch of image tags. Limited to 128 tags per batch.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<CreateImageTagsResponse>
Promise<Models.CreateImageTagsResponse>
createImageTags(string, ImageTagCreateBatch, RequestOptionsBase, ServiceCallback<ImageTagCreateSummary>)
function createImageTags(projectId: string, batch: ImageTagCreateBatch, options: RequestOptionsBase, callback: ServiceCallback<ImageTagCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageTagCreateBatch
Batch of image tags. Limited to 128 tags per batch.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
createImageTags(string, ImageTagCreateBatch, ServiceCallback<ImageTagCreateSummary>)
function createImageTags(projectId: string, batch: ImageTagCreateBatch, callback: ServiceCallback<ImageTagCreateSummary>)Parameters
- projectId
-
string
The project id.
- batch
- ImageTagCreateBatch
Batch of image tags. Limited to 128 tags per batch.
- callback
The callback
createProject(string, ServiceCallback<Project>)
function createProject(name: string, callback: ServiceCallback<Project>)Parameters
- name
-
string
Name of the project.
- callback
The callback
createProject(string, TrainingAPIClientCreateProjectOptionalParams)
function createProject(name: string, options?: TrainingAPIClientCreateProjectOptionalParams): Promise<CreateProjectResponse>Parameters
- name
-
string
Name of the project.
The optional parameters
Returns
Promise<CreateProjectResponse>
Promise<Models.CreateProjectResponse>
createProject(string, TrainingAPIClientCreateProjectOptionalParams, ServiceCallback<Project>)
function createProject(name: string, options: TrainingAPIClientCreateProjectOptionalParams, callback: ServiceCallback<Project>)Parameters
- name
-
string
Name of the project.
The optional parameters
- callback
The callback
createTag(string, string, ServiceCallback<Tag>)
function createTag(projectId: string, name: string, callback: ServiceCallback<Tag>)Parameters
- projectId
-
string
The project id.
- name
-
string
The tag name.
- callback
The callback
createTag(string, string, TrainingAPIClientCreateTagOptionalParams)
function createTag(projectId: string, name: string, options?: TrainingAPIClientCreateTagOptionalParams): Promise<CreateTagResponse>Parameters
- projectId
-
string
The project id.
- name
-
string
The tag name.
The optional parameters
Returns
Promise<CreateTagResponse>
Promise<Models.CreateTagResponse>
createTag(string, string, TrainingAPIClientCreateTagOptionalParams, ServiceCallback<Tag>)
function createTag(projectId: string, name: string, options: TrainingAPIClientCreateTagOptionalParams, callback: ServiceCallback<Tag>)Parameters
- projectId
-
string
The project id.
- name
-
string
The tag name.
The optional parameters
- callback
The callback
deleteImageRegions(string, string[], RequestOptionsBase)
function deleteImageRegions(projectId: string, regionIds: string[], options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- regionIds
-
string[]
Regions to delete. Limited to 64.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteImageRegions(string, string[], RequestOptionsBase, ServiceCallback<void>)
function deleteImageRegions(projectId: string, regionIds: string[], options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- regionIds
-
string[]
Regions to delete. Limited to 64.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteImageRegions(string, string[], ServiceCallback<void>)
function deleteImageRegions(projectId: string, regionIds: string[], callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- regionIds
-
string[]
Regions to delete. Limited to 64.
- callback
-
ServiceCallback<void>
The callback
deleteImages(string, ServiceCallback<void>)
function deleteImages(projectId: string, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- callback
-
ServiceCallback<void>
The callback
deleteImages(string, TrainingAPIClientDeleteImagesOptionalParams)
function deleteImages(projectId: string, options?: TrainingAPIClientDeleteImagesOptionalParams): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteImages(string, TrainingAPIClientDeleteImagesOptionalParams, ServiceCallback<void>)
function deleteImages(projectId: string, options: TrainingAPIClientDeleteImagesOptionalParams, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteImageTags(string, string[], string[], RequestOptionsBase)
function deleteImageTags(projectId: string, imageIds: string[], tagIds: string[], options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- imageIds
-
string[]
Image ids. Limited to 64 images.
- tagIds
-
string[]
Tags to be deleted from the specified images. Limited to 20 tags.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteImageTags(string, string[], string[], RequestOptionsBase, ServiceCallback<void>)
function deleteImageTags(projectId: string, imageIds: string[], tagIds: string[], options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- imageIds
-
string[]
Image ids. Limited to 64 images.
- tagIds
-
string[]
Tags to be deleted from the specified images. Limited to 20 tags.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteImageTags(string, string[], string[], ServiceCallback<void>)
function deleteImageTags(projectId: string, imageIds: string[], tagIds: string[], callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- imageIds
-
string[]
Image ids. Limited to 64 images.
- tagIds
-
string[]
Tags to be deleted from the specified images. Limited to 20 tags.
- callback
-
ServiceCallback<void>
The callback
deleteIteration(string, string, RequestOptionsBase)
function deleteIteration(projectId: string, iterationId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteIteration(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteIteration(projectId: string, iterationId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteIteration(string, string, ServiceCallback<void>)
function deleteIteration(projectId: string, iterationId: string, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- callback
-
ServiceCallback<void>
The callback
deletePrediction(string, string[], RequestOptionsBase)
function deletePrediction(projectId: string, ids: string[], options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- ids
-
string[]
The prediction ids. Limited to 64.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deletePrediction(string, string[], RequestOptionsBase, ServiceCallback<void>)
function deletePrediction(projectId: string, ids: string[], options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- ids
-
string[]
The prediction ids. Limited to 64.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deletePrediction(string, string[], ServiceCallback<void>)
function deletePrediction(projectId: string, ids: string[], callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- ids
-
string[]
The prediction ids. Limited to 64.
- callback
-
ServiceCallback<void>
The callback
deleteProject(string, RequestOptionsBase)
function deleteProject(projectId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteProject(string, RequestOptionsBase, ServiceCallback<void>)
function deleteProject(projectId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteProject(string, ServiceCallback<void>)
function deleteProject(projectId: string, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- callback
-
ServiceCallback<void>
The callback
deleteTag(string, string, RequestOptionsBase)
function deleteTag(projectId: string, tagId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- tagId
-
string
Id of the tag to be deleted.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
deleteTag(string, string, RequestOptionsBase, ServiceCallback<void>)
function deleteTag(projectId: string, tagId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- tagId
-
string
Id of the tag to be deleted.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteTag(string, string, ServiceCallback<void>)
function deleteTag(projectId: string, tagId: string, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- tagId
-
string
Id of the tag to be deleted.
- callback
-
ServiceCallback<void>
The callback
exportIteration(string, string, Platform, ServiceCallback<ExportModel>)
function exportIteration(projectId: string, iterationId: string, platform: Platform, callback: ServiceCallback<ExportModel>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- platform
- Platform
The target platform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK', 'OpenVino'
- callback
The callback
exportIteration(string, string, Platform, TrainingAPIClientExportIterationOptionalParams)
function exportIteration(projectId: string, iterationId: string, platform: Platform, options?: TrainingAPIClientExportIterationOptionalParams): Promise<ExportIterationResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- platform
- Platform
The target platform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK', 'OpenVino'
The optional parameters
Returns
Promise<ExportIterationResponse>
Promise<Models.ExportIterationResponse>
exportIteration(string, string, Platform, TrainingAPIClientExportIterationOptionalParams, ServiceCallback<ExportModel>)
function exportIteration(projectId: string, iterationId: string, platform: Platform, options: TrainingAPIClientExportIterationOptionalParams, callback: ServiceCallback<ExportModel>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- platform
- Platform
The target platform. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK', 'OpenVino'
The optional parameters
- callback
The callback
exportProject(string, RequestOptionsBase)
function exportProject(projectId: string, options?: RequestOptionsBase): Promise<ExportProjectResponse>Parameters
- projectId
-
string
The project id of the project to export.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ExportProjectResponse>
Promise<Models.ExportProjectResponse>
exportProject(string, RequestOptionsBase, ServiceCallback<ProjectExport>)
function exportProject(projectId: string, options: RequestOptionsBase, callback: ServiceCallback<ProjectExport>)Parameters
- projectId
-
string
The project id of the project to export.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
exportProject(string, ServiceCallback<ProjectExport>)
function exportProject(projectId: string, callback: ServiceCallback<ProjectExport>)Parameters
- projectId
-
string
The project id of the project to export.
- callback
The callback
getArtifact(string, string, RequestOptionsBase)
function getArtifact(projectId: string, path: string, options?: RequestOptionsBase): Promise<GetArtifactResponse>Parameters
- projectId
-
string
The project id.
- path
-
string
The relative path for artifact.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetArtifactResponse>
Promise<Models.GetArtifactResponse>
getArtifact(string, string, RequestOptionsBase, ServiceCallback<void>)
function getArtifact(projectId: string, path: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- path
-
string
The relative path for artifact.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getArtifact(string, string, ServiceCallback<void>)
function getArtifact(projectId: string, path: string, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- path
-
string
The relative path for artifact.
- callback
-
ServiceCallback<void>
The callback
getDomain(string, RequestOptionsBase)
function getDomain(domainId: string, options?: RequestOptionsBase): Promise<GetDomainResponse>Parameters
- domainId
-
string
The id of the domain to get information about.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetDomainResponse>
Promise<Models.GetDomainResponse>
getDomain(string, RequestOptionsBase, ServiceCallback<Domain>)
function getDomain(domainId: string, options: RequestOptionsBase, callback: ServiceCallback<Domain>)Parameters
- domainId
-
string
The id of the domain to get information about.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getDomain(string, ServiceCallback<Domain>)
function getDomain(domainId: string, callback: ServiceCallback<Domain>)Parameters
- domainId
-
string
The id of the domain to get information about.
- callback
The callback
getDomains(RequestOptionsBase)
function getDomains(options?: RequestOptionsBase): Promise<GetDomainsResponse>Parameters
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetDomainsResponse>
Promise<Models.GetDomainsResponse>
getDomains(RequestOptionsBase, ServiceCallback<Domain[]>)
function getDomains(options: RequestOptionsBase, callback: ServiceCallback<Domain[]>)Parameters
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getDomains(ServiceCallback<Domain[]>)
function getDomains(callback: ServiceCallback<Domain[]>)Parameters
- callback
The callback
getExports(string, string, RequestOptionsBase)
function getExports(projectId: string, iterationId: string, options?: RequestOptionsBase): Promise<GetExportsResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetExportsResponse>
Promise<Models.GetExportsResponse>
getExports(string, string, RequestOptionsBase, ServiceCallback<ExportModel[]>)
function getExports(projectId: string, iterationId: string, options: RequestOptionsBase, callback: ServiceCallback<ExportModel[]>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getExports(string, string, ServiceCallback<ExportModel[]>)
function getExports(projectId: string, iterationId: string, callback: ServiceCallback<ExportModel[]>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- callback
The callback
getImageCount(string, ServiceCallback<number>)
function getImageCount(projectId: string, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
- callback
-
ServiceCallback<number>
The callback
getImageCount(string, TrainingAPIClientGetImageCountOptionalParams)
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
function getImageCount(projectId: string, options?: TrainingAPIClientGetImageCountOptionalParams): Promise<GetImageCountResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetImageCountResponse>
Promise<Models.GetImageCountResponse>
getImageCount(string, TrainingAPIClientGetImageCountOptionalParams, ServiceCallback<number>)
function getImageCount(projectId: string, options: TrainingAPIClientGetImageCountOptionalParams, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
-
ServiceCallback<number>
The callback
getImagePerformanceCount(string, string, ServiceCallback<number>)
function getImagePerformanceCount(projectId: string, iterationId: string, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id. Defaults to workspace.
- callback
-
ServiceCallback<number>
The callback
getImagePerformanceCount(string, string, TrainingAPIClientGetImagePerformanceCountOptionalParams)
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
function getImagePerformanceCount(projectId: string, iterationId: string, options?: TrainingAPIClientGetImagePerformanceCountOptionalParams): Promise<GetImagePerformanceCountResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id. Defaults to workspace.
The optional parameters
Returns
Promise<GetImagePerformanceCountResponse>
Promise<Models.GetImagePerformanceCountResponse>
getImagePerformanceCount(string, string, TrainingAPIClientGetImagePerformanceCountOptionalParams, ServiceCallback<number>)
function getImagePerformanceCount(projectId: string, iterationId: string, options: TrainingAPIClientGetImagePerformanceCountOptionalParams, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id. Defaults to workspace.
The optional parameters
- callback
-
ServiceCallback<number>
The callback
getImagePerformances(string, string, ServiceCallback<ImagePerformance[]>)
function getImagePerformances(projectId: string, iterationId: string, callback: ServiceCallback<ImagePerformance[]>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id. Defaults to workspace.
- callback
The callback
getImagePerformances(string, string, TrainingAPIClientGetImagePerformancesOptionalParams)
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
function getImagePerformances(projectId: string, iterationId: string, options?: TrainingAPIClientGetImagePerformancesOptionalParams): Promise<GetImagePerformancesResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id. Defaults to workspace.
The optional parameters
Returns
Promise<GetImagePerformancesResponse>
Promise<Models.GetImagePerformancesResponse>
getImagePerformances(string, string, TrainingAPIClientGetImagePerformancesOptionalParams, ServiceCallback<ImagePerformance[]>)
function getImagePerformances(projectId: string, iterationId: string, options: TrainingAPIClientGetImagePerformancesOptionalParams, callback: ServiceCallback<ImagePerformance[]>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id. Defaults to workspace.
The optional parameters
- callback
The callback
getImageRegionProposals(string, string, RequestOptionsBase)
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.
function getImageRegionProposals(projectId: string, imageId: string, options?: RequestOptionsBase): Promise<GetImageRegionProposalsResponse>Parameters
- projectId
-
string
The project id.
- imageId
-
string
The image id.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetImageRegionProposalsResponse>
Promise<Models.GetImageRegionProposalsResponse>
getImageRegionProposals(string, string, RequestOptionsBase, ServiceCallback<ImageRegionProposal>)
function getImageRegionProposals(projectId: string, imageId: string, options: RequestOptionsBase, callback: ServiceCallback<ImageRegionProposal>)Parameters
- projectId
-
string
The project id.
- imageId
-
string
The image id.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getImageRegionProposals(string, string, ServiceCallback<ImageRegionProposal>)
function getImageRegionProposals(projectId: string, imageId: string, callback: ServiceCallback<ImageRegionProposal>)Parameters
- projectId
-
string
The project id.
- imageId
-
string
The image id.
- callback
The callback
getImages(string, ServiceCallback<Image[]>)
function getImages(projectId: string, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
- callback
The callback
getImages(string, TrainingAPIClientGetImagesOptionalParams)
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
function getImages(projectId: string, options?: TrainingAPIClientGetImagesOptionalParams): Promise<GetImagesResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetImagesResponse>
Promise<Models.GetImagesResponse>
getImages(string, TrainingAPIClientGetImagesOptionalParams, ServiceCallback<Image[]>)
function getImages(projectId: string, options: TrainingAPIClientGetImagesOptionalParams, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
The callback
getImagesByIds(string, ServiceCallback<Image[]>)
function getImagesByIds(projectId: string, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
- callback
The callback
getImagesByIds(string, TrainingAPIClientGetImagesByIdsOptionalParams)
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.
function getImagesByIds(projectId: string, options?: TrainingAPIClientGetImagesByIdsOptionalParams): Promise<GetImagesByIdsResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetImagesByIdsResponse>
Promise<Models.GetImagesByIdsResponse>
getImagesByIds(string, TrainingAPIClientGetImagesByIdsOptionalParams, ServiceCallback<Image[]>)
function getImagesByIds(projectId: string, options: TrainingAPIClientGetImagesByIdsOptionalParams, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
The callback
getIteration(string, string, RequestOptionsBase)
function getIteration(projectId: string, iterationId: string, options?: RequestOptionsBase): Promise<GetIterationResponse>Parameters
- projectId
-
string
The id of the project the iteration belongs to.
- iterationId
-
string
The id of the iteration to get.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetIterationResponse>
Promise<Models.GetIterationResponse>
getIteration(string, string, RequestOptionsBase, ServiceCallback<Iteration>)
function getIteration(projectId: string, iterationId: string, options: RequestOptionsBase, callback: ServiceCallback<Iteration>)Parameters
- projectId
-
string
The id of the project the iteration belongs to.
- iterationId
-
string
The id of the iteration to get.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getIteration(string, string, ServiceCallback<Iteration>)
function getIteration(projectId: string, iterationId: string, callback: ServiceCallback<Iteration>)Parameters
- projectId
-
string
The id of the project the iteration belongs to.
- iterationId
-
string
The id of the iteration to get.
- callback
The callback
getIterationPerformance(string, string, ServiceCallback<IterationPerformance>)
function getIterationPerformance(projectId: string, iterationId: string, callback: ServiceCallback<IterationPerformance>)Parameters
- projectId
-
string
The id of the project the iteration belongs to.
- iterationId
-
string
The id of the iteration to get.
- callback
The callback
getIterationPerformance(string, string, TrainingAPIClientGetIterationPerformanceOptionalParams)
function getIterationPerformance(projectId: string, iterationId: string, options?: TrainingAPIClientGetIterationPerformanceOptionalParams): Promise<GetIterationPerformanceResponse>Parameters
- projectId
-
string
The id of the project the iteration belongs to.
- iterationId
-
string
The id of the iteration to get.
The optional parameters
Returns
Promise<GetIterationPerformanceResponse>
Promise<Models.GetIterationPerformanceResponse>
getIterationPerformance(string, string, TrainingAPIClientGetIterationPerformanceOptionalParams, ServiceCallback<IterationPerformance>)
function getIterationPerformance(projectId: string, iterationId: string, options: TrainingAPIClientGetIterationPerformanceOptionalParams, callback: ServiceCallback<IterationPerformance>)Parameters
- projectId
-
string
The id of the project the iteration belongs to.
- iterationId
-
string
The id of the iteration to get.
The optional parameters
- callback
The callback
getIterations(string, RequestOptionsBase)
function getIterations(projectId: string, options?: RequestOptionsBase): Promise<GetIterationsResponse>Parameters
- projectId
-
string
The project id.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetIterationsResponse>
Promise<Models.GetIterationsResponse>
getIterations(string, RequestOptionsBase, ServiceCallback<Iteration[]>)
function getIterations(projectId: string, options: RequestOptionsBase, callback: ServiceCallback<Iteration[]>)Parameters
- projectId
-
string
The project id.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getIterations(string, ServiceCallback<Iteration[]>)
function getIterations(projectId: string, callback: ServiceCallback<Iteration[]>)Parameters
- projectId
-
string
The project id.
- callback
The callback
getProject(string, RequestOptionsBase)
function getProject(projectId: string, options?: RequestOptionsBase): Promise<GetProjectResponse>Parameters
- projectId
-
string
The id of the project to get.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetProjectResponse>
Promise<Models.GetProjectResponse>
getProject(string, RequestOptionsBase, ServiceCallback<Project>)
function getProject(projectId: string, options: RequestOptionsBase, callback: ServiceCallback<Project>)Parameters
- projectId
-
string
The id of the project to get.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getProject(string, ServiceCallback<Project>)
function getProject(projectId: string, callback: ServiceCallback<Project>)Parameters
- projectId
-
string
The id of the project to get.
- callback
The callback
getProjects(RequestOptionsBase)
function getProjects(options?: RequestOptionsBase): Promise<GetProjectsResponse>Parameters
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<GetProjectsResponse>
Promise<Models.GetProjectsResponse>
getProjects(RequestOptionsBase, ServiceCallback<Project[]>)
function getProjects(options: RequestOptionsBase, callback: ServiceCallback<Project[]>)Parameters
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getProjects(ServiceCallback<Project[]>)
function getProjects(callback: ServiceCallback<Project[]>)Parameters
- callback
The callback
getTag(string, string, ServiceCallback<Tag>)
function getTag(projectId: string, tagId: string, callback: ServiceCallback<Tag>)Parameters
- projectId
-
string
The project this tag belongs to.
- tagId
-
string
The tag id.
- callback
The callback
getTag(string, string, TrainingAPIClientGetTagOptionalParams)
function getTag(projectId: string, tagId: string, options?: TrainingAPIClientGetTagOptionalParams): Promise<GetTagResponse>Parameters
- projectId
-
string
The project this tag belongs to.
- tagId
-
string
The tag id.
The optional parameters
Returns
Promise<GetTagResponse>
Promise<Models.GetTagResponse>
getTag(string, string, TrainingAPIClientGetTagOptionalParams, ServiceCallback<Tag>)
function getTag(projectId: string, tagId: string, options: TrainingAPIClientGetTagOptionalParams, callback: ServiceCallback<Tag>)Parameters
- projectId
-
string
The project this tag belongs to.
- tagId
-
string
The tag id.
The optional parameters
- callback
The callback
getTaggedImageCount(string, ServiceCallback<number>)
function getTaggedImageCount(projectId: string, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
- callback
-
ServiceCallback<number>
The callback
getTaggedImageCount(string, TrainingAPIClientGetTaggedImageCountOptionalParams)
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
function getTaggedImageCount(projectId: string, options?: TrainingAPIClientGetTaggedImageCountOptionalParams): Promise<GetTaggedImageCountResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetTaggedImageCountResponse>
Promise<Models.GetTaggedImageCountResponse>
getTaggedImageCount(string, TrainingAPIClientGetTaggedImageCountOptionalParams, ServiceCallback<number>)
function getTaggedImageCount(projectId: string, options: TrainingAPIClientGetTaggedImageCountOptionalParams, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
-
ServiceCallback<number>
The callback
getTaggedImages(string, ServiceCallback<Image[]>)
function getTaggedImages(projectId: string, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
- callback
The callback
getTaggedImages(string, TrainingAPIClientGetTaggedImagesOptionalParams)
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
function getTaggedImages(projectId: string, options?: TrainingAPIClientGetTaggedImagesOptionalParams): Promise<GetTaggedImagesResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetTaggedImagesResponse>
Promise<Models.GetTaggedImagesResponse>
getTaggedImages(string, TrainingAPIClientGetTaggedImagesOptionalParams, ServiceCallback<Image[]>)
function getTaggedImages(projectId: string, options: TrainingAPIClientGetTaggedImagesOptionalParams, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
The callback
getTags(string, ServiceCallback<Tag[]>)
function getTags(projectId: string, callback: ServiceCallback<Tag[]>)Parameters
- projectId
-
string
The project id.
- callback
The callback
getTags(string, TrainingAPIClientGetTagsOptionalParams)
function getTags(projectId: string, options?: TrainingAPIClientGetTagsOptionalParams): Promise<GetTagsResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetTagsResponse>
Promise<Models.GetTagsResponse>
getTags(string, TrainingAPIClientGetTagsOptionalParams, ServiceCallback<Tag[]>)
function getTags(projectId: string, options: TrainingAPIClientGetTagsOptionalParams, callback: ServiceCallback<Tag[]>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
The callback
getUntaggedImageCount(string, ServiceCallback<number>)
function getUntaggedImageCount(projectId: string, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
- callback
-
ServiceCallback<number>
The callback
getUntaggedImageCount(string, TrainingAPIClientGetUntaggedImageCountOptionalParams)
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.
function getUntaggedImageCount(projectId: string, options?: TrainingAPIClientGetUntaggedImageCountOptionalParams): Promise<GetUntaggedImageCountResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetUntaggedImageCountResponse>
Promise<Models.GetUntaggedImageCountResponse>
getUntaggedImageCount(string, TrainingAPIClientGetUntaggedImageCountOptionalParams, ServiceCallback<number>)
function getUntaggedImageCount(projectId: string, options: TrainingAPIClientGetUntaggedImageCountOptionalParams, callback: ServiceCallback<number>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
-
ServiceCallback<number>
The callback
getUntaggedImages(string, ServiceCallback<Image[]>)
function getUntaggedImages(projectId: string, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
- callback
The callback
getUntaggedImages(string, TrainingAPIClientGetUntaggedImagesOptionalParams)
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.
function getUntaggedImages(projectId: string, options?: TrainingAPIClientGetUntaggedImagesOptionalParams): Promise<GetUntaggedImagesResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<GetUntaggedImagesResponse>
Promise<Models.GetUntaggedImagesResponse>
getUntaggedImages(string, TrainingAPIClientGetUntaggedImagesOptionalParams, ServiceCallback<Image[]>)
function getUntaggedImages(projectId: string, options: TrainingAPIClientGetUntaggedImagesOptionalParams, callback: ServiceCallback<Image[]>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
The callback
importProject(string, ServiceCallback<Project>)
function importProject(token: string, callback: ServiceCallback<Project>)Parameters
- token
-
string
Token generated from the export project call.
- callback
The callback
importProject(string, TrainingAPIClientImportProjectOptionalParams)
function importProject(token: string, options?: TrainingAPIClientImportProjectOptionalParams): Promise<ImportProjectResponse>Parameters
- token
-
string
Token generated from the export project call.
The optional parameters
Returns
Promise<ImportProjectResponse>
Promise<Models.ImportProjectResponse>
importProject(string, TrainingAPIClientImportProjectOptionalParams, ServiceCallback<Project>)
function importProject(token: string, options: TrainingAPIClientImportProjectOptionalParams, callback: ServiceCallback<Project>)Parameters
- token
-
string
Token generated from the export project call.
The optional parameters
- callback
The callback
publishIteration(string, string, string, string, ServiceCallback<boolean>)
function publishIteration(projectId: string, iterationId: string, publishName: string, predictionId: string, callback: ServiceCallback<boolean>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- publishName
-
string
The name to give the published iteration.
- predictionId
-
string
The id of the prediction resource to publish to.
- callback
-
ServiceCallback<boolean>
The callback
publishIteration(string, string, string, string, TrainingAPIClientPublishIterationOptionalParams)
function publishIteration(projectId: string, iterationId: string, publishName: string, predictionId: string, options?: TrainingAPIClientPublishIterationOptionalParams): Promise<PublishIterationResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- publishName
-
string
The name to give the published iteration.
- predictionId
-
string
The id of the prediction resource to publish to.
The optional parameters
Returns
Promise<PublishIterationResponse>
Promise<Models.PublishIterationResponse>
publishIteration(string, string, string, string, TrainingAPIClientPublishIterationOptionalParams, ServiceCallback<boolean>)
function publishIteration(projectId: string, iterationId: string, publishName: string, predictionId: string, options: TrainingAPIClientPublishIterationOptionalParams, callback: ServiceCallback<boolean>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- publishName
-
string
The name to give the published iteration.
- predictionId
-
string
The id of the prediction resource to publish to.
The optional parameters
- callback
-
ServiceCallback<boolean>
The callback
queryPredictions(string, PredictionQueryToken, RequestOptionsBase)
function queryPredictions(projectId: string, query: PredictionQueryToken, options?: RequestOptionsBase): Promise<QueryPredictionsResponse>Parameters
- projectId
-
string
The project id.
- query
- PredictionQueryToken
Parameters used to query the predictions. Limited to combining 2 tags.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<QueryPredictionsResponse>
Promise<Models.QueryPredictionsResponse>
queryPredictions(string, PredictionQueryToken, RequestOptionsBase, ServiceCallback<PredictionQueryResult>)
function queryPredictions(projectId: string, query: PredictionQueryToken, options: RequestOptionsBase, callback: ServiceCallback<PredictionQueryResult>)Parameters
- projectId
-
string
The project id.
- query
- PredictionQueryToken
Parameters used to query the predictions. Limited to combining 2 tags.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
queryPredictions(string, PredictionQueryToken, ServiceCallback<PredictionQueryResult>)
function queryPredictions(projectId: string, query: PredictionQueryToken, callback: ServiceCallback<PredictionQueryResult>)Parameters
- projectId
-
string
The project id.
- query
- PredictionQueryToken
Parameters used to query the predictions. Limited to combining 2 tags.
- callback
The callback
querySuggestedImageCount(string, string, TagFilter, RequestOptionsBase)
This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.
function querySuggestedImageCount(projectId: string, iterationId: string, query: TagFilter, options?: RequestOptionsBase): Promise<QuerySuggestedImageCountResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for the suggested tags and regions.
- query
- TagFilter
Model that contains tagIds, threshold and projectType to query by.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<QuerySuggestedImageCountResponse>
Promise<Models.QuerySuggestedImageCountResponse>
querySuggestedImageCount(string, string, TagFilter, RequestOptionsBase, ServiceCallback<{[propertyName: string]: number}>)
function querySuggestedImageCount(projectId: string, iterationId: string, query: TagFilter, options: RequestOptionsBase, callback: ServiceCallback<{[propertyName: string]: number}>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for the suggested tags and regions.
- query
- TagFilter
Model that contains tagIds, threshold and projectType to query by.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<{[propertyName: string]: number}>
The callback
querySuggestedImageCount(string, string, TagFilter, ServiceCallback<{[propertyName: string]: number}>)
function querySuggestedImageCount(projectId: string, iterationId: string, query: TagFilter, callback: ServiceCallback<{[propertyName: string]: number}>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for the suggested tags and regions.
- query
- TagFilter
Model that contains tagIds, threshold and projectType to query by.
- callback
-
ServiceCallback<{[propertyName: string]: number}>
The callback
querySuggestedImages(string, string, SuggestedTagAndRegionQueryToken, RequestOptionsBase)
This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
function querySuggestedImages(projectId: string, iterationId: string, query: SuggestedTagAndRegionQueryToken, options?: RequestOptionsBase): Promise<QuerySuggestedImagesResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for the suggested tags and regions.
Contains properties we need to query suggested images.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<QuerySuggestedImagesResponse>
Promise<Models.QuerySuggestedImagesResponse>
querySuggestedImages(string, string, SuggestedTagAndRegionQueryToken, RequestOptionsBase, ServiceCallback<SuggestedTagAndRegionQuery>)
function querySuggestedImages(projectId: string, iterationId: string, query: SuggestedTagAndRegionQueryToken, options: RequestOptionsBase, callback: ServiceCallback<SuggestedTagAndRegionQuery>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for the suggested tags and regions.
Contains properties we need to query suggested images.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
querySuggestedImages(string, string, SuggestedTagAndRegionQueryToken, ServiceCallback<SuggestedTagAndRegionQuery>)
function querySuggestedImages(projectId: string, iterationId: string, query: SuggestedTagAndRegionQueryToken, callback: ServiceCallback<SuggestedTagAndRegionQuery>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for the suggested tags and regions.
Contains properties we need to query suggested images.
- callback
The callback
quickTestImage(string, HttpRequestBody, ServiceCallback<ImagePrediction>)
function quickTestImage(projectId: string, imageData: HttpRequestBody, callback: ServiceCallback<ImagePrediction>)Parameters
- projectId
-
string
The project id.
- imageData
- HttpRequestBody
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
- callback
The callback
quickTestImage(string, HttpRequestBody, TrainingAPIClientQuickTestImageOptionalParams)
function quickTestImage(projectId: string, imageData: HttpRequestBody, options?: TrainingAPIClientQuickTestImageOptionalParams): Promise<QuickTestImageResponse>Parameters
- projectId
-
string
The project id.
- imageData
- HttpRequestBody
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
The optional parameters
Returns
Promise<QuickTestImageResponse>
Promise<Models.QuickTestImageResponse>
quickTestImage(string, HttpRequestBody, TrainingAPIClientQuickTestImageOptionalParams, ServiceCallback<ImagePrediction>)
function quickTestImage(projectId: string, imageData: HttpRequestBody, options: TrainingAPIClientQuickTestImageOptionalParams, callback: ServiceCallback<ImagePrediction>)Parameters
- projectId
-
string
The project id.
- imageData
- HttpRequestBody
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
The optional parameters
- callback
The callback
quickTestImageUrl(string, ImageUrl, ServiceCallback<ImagePrediction>)
function quickTestImageUrl(projectId: string, imageUrl: ImageUrl, callback: ServiceCallback<ImagePrediction>)Parameters
- projectId
-
string
The project to evaluate against.
- imageUrl
- ImageUrl
An ImageUrl that contains the url of the image to be evaluated.
- callback
The callback
quickTestImageUrl(string, ImageUrl, TrainingAPIClientQuickTestImageUrlOptionalParams)
function quickTestImageUrl(projectId: string, imageUrl: ImageUrl, options?: TrainingAPIClientQuickTestImageUrlOptionalParams): Promise<QuickTestImageUrlResponse>Parameters
- projectId
-
string
The project to evaluate against.
- imageUrl
- ImageUrl
An ImageUrl that contains the url of the image to be evaluated.
The optional parameters
Returns
Promise<QuickTestImageUrlResponse>
Promise<Models.QuickTestImageUrlResponse>
quickTestImageUrl(string, ImageUrl, TrainingAPIClientQuickTestImageUrlOptionalParams, ServiceCallback<ImagePrediction>)
function quickTestImageUrl(projectId: string, imageUrl: ImageUrl, options: TrainingAPIClientQuickTestImageUrlOptionalParams, callback: ServiceCallback<ImagePrediction>)Parameters
- projectId
-
string
The project to evaluate against.
- imageUrl
- ImageUrl
An ImageUrl that contains the url of the image to be evaluated.
The optional parameters
- callback
The callback
suggestTagsAndRegions(string, string, string[], RequestOptionsBase)
This API will get suggested tags and regions for an array/batch of untagged images along with confidences for the tags. It returns an empty array if no tags are found. There is a limit of 64 images in the batch.
function suggestTagsAndRegions(projectId: string, iterationId: string, imageIds: string[], options?: RequestOptionsBase): Promise<SuggestTagsAndRegionsResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for tag and region suggestion.
- imageIds
-
string[]
Array of image ids tag suggestion are needed for. Use GetUntaggedImages API to get imageIds.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<SuggestTagsAndRegionsResponse>
Promise<Models.SuggestTagsAndRegionsResponse>
suggestTagsAndRegions(string, string, string[], RequestOptionsBase, ServiceCallback<SuggestedTagAndRegion[]>)
function suggestTagsAndRegions(projectId: string, iterationId: string, imageIds: string[], options: RequestOptionsBase, callback: ServiceCallback<SuggestedTagAndRegion[]>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for tag and region suggestion.
- imageIds
-
string[]
Array of image ids tag suggestion are needed for. Use GetUntaggedImages API to get imageIds.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
suggestTagsAndRegions(string, string, string[], ServiceCallback<SuggestedTagAndRegion[]>)
function suggestTagsAndRegions(projectId: string, iterationId: string, imageIds: string[], callback: ServiceCallback<SuggestedTagAndRegion[]>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
IterationId to use for tag and region suggestion.
- imageIds
-
string[]
Array of image ids tag suggestion are needed for. Use GetUntaggedImages API to get imageIds.
- callback
The callback
trainProject(string, ServiceCallback<Iteration>)
function trainProject(projectId: string, callback: ServiceCallback<Iteration>)Parameters
- projectId
-
string
The project id.
- callback
The callback
trainProject(string, TrainingAPIClientTrainProjectOptionalParams)
function trainProject(projectId: string, options?: TrainingAPIClientTrainProjectOptionalParams): Promise<TrainProjectResponse>Parameters
- projectId
-
string
The project id.
The optional parameters
Returns
Promise<TrainProjectResponse>
Promise<Models.TrainProjectResponse>
trainProject(string, TrainingAPIClientTrainProjectOptionalParams, ServiceCallback<Iteration>)
function trainProject(projectId: string, options: TrainingAPIClientTrainProjectOptionalParams, callback: ServiceCallback<Iteration>)Parameters
- projectId
-
string
The project id.
The optional parameters
- callback
The callback
unpublishIteration(string, string, RequestOptionsBase)
function unpublishIteration(projectId: string, iterationId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
unpublishIteration(string, string, RequestOptionsBase, ServiceCallback<void>)
function unpublishIteration(projectId: string, iterationId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
unpublishIteration(string, string, ServiceCallback<void>)
function unpublishIteration(projectId: string, iterationId: string, callback: ServiceCallback<void>)Parameters
- projectId
-
string
The project id.
- iterationId
-
string
The iteration id.
- callback
-
ServiceCallback<void>
The callback
updateImageMetadata(string, string[], {[propertyName: string]: string}, RequestOptionsBase)
This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.
function updateImageMetadata(projectId: string, imageIds: string[], metadata: {[propertyName: string]: string}, options?: RequestOptionsBase): Promise<UpdateImageMetadataResponse>Parameters
- projectId
-
string
The project id.
- imageIds
-
string[]
The list of image ids to update. Limited to 64.
- metadata
-
{[propertyName: string]: string}
The metadata to be updated to the specified images. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limited to 256.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<UpdateImageMetadataResponse>
Promise<Models.UpdateImageMetadataResponse>
updateImageMetadata(string, string[], {[propertyName: string]: string}, RequestOptionsBase, ServiceCallback<ImageMetadataUpdateSummary>)
function updateImageMetadata(projectId: string, imageIds: string[], metadata: {[propertyName: string]: string}, options: RequestOptionsBase, callback: ServiceCallback<ImageMetadataUpdateSummary>)Parameters
- projectId
-
string
The project id.
- imageIds
-
string[]
The list of image ids to update. Limited to 64.
- metadata
-
{[propertyName: string]: string}
The metadata to be updated to the specified images. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limited to 256.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
updateImageMetadata(string, string[], {[propertyName: string]: string}, ServiceCallback<ImageMetadataUpdateSummary>)
function updateImageMetadata(projectId: string, imageIds: string[], metadata: {[propertyName: string]: string}, callback: ServiceCallback<ImageMetadataUpdateSummary>)Parameters
- projectId
-
string
The project id.
- imageIds
-
string[]
The list of image ids to update. Limited to 64.
- metadata
-
{[propertyName: string]: string}
The metadata to be updated to the specified images. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limited to 256.
- callback
The callback
updateIteration(string, string, Iteration, RequestOptionsBase)
function updateIteration(projectId: string, iterationId: string, updatedIteration: Iteration, options?: RequestOptionsBase): Promise<UpdateIterationResponse>Parameters
- projectId
-
string
Project id.
- iterationId
-
string
Iteration id.
- updatedIteration
- Iteration
The updated iteration model.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<UpdateIterationResponse>
Promise<Models.UpdateIterationResponse>
updateIteration(string, string, Iteration, RequestOptionsBase, ServiceCallback<Iteration>)
function updateIteration(projectId: string, iterationId: string, updatedIteration: Iteration, options: RequestOptionsBase, callback: ServiceCallback<Iteration>)Parameters
- projectId
-
string
Project id.
- iterationId
-
string
Iteration id.
- updatedIteration
- Iteration
The updated iteration model.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
updateIteration(string, string, Iteration, ServiceCallback<Iteration>)
function updateIteration(projectId: string, iterationId: string, updatedIteration: Iteration, callback: ServiceCallback<Iteration>)Parameters
- projectId
-
string
Project id.
- iterationId
-
string
Iteration id.
- updatedIteration
- Iteration
The updated iteration model.
- callback
The callback
updateProject(string, Project, RequestOptionsBase)
function updateProject(projectId: string, updatedProject: Project, options?: RequestOptionsBase): Promise<UpdateProjectResponse>Parameters
- projectId
-
string
The id of the project to update.
- updatedProject
- Project
The updated project model.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<UpdateProjectResponse>
Promise<Models.UpdateProjectResponse>
updateProject(string, Project, RequestOptionsBase, ServiceCallback<Project>)
function updateProject(projectId: string, updatedProject: Project, options: RequestOptionsBase, callback: ServiceCallback<Project>)Parameters
- projectId
-
string
The id of the project to update.
- updatedProject
- Project
The updated project model.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
updateProject(string, Project, ServiceCallback<Project>)
function updateProject(projectId: string, updatedProject: Project, callback: ServiceCallback<Project>)Parameters
- projectId
-
string
The id of the project to update.
- updatedProject
- Project
The updated project model.
- callback
The callback
updateTag(string, string, Tag, RequestOptionsBase)
function updateTag(projectId: string, tagId: string, updatedTag: Tag, options?: RequestOptionsBase): Promise<UpdateTagResponse>Parameters
- projectId
-
string
The project id.
- tagId
-
string
The id of the target tag.
- updatedTag
- Tag
The updated tag model.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<UpdateTagResponse>
Promise<Models.UpdateTagResponse>
updateTag(string, string, Tag, RequestOptionsBase, ServiceCallback<Tag>)
function updateTag(projectId: string, tagId: string, updatedTag: Tag, options: RequestOptionsBase, callback: ServiceCallback<Tag>)Parameters
- projectId
-
string
The project id.
- tagId
-
string
The id of the target tag.
- updatedTag
- Tag
The updated tag model.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
updateTag(string, string, Tag, ServiceCallback<Tag>)
function updateTag(projectId: string, tagId: string, updatedTag: Tag, callback: ServiceCallback<Tag>)Parameters
- projectId
-
string
The project id.
- tagId
-
string
The id of the target tag.
- updatedTag
- Tag
The updated tag model.
- callback
The callback
Inherited Method Details
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
Send an HTTP request that is populated using the provided OperationSpec.
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>Parameters
- operationArguments
- OperationArguments
The arguments that the HTTP request's templated values will be populated from.
- operationSpec
- OperationSpec
The OperationSpec to use to populate the httpRequest.
- callback
-
ServiceCallback<any>
The callback to call when the response is received.
Returns
Promise<RestResponse>
Inherited From TrainingAPIClientContext.sendOperationRequest
sendRequest(RequestPrepareOptions | WebResourceLike)
Send the provided httpRequest.
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>Parameters
- options
Returns
Promise<HttpOperationResponse>
Inherited From TrainingAPIClientContext.sendRequest