Images - Create From Urls
Adicione os urls das imagens fornecidas ao conjunto de imagens de treinamento. Essa API aceita um lote de urls e, opcionalmente, tags para criar imagens. Há um limite de 64 imagens e 20 tags. 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 detalhado de cada imagem será listado na carga útil de resposta.
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/urls
Parâmetros do URI
| Name | Em | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Pontos de extremidade de Serviços Cognitivos suportados. |
|
project
|
path | True |
string (uuid) |
O id do projeto. |
Cabeçalho do Pedido
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Necessário | Tipo | Description |
|---|---|---|---|
| Training-Key | True |
string |
Corpo do Pedido
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | 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
| Name | Tipo | Description |
|---|---|---|
| 200 OK |
OK 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
Pedido de amostra
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 da amostra
{
"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
| Name | 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
| Name | 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 |
|---|---|
| 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 | |
| BadRequestImageExceededCount | |
| BadRequestTrainingNotNeeded | |
| BadRequestTrainingNotNeededButTrainingPipelineUpdated | |
| BadRequestTrainingValidationFailed | |
| BadRequestClassificationTrainingValidationFailed | |
| BadRequestMultiClassClassificationTrainingValidationFailed | |
| BadRequestMultiLabelClassificationTrainingValidationFailed | |
| BadRequestDetectionTrainingValidationFailed | |
| BadRequestTrainingAlreadyInProgress | |
| BadRequestDetectionTrainingNotAllowNegativeTag | |
| BadRequestInvalidEmailAddress | |
| BadRequestDomainNotSupportedForAdvancedTraining | |
| BadRequestExportPlatformNotSupportedForAdvancedTraining | |
| BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining | |
| BadRequestExportValidationFailed | |
| BadRequestExportAlreadyInProgress | |
| BadRequestPredictionIdsMissing | |
| BadRequestPredictionIdsExceededCount | |
| BadRequestPredictionTagsExceededCount | |
| BadRequestPredictionResultsExceededCount | |
| BadRequestPredictionInvalidApplicationName | |
| BadRequestPredictionInvalidQueryParameters | |
| BadRequestInvalidImportToken | |
| BadRequestExportWhileTraining | |
| BadRequestImageMetadataKey | |
| BadRequestImageMetadataValue | |
| BadRequestOperationNotSupported | |
| BadRequestInvalidArtifactUri | |
| BadRequestCustomerManagedKeyRevoked | |
| 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 | |
| ErrorInvalid |
Image
Modelo de imagem a ser enviado como JSON.
| Name | 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 esta 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, será um URI absoluto para o recurso. |
| regions |
Regiões associadas a esta 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, será um URI absoluto para o recurso. |
| tags |
Image |
Tags associadas a esta 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, será um URI absoluto para o recurso. |
| width |
integer (int32) |
Largura da imagem. |
ImageCreateResult
| Name | 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 |
|---|---|
| OK | |
| OKDuplicate | |
| ErrorSource | |
| ErrorImageFormat | |
| ErrorImageSize | |
| ErrorStorage | |
| ErrorLimitExceed | |
| ErrorTagLimitExceed | |
| ErrorRegionLimitExceed | |
| ErrorUnknown | |
| ErrorNegativeAndRegularTagOnSameImage |
ImageCreateSummary
| Name | Tipo | Description |
|---|---|---|
| images |
Lista dos resultados da criação de imagens. |
|
| isBatchSuccessful |
boolean |
True se todas as imagens no lote foram criadas com êxito, caso contrário, false. |
ImageRegion
| Name | 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 tag associada a esta região. |
| tagName |
string |
|
| top |
number (float) |
Coordenada do limite superior. |
| width |
number (float) |
Largura. |
ImageTag
| Name | Tipo | Description |
|---|---|---|
| created |
string (date-time) |
|
| tagId |
string (uuid) |
|
| tagName |
string |
ImageUrlCreateBatch
| Name | 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
| Name | Tipo | Description |
|---|---|---|
| regions |
Region[] |
|
| tagIds |
string[] (uuid) |
|
| url |
string |
URL da imagem. |
Region
| Name | Tipo | Description |
|---|---|---|
| height |
number (float) |
Altura. |
| left |
number (float) |
Coordenada do limite esquerdo. |
| tagId |
string (uuid) |
Id da tag associada a esta região. |
| top |
number (float) |
Coordenada do limite superior. |
| width |
number (float) |
Largura. |