Microsoft Azure

Azure AI Services: Training

Azure AI Services: Training endpoints from Microsoft Azure

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Azure AI Services: Training endpoints from Microsoft Azure

Endpoints 52

  • GETDomains_List/domainsGet a list of the available domains.
  • GETDomains_Get/domains/:domainIdGet information about a specific domain.
  • GETProjects_List/projectsGet your projects.
  • POSTProjects_Create/projects?name=string&description=string&domainId=3fa85f64-5717-4562-b3fc-2c963f66afa6&classificationType=Multiclass&targetExportPlatforms=CoreMLCreate a project.
  • GETProjects_Get/projects/:projectIdGet a specific project.
  • DELETEProjects_Delete/projects/:projectIdDelete a specific project.
  • PATCHProjects_Update/projects/:projectIdUpdate a specific project.
  • GETProjects_GetArtifact/projects/:projectId/artifacts?path=stringGet artifact content from blob storage, based on artifact relative path in the blob.
  • GETProjects_Export/projects/:projectId/exportExports a project.
  • GETImages_List/projects/:projectId/images?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&taggingStatus=All&$filter=string&orderBy=Newest&take=50&skip=0This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to…
  • POSTImages_CreateFromData/projects/:projectId/images?tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6This 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…
  • DELETEImages_Delete/projects/:projectId/images?imageIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&allImages=true&allIterations=trueDelete images from the set of training images.
  • POSTImages_GetRegionProposals/projects/:projectId/images/:imageId/regionproposalsThis API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.
  • GETImages_GetCount/projects/:projectId/images/count?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&taggingStatus=All&$filter=string&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6Get the number of images. 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…
  • POSTImages_CreateFromFiles/projects/:projectId/images/filesThis API accepts a batch of files, and optionally tags, to create training images. There is a limit of 64 images and 20 tags. If all images are successful…
  • GETImages_ListByIds/projects/:projectId/images/id?imageIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the current workspace is used.
  • POSTImages_UpdateMetadata/projects/:projectId/images/metadata?imageIds=3fa85f64-5717-4562-b3fc-2c963f66afa6This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.
  • POSTImages_CreateFromPredictions/projects/:projectId/images/predictionsThis API creates a batch of training images from predicted images specified. There is a limit of 64 images and 20 tags. If all images are successful created,…
  • POSTImages_CreateRegions/projects/:projectId/images/regionsThis 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…
  • DELETEImages_DeleteRegions/projects/:projectId/images/regions?regionIds=3fa85f64-5717-4562-b3fc-2c963f66afa6Delete a set of image regions.
  • POSTImages_ListSuggested/projects/:projectId/images/suggested?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
  • POSTImages_GetSuggestedCount/projects/:projectId/images/suggested/count?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6This API takes in tagIds to get count of untagged images per suggested tags for a given threshold. Images whose suggested tags match given tags and their…
  • GETImages_ListTagged/projects/:projectId/images/tagged?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&orderBy=Newest&take=50&skip=0Get tagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching…
  • GETImages_GetTaggedCount/projects/:projectId/images/tagged/count?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6Gets 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…
  • POSTImages_CreateTags/projects/:projectId/images/tagsAssociate a set of images with a set of tags.
  • DELETEImages_DeleteTags/projects/:projectId/images/tags?imageIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6Remove a set of tags from a set of images.
  • GETImages_ListUntagged/projects/:projectId/images/untagged?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&orderBy=Newest&take=50&skip=0Get untagged images for a given project iteration. This API supports batching and range selection. By default it will only return first 50 images matching…
  • GETImages_GetUntaggedCount/projects/:projectId/images/untagged/count?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6Gets 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…
  • POSTImages_CreateFromUrls/projects/:projectId/images/urlsAdd 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…
  • GETIterations_List/projects/:projectId/iterationsGet iterations for the project.
  • GETIterations_Get/projects/:projectId/iterations/:iterationIdGet a specific iteration.
  • DELETEIterations_Delete/projects/:projectId/iterations/:iterationIdDelete a specific iteration of a project.
  • PATCHIterations_Update/projects/:projectId/iterations/:iterationIdUpdate a specific iteration.
  • GETIterations_ListExports/projects/:projectId/iterations/:iterationId/exportGet the list of exports for a specific iteration.
  • POSTIterations_Export/projects/:projectId/iterations/:iterationId/export?platform=CoreML&flavor=LinuxExport a trained iteration.
  • GETIterations_GetPerformance/projects/:projectId/iterations/:iterationId/performance?threshold=0.0&overlapThreshold=0.0Get detailed performance information about an iteration.
  • GETIterations_ListPerformanceImages/projects/:projectId/iterations/:iterationId/performance/images?tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6&orderBy=Newest&take=50&skip=0Get 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…
  • GETIterations_GetPerformanceImageCount/projects/:projectId/iterations/:iterationId/performance/images/count?tagIds=3fa85f64-5717-4562-b3fc-2c963f66afa6Gets the number of images tagged with the provided {tagIds} that have prediction results from training for the provided iteration {iterationId}. The filtering…
  • POSTIterations_Publish/projects/:projectId/iterations/:iterationId/publish?publishName=string&predictionId=string&overwrite=truePublish a specific iteration.
  • DELETEIterations_Unpublish/projects/:projectId/iterations/:iterationId/publishUnpublish a specific iteration.
  • DELETEPredictions_Delete/projects/:projectId/predictions?ids=3fa85f64-5717-4562-b3fc-2c963f66afa6Delete a set of predicted images and their associated prediction results.
  • POSTPredictions_Query/projects/:projectId/predictions/queryGet images that were sent to your prediction endpoint.
  • POSTProjects_QuickTestImage/projects/:projectId/quicktest/image?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&store=trueQuick test an image.
  • POSTProjects_QuickTestImageUrl/projects/:projectId/quicktest/url?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&store=trueQuick test an image url.
  • GETProjects_ListTags/projects/:projectId/tags?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6Get the tags for a given project and iteration.
  • POSTProjects_CreateTag/projects/:projectId/tags?name=string&description=string&type=RegularCreate a tag for the project.
  • GETProjects_GetTag/projects/:projectId/tags/:tagId?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6Get information about a specific tag.
  • DELETEProjects_DeleteTag/projects/:projectId/tags/:tagIdDelete a tag from the project.
  • PATCHProjects_UpdateTag/projects/:projectId/tags/:tagIdUpdate a tag.
  • POSTProjects_SuggestTagsAndRegions/projects/:projectId/tagsandregions/suggestions?iterationId=3fa85f64-5717-4562-b3fc-2c963f66afa6&imageIds=3fa85f64-5717-4562-b3fc-2c963f66afa6Suggest tags and regions for an array/batch of untagged images. Returns empty array if no tags are found. This API will get suggested tags and regions for an…
  • POSTProjects_Train/projects/:projectId/train?trainingType=Regular&reservedBudgetInHours=0&forceTrain=false&notificationEmailAddress=stringQueues project for training.
  • POSTProjects_Import/projects/import?token=string&name=stringImports a project.

API details

Base URL
https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training
Authentication
An API key in the Training-Key header
Operations
52 operations on 38 pathsGET 21POST 20DELETE 8PATCH 3
Description format
Swagger 2.0, API version 3.3

How to test the Azure AI Services: Training in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Services: Training collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Training-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Domains_List” (GET /domains), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure AI Services: Training?

Azure AI Services: Training endpoints from Microsoft Azure It is listed under AI & machine learning and has 52 endpoints.

Who publishes the Azure AI Services: Training?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure AI Services: Training?

Requests go to https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training. Endpoint paths are added to this base URL.

How do I authenticate with the Azure AI Services: Training?

With an API key in the Training-Key header.

How many endpoints does the Azure AI Services: Training have?

52 operations on 38 paths (21 GET, 20 POST, 8 DELETE, 3 PATCH).

Is forking the Azure AI Services: Training free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.