Predictions - Query

Usługa:

Azure AI Services

Wersja interfejsu API:

3.3

Pobierz obrazy, które zostały wysłane do punktu końcowego przewidywania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services.
projectId	path	True	string (uuid)	Identyfikator projektu.

Nagłówek żądania

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nazwa	Wymagane	Typ	Opis
Training-Key	True	string

Treść żądania

Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nazwa	Typ	Opis
application	string
continuation	string
endTime	string (date-time)
iterationId	string (uuid)
maxCount	integer (int32)
orderBy	OrderBy
session	string
startTime	string (date-time)
tags	PredictionQueryTag[]

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PredictionQueryResult	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Odpowiedź na błąd Media Types: "application/json", "application/xml", "text/xml"

Zabezpieczenia

Training-Key

Typ: apiKey
W: header

Przykłady

Successful QueryPredictions request

Przykładowe żądanie

HTTP

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
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:

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": ""
  }
}

Definicje

Nazwa	Opis
BoundingBox	Pole ograniczenia definiujące region obrazu.
CustomVisionError
CustomVisionErrorCodes	Kod błędu.
OrderBy
Prediction	Wynik przewidywania.
PredictionQueryResult	Wyniki zapytania dotyczące obrazów przewidywania, które zostały wysłane do punktu końcowego przewidywania.
PredictionQueryTag
PredictionQueryToken
StoredImagePrediction	Wynik żądania przewidywania obrazu.
TagType	Typ przewidywanego tagu.

BoundingBox

Objekt

Pole ograniczenia definiujące region obrazu.

Nazwa	Typ	Opis
height	number (float)	Wysokość.
left	number (float)	Współrzędna lewej granicy.
top	number (float)	Współrzędna górnej granicy.
width	number (float)	Szerokość.

CustomVisionError

Objekt

Nazwa	Typ	Opis
code	CustomVisionErrorCodes	Kod błędu.
message	string	Komunikat wyjaśniający błąd zgłoszony przez usługę.

CustomVisionErrorCodes

Wyliczanie

Kod błędu.

Wartość	Opis
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

OrderBy

Wyliczanie

Wartość	Opis
Newest
Oldest
Suggested

Prediction

Objekt

Wynik przewidywania.

Nazwa	Typ	Opis
boundingBox	BoundingBox	Pole ograniczenia przewidywania.
probability	number (float)	Prawdopodobieństwo tagu.
tagId	string (uuid)	Identyfikator przewidywanego tagu.
tagName	string	Nazwa przewidywanego tagu.
tagType	TagType	Typ przewidywanego tagu.

PredictionQueryResult

Objekt

Wyniki zapytania dotyczące obrazów przewidywania, które zostały wysłane do punktu końcowego przewidywania.

Nazwa	Typ	Opis
results	StoredImagePrediction[]	Wynik żądania przewidywania obrazu.
token	PredictionQueryToken	Token zapytania przewidywania.

PredictionQueryTag

Objekt

Nazwa	Typ	Opis
id	string (uuid)
maxThreshold	number (float)
minThreshold	number (float)

PredictionQueryToken

Objekt

Nazwa	Typ	Opis
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

Objekt

Wynik żądania przewidywania obrazu.

Nazwa	Typ	Opis
created	string (date-time)	Data utworzenia tego przewidywania.
domain	string (uuid)	Domena używana do przewidywania.
id	string (uuid)	Identyfikator przewidywania.
iteration	string (uuid)	Identyfikator iteracji.
originalImageUri	string	Identyfikator URI oryginalnego obrazu przewidywania. Jeśli funkcja sieci wirtualnej jest włączona, będzie to ścieżka względna do użycia z getArtifact, w przeciwnym razie będzie to bezwzględny identyfikator URI zasobu.
predictions	Prediction[]	Lista przewidywań.
project	string (uuid)	Identyfikator projektu.
resizedImageUri	string	Identyfikator URI do obrazu przewidywania (zmieniono rozmiar). Jeśli funkcja sieci wirtualnej jest włączona, będzie to ścieżka względna do użycia z getArtifact, w przeciwnym razie będzie to bezwzględny identyfikator URI zasobu.
thumbnailUri	string	Identyfikator URI do miniatury oryginalnego obrazu przewidywania. Jeśli funkcja sieci wirtualnej jest włączona, będzie to ścieżka względna do użycia z getArtifact, w przeciwnym razie będzie to bezwzględny identyfikator URI zasobu.

TagType

Wyliczanie

Typ przewidywanego tagu.

Wartość	Opis
GeneralProduct
Negative
Regular