Partilhar via

Predictions - Query

Serviço:
Azure AI Services
Versão da API:
3.3

Obtenha imagens que foram enviadas para o seu ponto de extremidade de previsão.

POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/predictions/query

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.

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
application

string

continuation

string

endTime

string (date-time)

iterationId

string (uuid)

maxCount

integer (int32)

orderBy

OrderBy

session

string

startTime

string (date-time)

tags

PredictionQueryTag[]

Respostas

Name Tipo Description
200 OK

PredictionQueryResult

OK

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 QueryPredictions request

Pedido de amostra

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


{
  "orderBy": "Newest",
  "tags": [
    {
      "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
      "maxThreshold": 1,
      "minThreshold": 0.9
    }
  ]
}

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,
    "orderBy": "Newest",
    "tags": [
      {
        "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544",
        "minThreshold": 0.9,
        "maxThreshold": 1
      }
    ],
    "iterationId": null,
    "startTime": null,
    "endTime": null,
    "application": ""
  }
}

Definições

Name Description
BoundingBox

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

O código de erro.
OrderBy
Prediction

Resultado da previsão.
PredictionQueryResult

Resultado da consulta das imagens de previsão que foram enviadas para o seu ponto de extremidade de previsão.
PredictionQueryTag
PredictionQueryToken
StoredImagePrediction

Resultado de uma solicitação de previsão de imagem.
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
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

OrderBy

Enumeração
Valor Description
Newest
Oldest
Suggested

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.

PredictionQueryResult

Object

Resultado da consulta das imagens de previsão que foram enviadas para o seu ponto de extremidade de previsão.

Name Tipo Description
results

StoredImagePrediction[]

Resultado de uma solicitação de previsão de imagem.
token

PredictionQueryToken

Token de consulta de previsão.

PredictionQueryTag

Object
Name Tipo Description
id

string (uuid)

maxThreshold

number (float)

minThreshold

number (float)

PredictionQueryToken

Object
Name Tipo Description
application

string

continuation

string

endTime

string (date-time)

iterationId

string (uuid)

maxCount

integer (int32)

orderBy

OrderBy

session

string

startTime

string (date-time)

tags

PredictionQueryTag[]

StoredImagePrediction

Object

Resultado de uma solicitação de previsão de imagem.

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.
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.
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.

TagType

Enumeração

Tipo da tag prevista.

Valor Description
Regular
Negative
GeneralProduct