Custom_Vision_Training_3.4-preview
GetDomains
Get a list of the available domains.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request headers
Request body
Response 200
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true,
"exportablePlatforms": [
"CoreML"
],
"modelInformation": {
"estimatedModelSizeInMegabytes": 0,
"description": "string"
}
}
]
{
"type": "array",
"items": {
"description": "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 <a href=\"https://go.microsoft.com/fwlink/?linkid=2117014\">domain documentation</a>.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Domain id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"name": {
"description": "Name of the domain, describing the types of images used to train it.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"type": {
"description": "Domain type: Classification or ObjectDetection.",
"enum": [
"Classification",
"ObjectDetection"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "DomainType",
"modelAsString": true
}
},
"exportable": {
"description": "Indicating if the domain is exportable.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"enabled": {
"description": "Indicating if the domain is enabled.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"exportablePlatforms": {
"description": "Platforms that the domain can be exported to.",
"type": "array",
"items": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX",
"VAIDK",
"OpenVino"
],
"type": "string",
"x-nullable": false
},
"readOnly": true
},
"modelInformation": {
"description": "Model information.",
"type": "object",
"properties": {
"estimatedModelSizeInMegabytes": {
"format": "int32",
"description": "Estimation of the exported FP32 Onnx model size (2 tags) in megabytes. This information is not present if the model cannot be exported.",
"type": "integer",
"readOnly": false
},
"description": {
"description": "Model description.",
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true
}
}
}
}
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
<exportablePlatforms>CoreML</exportablePlatforms>
<modelInformation>
<estimatedModelSizeInMegabytes>0</estimatedModelSizeInMegabytes>
<description>string</description>
</modelInformation>
</DomainArray>
{
"type": "array",
"items": {
"description": "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 <a href=\"https://go.microsoft.com/fwlink/?linkid=2117014\">domain documentation</a>.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Domain id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"name": {
"description": "Name of the domain, describing the types of images used to train it.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"type": {
"description": "Domain type: Classification or ObjectDetection.",
"enum": [
"Classification",
"ObjectDetection"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "DomainType",
"modelAsString": true
}
},
"exportable": {
"description": "Indicating if the domain is exportable.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"enabled": {
"description": "Indicating if the domain is enabled.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"exportablePlatforms": {
"description": "Platforms that the domain can be exported to.",
"type": "array",
"items": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX",
"VAIDK",
"OpenVino"
],
"type": "string",
"x-nullable": false
},
"readOnly": true
},
"modelInformation": {
"description": "Model information.",
"type": "object",
"properties": {
"estimatedModelSizeInMegabytes": {
"format": "int32",
"description": "Estimation of the exported FP32 Onnx model size (2 tags) in megabytes. This information is not present if the model cannot be exported.",
"type": "integer",
"readOnly": false
},
"description": {
"description": "Model description.",
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true
}
}
}
}
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
<exportablePlatforms>CoreML</exportablePlatforms>
<modelInformation>
<estimatedModelSizeInMegabytes>0</estimatedModelSizeInMegabytes>
<description>string</description>
</modelInformation>
</DomainArray>
{
"type": "array",
"items": {
"description": "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 <a href=\"https://go.microsoft.com/fwlink/?linkid=2117014\">domain documentation</a>.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Domain id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"name": {
"description": "Name of the domain, describing the types of images used to train it.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"type": {
"description": "Domain type: Classification or ObjectDetection.",
"enum": [
"Classification",
"ObjectDetection"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "DomainType",
"modelAsString": true
}
},
"exportable": {
"description": "Indicating if the domain is exportable.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"enabled": {
"description": "Indicating if the domain is enabled.",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"exportablePlatforms": {
"description": "Platforms that the domain can be exported to.",
"type": "array",
"items": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX",
"VAIDK",
"OpenVino"
],
"type": "string",
"x-nullable": false
},
"readOnly": true
},
"modelInformation": {
"description": "Model information.",
"type": "object",
"properties": {
"estimatedModelSizeInMegabytes": {
"format": "int32",
"description": "Estimation of the exported FP32 Onnx model size (2 tags) in megabytes. This information is not present if the model cannot be exported.",
"type": "integer",
"readOnly": false
},
"description": {
"description": "Model description.",
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"readOnly": true
}
}
}
}
Response 500
Error response
{
"code": "NoError",
"message": "string"
}
{
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"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"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
{
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"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"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
{
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"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"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains"
-H "Training-key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Training-key", "{subscription key}");
var uri = "https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Training-key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Training-key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Training-key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains');
$url = $request->getUrl();
$headers = array(
// Request headers
'Training-key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Training-key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/customvision/v3.4-preview/Training/domains?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Training-key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/customvision/v3.4-preview/Training/domains?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://*.cognitiveservices.azure.com/customvision/v3.4-preview/Training/domains')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Training-key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body