Get Images - Get Images

Obtenha imagens para uma determinada iteração de projeto ou espaço de trabalho.
Esta API suporta a seleção de lotes e alcance. Por predefinição, só devolverá as primeiras 50 imagens correspondentes às imagens. Utilize os parâmetros {take} e {skip} para controlar quantas imagens regressarão 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", então apenas as imagens marcadas com Cão e/ou Gato serão devolvidas

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}/images
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 In Required Type Description
Endpoint
path True
  • string

Pontos finais dos Serviços Cognitivos apoiados.

projectId
path True
  • string
uuid

O projeto identifica.

$filter
query
  • string

Uma expressão para filtrar as imagens contra metadados de imagem. Apenas as imagens em que a expressão avalia a verdade estão incluídas na resposta. A expressão suporta operadores eq (Igual), ne (Não igual) e (Lógico e) ou (Lógico ou) operadores. Aqui está um exemplo, metadados=key1 eq 'value1' e key2 ne 'value2'.

iterationId
query
  • string
uuid

A idação. Predefinições no espaço de trabalho.

orderBy
query
  • string

A ordem. Incumprimentos para os mais recentes.

skip
query
  • integer
int32

Número de imagens a saltar antes de iniciar o lote de imagens. Incumprimentos para 0.

taggingStatus
query
  • string

O filtro de estado de marcação. Pode ser 'All', 'Tagged', ou 'Untagged'. Incumprimentos para 'All'.

tagIds
query
  • array

Uma lista de identificações para filtrar as imagens. Predefinições a todas as imagens marcadas quando nulas. Limitado a 20.

take
query
  • integer
int32

Número máximo de imagens para devolver. Incumprimentos a 50, limitados a 256.

Cabeçalho do Pedido

Name Required Type Description
Training-Key True
  • string

Respostas

Name Type Description
200 OK

OK

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

Type: apiKey
In: header

Exemplos

Successful GetImages request

Sample Request

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

Sample Response

[
  {
    "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

CustomVisionError
CustomVisionErrorCodes

O código de erro.

Image

Modelo de imagem a ser enviado como JSON.

ImageRegion
ImageTag

CustomVisionError

Name Type Description
code

O código de erro.

message
  • string

Uma mensagem explicando o erro reportado pelo serviço.

CustomVisionErrorCodes

O código de erro.

Name Type 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 Type Description
created
  • string

Data em que a imagem foi criada.

height
  • integer

Altura da imagem.

id
  • string

Identificação 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 o GetArtifact, caso contrário este será um URI absoluto para o recurso.

regions

Regiões associadas a esta imagem.

resizedImageUri
  • string

O URI à imagem (redimensionada) utilizada para o treino. Se a funcionalidade VNET estiver ativada, este será um caminho relativo a ser utilizado com o GetArtifact, caso contrário este será um URI absoluto para o recurso.

tags

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 o GetArtifact, caso contrário este será um URI absoluto para o recurso.

width
  • integer

Largura da imagem.

ImageRegion

Name Type Description
created
  • string
height
  • number

A altura.

left
  • number

Coordenadas do limite esquerdo.

regionId
  • string
tagId
  • string

Identificação da etiqueta associada a esta região.

tagName
  • string
top
  • number

Coordenadas do limite superior.

width
  • number

Largura.

ImageTag

Name Type Description
created
  • string
tagId
  • string
tagName
  • string