Images - List Suggested

Referência

Serviço:: Azure AI Services

Versão da API:: 3.3

Essa API buscará imagens não marcadas filtradas por tags sugeridas Ids. Ele retorna uma matriz vazia se nenhuma imagem for encontrada.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/suggested?iterationId={iterationId}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados.
projectId	path	True	string (uuid)	O id do projeto.
iterationId	query	True	string (uuid)	IterationId para usar para as tags e regiões sugeridas.

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
continuation	string	ID de continuação para paginação do banco de dados. Inicialmente nulo, mas depois usado para paginar.
maxCount	integer (int32)	Número máximo de resultados que você deseja que sejam retornados na resposta.
session	string	SessionId para consulta de banco de dados. Inicialmente definido como null, mas depois usado para paginar.
sortBy	SortBy	OrderBy. Mecanismo de ordenação dos seus resultados.
tagIds	string[] (uuid)	TagIds existentes no projeto para filtrar tags sugeridas.
threshold	number (double)	Limite de confiança para filtrar as tags sugeridas.

Respostas

Name	Tipo	Description
200 OK	SuggestedTagAndRegionQuery	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Resposta de erro Media Types: "application/json", "application/xml", "text/xml"

Name

Tipo

Description

200 OK

SuggestedTagAndRegionQuery

Media Types: "application/json", "application/xml", "text/xml"

Other Status Codes

CustomVisionError

Resposta de erro

Media Types: "application/json", "application/xml", "text/xml"

Segurança

Training-Key

Tipo: apiKey
Em: header

Exemplos

Successful QuerySuggestedImages request

Pedido de amostra

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e/images/suggested?iterationId=b7b9d99c-a2c6-4658-9900-a98d2ff5bc66


{
  "tagIds": [
    "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
  ]
}

Resposta da amostra

Código de estado:: 200

{
  "results": [
    {
      "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042",
      "project": "8988643a-ae70-447d-9a22-15c4255e5ecb",
      "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66",
      "created": "2018-01-31T20:18:26Z",
      "predictions": [
        {
          "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
          "tagName": "Tag 1",
          "probability": 1
        },
        {
          "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3",
          "tagName": "Tag 2",
          "probability": 3.60627153E-12
        }
      ],
      "originalImageUri": "<image uri>",
      "thumbnailUri": "<thumbnail uri>",
      "resizedImageUri": "<resized image uri>",
      "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39"
    }
  ],
  "token": {
    "session": "1:286613",
    "continuation": "",
    "maxCount": 0,
    "sortBy": "Newest",
    "tagIds": [
      "b5f7e6a2-a481-49a6-afec-a7cef1af3544"
    ]
  }
}

Definições

Name	Description
BoundingBox	Caixa delimitadora que define uma região de uma imagem.
CustomVisionError
CustomVisionErrorCodes	O código de erro.
Prediction	Resultado da previsão.
SortBy	OrderBy. Mecanismo de ordenação dos seus resultados.
StoredSuggestedTagAndRegion	Resultado de uma solicitação sugerida de tags e regiões da imagem não marcada.
SuggestedTagAndRegionQuery	A matriz de imagens de resultado e token contendo Ids de sessão e continuação para a próxima consulta.
SuggestedTagAndRegionQueryToken	Contém propriedades para as quais precisamos buscar tags sugeridas. Para a primeira chamada, Session e continuation são definidos como null. Em seguida, em chamadas subsequentes, usa a sessão/continuação do resultado anterior de SuggestedTagAndRegionQuery para obter resultados adicionais.
TagType	Tipo da tag prevista.

BoundingBox

Object

Caixa delimitadora que define uma região de uma imagem.

Name	Tipo	Description
height	number (float)	Altura.
left	number (float)	Coordenada do limite esquerdo.
top	number (float)	Coordenada do limite superior.
width	number (float)	Largura.

CustomVisionError

Object

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

CustomVisionErrorCodes

Enumeração

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

Prediction

Object

Resultado da previsão.

Name	Tipo	Description
boundingBox	BoundingBox	Caixa delimitadora da previsão.
probability	number (float)	Probabilidade da tag.
tagId	string (uuid)	Id da tag prevista.
tagName	string	Nome da tag prevista.
tagType	TagType	Tipo da tag prevista.

SortBy

Enumeração

OrderBy. Mecanismo de ordenação dos seus resultados.

Valor	Description
UncertaintyAscending
UncertaintyDescending

StoredSuggestedTagAndRegion

Object

Resultado de uma solicitação sugerida de tags e regiões da imagem não marcada.

Name	Tipo	Description
created	string (date-time)	Data em que esta previsão foi criada.
domain	string (uuid)	Domínio usado para a previsão.
height	integer (int32)	Altura da imagem redimensionada.
id	string (uuid)	Id da previsão.
iteration	string (uuid)	ID da iteração.
originalImageUri	string	O URI para a imagem de previsão 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.
predictionUncertainty	number (double)	Incerteza (entropia) de tags ou regiões sugeridas por imagem.
predictions	Prediction[]	Lista de previsões.
project	string (uuid)	Id do projeto.
resizedImageUri	string	O URI para a imagem de previsão (redimensionada). 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.
thumbnailUri	string	O URI para a miniatura da imagem de previsão 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 redimensionada.

SuggestedTagAndRegionQuery

Object

A matriz de imagens de resultado e token contendo Ids de sessão e continuação para a próxima consulta.

Name	Tipo	Description
results	StoredSuggestedTagAndRegion[]	Resultado de uma solicitação sugerida de tags e regiões da imagem não marcada.
token	SuggestedTagAndRegionQueryToken	Contém propriedades para as quais precisamos buscar tags sugeridas.

SuggestedTagAndRegionQueryToken

Object

Contém propriedades para as quais precisamos buscar tags sugeridas. Para a primeira chamada, Session e continuation são definidos como null. Em seguida, em chamadas subsequentes, usa a sessão/continuação do resultado anterior de SuggestedTagAndRegionQuery para obter resultados adicionais.

Name	Tipo	Description
continuation	string	ID de continuação para paginação do banco de dados. Inicialmente nulo, mas depois usado para paginar.
maxCount	integer (int32)	Número máximo de resultados que você deseja que sejam retornados na resposta.
session	string	SessionId para consulta de banco de dados. Inicialmente definido como null, mas depois usado para paginar.
sortBy	SortBy	OrderBy. Mecanismo de ordenação dos seus resultados.
tagIds	string[] (uuid)	TagIds existentes no projeto para filtrar tags sugeridas.
threshold	number (double)	Limite de confiança para filtrar as tags sugeridas.

TagType

Enumeração

Tipo da tag prevista.

Valor	Description
GeneralProduct
Negative
Regular

Partilhar via

Images - List Suggested

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Training-Key

Exemplos

Successful QuerySuggestedImages request

Pedido de amostra

Resposta da amostra

Definições

BoundingBox

CustomVisionError

CustomVisionErrorCodes

Prediction

SortBy

StoredSuggestedTagAndRegion

SuggestedTagAndRegionQuery

SuggestedTagAndRegionQueryToken

TagType