Get Images - Get Images

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Obtenha imagens para uma determinada iteração ou área de trabalho do projeto.
Esta API suporta a seleção de lotes e intervalos. Por predefinição, só devolverá as primeiras 50 imagens correspondentes às imagens. Utilize os parâmetros {take} e {skip} para controlar quantas imagens deve devolver num determinado lote. A filtragem está numa relação e/ou. Por exemplo, se os IDs de etiqueta fornecidos forem para as etiquetas "Cão" e "Gato", só serão devolvidas imagens etiquetadas com Cão e/ou Gato

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/images

With optional parameters:

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/images?iterationId={iterationId}&tagIds={tagIds}&taggingStatus={taggingStatus}&$filter={$filter}&orderBy={orderBy}&take={take}&skip={skip}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados.
projectId	path	True	string uuid	O ID do projeto.
$filter	query		string	Uma expressão para filtrar as imagens contra metadados de imagem. Apenas as imagens em que a expressão é avaliada como verdadeira são incluídas na resposta. A expressão suporta operadores eq (Igual), ne (Não igual) e (Lógico e) ou (Lógico ou). Eis um exemplo, metadata=key1 eq "value1" e key2 ne "value2".
iterationId	query		string uuid	O ID da iteração. Predefinições para a área de trabalho.
orderBy	query		string	A encomenda. A predefinição é a mais recente.
skip	query		integer int32	Número de imagens a ignorar antes de iniciar o lote de imagens. A predefinição é 0.
taggingStatus	query		string	O filtro de estado de etiquetagem. Pode ser "All", "Tagged" ou "Untagged". A predefinição é "Tudo".
tagIds	query		string[]	Uma lista de IDs de etiquetas para filtrar as imagens. A predefinição é todas as imagens etiquetadas quando nula. Limitado a 20.
take	query		integer int32	Número máximo de imagens a devolver. A predefinição é 50, limitada a 256.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Training-Key	True	string

Respostas

Name	Tipo	Description
200 OK	Image[]	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Resposta a erros Media Types: "application/json", "application/xml", "text/xml"

Segurança

Training-Key

Type: apiKey
In: header

Exemplos

Successful GetImages request

Sample Request

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/images

Sample Response

Status code:

200

[
  {
    "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 1"
      }
    ]
  },
  {
    "id": "f1855a92-b873-47e7-b513-f07a667ceda1",
    "created": "2017-12-19T15:56:10Z",
    "width": 900,
    "height": 1531,
    "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 1"
      }
    ]
  }
]

Definições

Name	Description
CustomVisionError
CustomVisionErrorCodes	O código de erro.
Image	Modelo de imagem a ser enviado como JSON.
ImageRegion
ImageTag

CustomVisionError

Name	Tipo	Description
code	CustomVisionErrorCodes	O código de erro.
message	string	Uma mensagem a explicar o erro comunicado pelo serviço.

CustomVisionErrorCodes

O código de erro.

Name	Tipo	Description
BadRequest	string
BadRequestCannotMigrateProjectWithName	string
BadRequestClassificationTrainingValidationFailed	string
BadRequestCustomerManagedKeyRevoked	string
BadRequestDetectionTrainingNotAllowNegativeTag	string
BadRequestDetectionTrainingValidationFailed	string
BadRequestDomainNotSupportedForAdvancedTraining	string
BadRequestExceedIterationPerProjectLimit	string
BadRequestExceedProjectLimit	string
BadRequestExceedTagPerImageLimit	string
BadRequestExceedTagPerProjectLimit	string
BadRequestExceededBatchSize	string
BadRequestExceededQuota	string
BadRequestExportAlreadyInProgress	string
BadRequestExportPlatformNotSupportedForAdvancedTraining	string
BadRequestExportValidationFailed	string
BadRequestExportWhileTraining	string
BadRequestImageBatch	string
BadRequestImageDimensions	string
BadRequestImageExceededCount	string
BadRequestImageFormat	string
BadRequestImageMetadataKey	string
BadRequestImageMetadataValue	string
BadRequestImageRegions	string
BadRequestImageSizeBytes	string
BadRequestImageStream	string
BadRequestImageTags	string
BadRequestImageUrl	string
BadRequestInvalid	string
BadRequestInvalidArtifactUri	string
BadRequestInvalidEmailAddress	string
BadRequestInvalidIds	string
BadRequestInvalidImportToken	string
BadRequestInvalidPublishName	string
BadRequestInvalidPublishTarget	string
BadRequestIterationDescription	string
BadRequestIterationIsNotTrained	string
BadRequestIterationIsPublished	string
BadRequestIterationName	string
BadRequestIterationNameNotUnique	string
BadRequestIterationNotPublished	string
BadRequestIterationValidationFailed	string
BadRequestMultiClassClassificationTrainingValidationFailed	string
BadRequestMultiLabelClassificationTrainingValidationFailed	string
BadRequestMultipleGeneralProductTag	string
BadRequestMultipleNegativeTag	string
BadRequestNegativeAndRegularTagOnSameImage	string
BadRequestNotLimitedTrial	string
BadRequestNotSupported	string
BadRequestOperationNotSupported	string
BadRequestPredictionIdsExceededCount	string
BadRequestPredictionIdsMissing	string
BadRequestPredictionInvalidApplicationName	string
BadRequestPredictionInvalidQueryParameters	string
BadRequestPredictionResultsExceededCount	string
BadRequestPredictionTagsExceededCount	string
BadRequestProjectDescription	string
BadRequestProjectDuplicated	string
BadRequestProjectImagePreprocessingSettings	string
BadRequestProjectName	string
BadRequestProjectNameNotUnique	string
BadRequestProjectUnknownClassification	string
BadRequestProjectUnknownDomain	string
BadRequestProjectUnsupportedDomainTypeChange	string
BadRequestProjectUnsupportedExportPlatform	string
BadRequestRequiredParamIsNull	string
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining	string
BadRequestSubscriptionApi	string
BadRequestTagDescription	string
BadRequestTagName	string
BadRequestTagNameNotUnique	string
BadRequestTagType	string
BadRequestTrainingAlreadyInProgress	string
BadRequestTrainingNotNeeded	string
BadRequestTrainingNotNeededButTrainingPipelineUpdated	string
BadRequestTrainingValidationFailed	string
BadRequestUnpublishFailed	string
BadRequestUnsupportedDomain	string
BadRequestWorkspaceCannotBeModified	string
BadRequestWorkspaceNotDeletable	string
Conflict	string
ConflictInvalid	string
ErrorExporterInvalidClassifier	string
ErrorExporterInvalidFeaturizer	string
ErrorExporterInvalidPlatform	string
ErrorFeaturizationAugmentationError	string
ErrorFeaturizationAugmentationUnavailable	string
ErrorFeaturizationInvalidFeaturizer	string
ErrorFeaturizationQueueTimeout	string
ErrorFeaturizationServiceUnavailable	string
ErrorFeaturizationUnrecognizedJob	string
ErrorInvalid	string
ErrorIterationCopyFailed	string
ErrorPrediction	string
ErrorPredictionModelNotCached	string
ErrorPredictionModelNotFound	string
ErrorPredictionServiceUnavailable	string
ErrorPredictionStorage	string
ErrorPreparePerformanceMigrationFailed	string
ErrorProjectExportRequestFailed	string
ErrorProjectImportRequestFailed	string
ErrorProjectInvalidDomain	string
ErrorProjectInvalidPipelineConfiguration	string
ErrorProjectInvalidWorkspace	string
ErrorProjectTrainingRequestFailed	string
ErrorRegionProposal	string
ErrorUnknown	string
ErrorUnknownBaseModel	string
Forbidden	string
ForbiddenDRModeEnabled	string
ForbiddenInvalid	string
ForbiddenUser	string
ForbiddenUserDisabled	string
ForbiddenUserDoesNotExist	string
ForbiddenUserInsufficientCapability	string
ForbiddenUserResource	string
ForbiddenUserSignupAllowanceExceeded	string
ForbiddenUserSignupDisabled	string
NoError	string
NotFound	string
NotFoundApimSubscription	string
NotFoundDomain	string
NotFoundImage	string
NotFoundInvalid	string
NotFoundIteration	string
NotFoundIterationPerformance	string
NotFoundProject	string
NotFoundProjectDefaultIteration	string
NotFoundTag	string
UnsupportedMediaType	string

Image

Modelo de imagem a ser enviado como JSON.

Name	Tipo	Description
created	string	Data em que a imagem foi criada.
height	integer	Altura da imagem.
id	string	ID da imagem.
metadata	object	Metadados associados a esta imagem.
originalImageUri	string	O URI para a imagem original carregada. Se a funcionalidade VNET estiver ativada, este será um caminho relativo a ser utilizado com GetArtifact, caso contrário, este será um URI absoluto para o recurso.
regions	ImageRegion[]	Regiões associadas a esta imagem.
resizedImageUri	string	O URI para a imagem (redimensionada) utilizada para preparação. Se a funcionalidade VNET estiver ativada, este será um caminho relativo a ser utilizado com GetArtifact, caso contrário, este será um URI absoluto para o recurso.
tags	ImageTag[]	Etiquetas associadas a esta imagem.
thumbnailUri	string	O URI para a miniatura da imagem original. Se a funcionalidade VNET estiver ativada, este será um caminho relativo a ser utilizado com GetArtifact, caso contrário, este será um URI absoluto para o recurso.
width	integer	Largura da imagem.

ImageRegion

Name	Tipo	Description
created	string
height	number	Altura.
left	number	Coordenada do limite esquerdo.
regionId	string
tagId	string	ID da etiqueta associada a esta região.
tagName	string
top	number	Coordenada do limite superior.
width	number	Largura.

ImageTag

Name	Tipo	Description
created	string
tagId	string
tagName	string