Images - Create From Urls
Adicione as URLs de imagens fornecidas ao conjunto de imagens de treinamento. Essa API aceita um lote de URLs e, opcionalmente, marcas, para criar imagens. Há um limite de 64 imagens e 20 marcas. Se todas as imagens forem criadas com êxito, o código de status 200(OK) será retornado. Caso contrário, o código de status 207 (Multi-Status) será retornado e o status de detalhes de cada imagem será listado no conteúdo da resposta.
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/urls
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Pontos de extremidade dos Serviços Cognitivos com suporte. |
project
|
path | True |
string (uuid) |
A ID do projeto. |
Cabeçalho da solicitação
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
Training-Key | True |
string |
Corpo da solicitação
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
Nome | Tipo | Description |
---|---|---|
images | ||
metadata |
object |
Os metadados da imagem. Limitado a 50 pares chave-valor por imagem. O comprimento da chave é limitado a 256. O comprimento do valor é limitado a 512. |
tagIds |
string[] (uuid) |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OKEY Media Types: "application/json", "application/xml", "text/xml" |
|
Other Status Codes |
207 Media Types: "application/json", "application/xml", "text/xml" |
|
Other Status Codes |
Resposta de erro Media Types: "application/json", "application/xml", "text/xml" |
Segurança
Training-Key
Tipo:
apiKey
Em:
header
Exemplos
Successful CreateImagesFromUrls request
Solicitação de exemplo
POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/images/urls
{
"images": [
{
"url": "{url to image}"
}
],
"tagIds": [
"b607964f-7bd6-4a3b-a869-6791fb6aab87"
]
}
Resposta de exemplo
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "{url to image}",
"status": "OK",
"image": {
"id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
"created": "2017-12-19T15:56:10Z",
"width": 1095,
"height": 900,
"resizedImageUri": "{Resized Image Uri}",
"originalImageUri": "{Image Uri}",
"thumbnailUri": "{Thumbnail Uri}",
"tags": [
{
"tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
"created": "2017-12-19T15:56:09Z",
"tagName": "tag name"
}
]
}
}
]
}
{
"isBatchSuccessful": false,
"images": [
{
"sourceUrl": "{url to image}",
"status": "OK",
"image": {
"id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9",
"created": "2017-12-19T15:56:10Z",
"width": 1095,
"height": 900,
"resizedImageUri": "{Resized Image Uri}",
"originalImageUri": "{Image Uri}",
"thumbnailUri": "{Thumbnail Uri}",
"tags": [
{
"tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87",
"created": "2017-12-19T15:56:09Z",
"tagName": "tag name"
}
]
}
},
{
"sourceUrl": "{url to image}",
"status": "ErrorSource",
"image": null
}
]
}
Definições
Nome | Description |
---|---|
Custom |
|
Custom |
O código de erro. |
Image |
Modelo de imagem a ser enviado como JSON. |
Image |
|
Image |
Status da criação da imagem. |
Image |
|
Image |
|
Image |
|
Image |
|
Image |
|
Region |
CustomVisionError
Nome | Tipo | Description |
---|---|---|
code |
O código de erro. |
|
message |
string |
Uma mensagem explicando o erro relatado pelo serviço. |
CustomVisionErrorCodes
O código de erro.
Valor | Description |
---|---|
BadRequest | |
BadRequestCannotMigrateProjectWithName | |
BadRequestClassificationTrainingValidationFailed | |
BadRequestCustomerManagedKeyRevoked | |
BadRequestDetectionTrainingNotAllowNegativeTag | |
BadRequestDetectionTrainingValidationFailed | |
BadRequestDomainNotSupportedForAdvancedTraining | |
BadRequestExceedIterationPerProjectLimit | |
BadRequestExceedProjectLimit | |
BadRequestExceedTagPerImageLimit | |
BadRequestExceedTagPerProjectLimit | |
BadRequestExceededBatchSize | |
BadRequestExceededQuota | |
BadRequestExportAlreadyInProgress | |
BadRequestExportPlatformNotSupportedForAdvancedTraining | |
BadRequestExportValidationFailed | |
BadRequestExportWhileTraining | |
BadRequestImageBatch | |
BadRequestImageDimensions | |
BadRequestImageExceededCount | |
BadRequestImageFormat | |
BadRequestImageMetadataKey | |
BadRequestImageMetadataValue | |
BadRequestImageRegions | |
BadRequestImageSizeBytes | |
BadRequestImageStream | |
BadRequestImageTags | |
BadRequestImageUrl | |
BadRequestInvalid | |
BadRequestInvalidArtifactUri | |
BadRequestInvalidEmailAddress | |
BadRequestInvalidIds | |
BadRequestInvalidImportToken | |
BadRequestInvalidPublishName | |
BadRequestInvalidPublishTarget | |
BadRequestIterationDescription | |
BadRequestIterationIsNotTrained | |
BadRequestIterationIsPublished | |
BadRequestIterationName | |
BadRequestIterationNameNotUnique | |
BadRequestIterationNotPublished | |
BadRequestIterationValidationFailed | |
BadRequestMultiClassClassificationTrainingValidationFailed | |
BadRequestMultiLabelClassificationTrainingValidationFailed | |
BadRequestMultipleGeneralProductTag | |
BadRequestMultipleNegativeTag | |
BadRequestNegativeAndRegularTagOnSameImage | |
BadRequestNotLimitedTrial | |
BadRequestNotSupported | |
BadRequestOperationNotSupported | |
BadRequestPredictionIdsExceededCount | |
BadRequestPredictionIdsMissing | |
BadRequestPredictionInvalidApplicationName | |
BadRequestPredictionInvalidQueryParameters | |
BadRequestPredictionResultsExceededCount | |
BadRequestPredictionTagsExceededCount | |
BadRequestProjectDescription | |
BadRequestProjectDuplicated | |
BadRequestProjectImagePreprocessingSettings | |
BadRequestProjectName | |
BadRequestProjectNameNotUnique | |
BadRequestProjectUnknownClassification | |
BadRequestProjectUnknownDomain | |
BadRequestProjectUnsupportedDomainTypeChange | |
BadRequestProjectUnsupportedExportPlatform | |
BadRequestRequiredParamIsNull | |
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining | |
BadRequestSubscriptionApi | |
BadRequestTagDescription | |
BadRequestTagName | |
BadRequestTagNameNotUnique | |
BadRequestTagType | |
BadRequestTrainingAlreadyInProgress | |
BadRequestTrainingNotNeeded | |
BadRequestTrainingNotNeededButTrainingPipelineUpdated | |
BadRequestTrainingValidationFailed | |
BadRequestUnpublishFailed | |
BadRequestUnsupportedDomain | |
BadRequestWorkspaceCannotBeModified | |
BadRequestWorkspaceNotDeletable | |
Conflict | |
ConflictInvalid | |
ErrorExporterInvalidClassifier | |
ErrorExporterInvalidFeaturizer | |
ErrorExporterInvalidPlatform | |
ErrorFeaturizationAugmentationError | |
ErrorFeaturizationAugmentationUnavailable | |
ErrorFeaturizationInvalidFeaturizer | |
ErrorFeaturizationQueueTimeout | |
ErrorFeaturizationServiceUnavailable | |
ErrorFeaturizationUnrecognizedJob | |
ErrorInvalid | |
ErrorIterationCopyFailed | |
ErrorPrediction | |
ErrorPredictionModelNotCached | |
ErrorPredictionModelNotFound | |
ErrorPredictionServiceUnavailable | |
ErrorPredictionStorage | |
ErrorPreparePerformanceMigrationFailed | |
ErrorProjectExportRequestFailed | |
ErrorProjectImportRequestFailed | |
ErrorProjectInvalidDomain | |
ErrorProjectInvalidPipelineConfiguration | |
ErrorProjectInvalidWorkspace | |
ErrorProjectTrainingRequestFailed | |
ErrorRegionProposal | |
ErrorUnknown | |
ErrorUnknownBaseModel | |
Forbidden | |
ForbiddenDRModeEnabled | |
ForbiddenInvalid | |
ForbiddenUser | |
ForbiddenUserDisabled | |
ForbiddenUserDoesNotExist | |
ForbiddenUserInsufficientCapability | |
ForbiddenUserResource | |
ForbiddenUserSignupAllowanceExceeded | |
ForbiddenUserSignupDisabled | |
NoError | |
NotFound | |
NotFoundApimSubscription | |
NotFoundDomain | |
NotFoundImage | |
NotFoundInvalid | |
NotFoundIteration | |
NotFoundIterationPerformance | |
NotFoundProject | |
NotFoundProjectDefaultIteration | |
NotFoundTag | |
UnsupportedMediaType |
Image
Modelo de imagem a ser enviado como JSON.
Nome | Tipo | Description |
---|---|---|
created |
string (date-time) |
Data em que a imagem foi criada. |
height |
integer (int32) |
Altura da imagem. |
id |
string (uuid) |
ID da imagem. |
metadata |
object |
Metadados associados a essa imagem. |
originalImageUri |
string |
O URI para a imagem original carregada. Se o recurso VNET estiver habilitado, esse será um caminho relativo a ser usado com GetArtifact, caso contrário, esse será um URI absoluto para o recurso. |
regions |
Regiões associadas a essa imagem. |
|
resizedImageUri |
string |
O URI para a imagem (redimensionada) usada para treinamento. Se o recurso VNET estiver habilitado, esse será um caminho relativo a ser usado com GetArtifact, caso contrário, esse será um URI absoluto para o recurso. |
tags |
Image |
Marcas associadas a essa imagem. |
thumbnailUri |
string |
O URI para a miniatura da imagem original. Se o recurso VNET estiver habilitado, esse será um caminho relativo a ser usado com GetArtifact, caso contrário, esse será um URI absoluto para o recurso. |
width |
integer (int32) |
Largura da imagem. |
ImageCreateResult
Nome | Tipo | Description |
---|---|---|
image |
A imagem. |
|
sourceUrl |
string |
URL de origem da imagem. |
status |
Status da criação da imagem. |
ImageCreateStatus
Status da criação da imagem.
Valor | Description |
---|---|
ErrorImageFormat | |
ErrorImageSize | |
ErrorLimitExceed | |
ErrorNegativeAndRegularTagOnSameImage | |
ErrorRegionLimitExceed | |
ErrorSource | |
ErrorStorage | |
ErrorTagLimitExceed | |
ErrorUnknown | |
OK | |
OKDuplicate |
ImageCreateSummary
Nome | Tipo | Description |
---|---|---|
images |
Lista dos resultados da criação da imagem. |
|
isBatchSuccessful |
boolean |
True se todas as imagens no lote foram criadas com êxito, caso contrário, false. |
ImageRegion
Nome | Tipo | Description |
---|---|---|
created |
string (date-time) |
|
height |
number (float) |
Altura. |
left |
number (float) |
Coordenada do limite esquerdo. |
regionId |
string (uuid) |
|
tagId |
string (uuid) |
ID da marca associada a essa região. |
tagName |
string |
|
top |
number (float) |
Coordenada do limite superior. |
width |
number (float) |
Largura. |
ImageTag
Nome | Tipo | Description |
---|---|---|
created |
string (date-time) |
|
tagId |
string (uuid) |
|
tagName |
string |
ImageUrlCreateBatch
Nome | Tipo | Description |
---|---|---|
images | ||
metadata |
object |
Os metadados da imagem. Limitado a 50 pares chave-valor por imagem. O comprimento da chave é limitado a 256. O comprimento do valor é limitado a 512. |
tagIds |
string[] (uuid) |
ImageUrlCreateEntry
Nome | Tipo | Description |
---|---|---|
regions |
Region[] |
|
tagIds |
string[] (uuid) |
|
url |
string |
URL da imagem. |
Region
Nome | Tipo | Description |
---|---|---|
height |
number (float) |
Altura. |
left |
number (float) |
Coordenada do limite esquerdo. |
tagId |
string (uuid) |
ID da marca associada a essa região. |
top |
number (float) |
Coordenada do limite superior. |
width |
number (float) |
Largura. |