Images - Create From Urls
Dodaj podane adresy URL obrazów do zestawu obrazów szkoleniowych. Ten interfejs API akceptuje partię adresów URL i opcjonalnie tagów do tworzenia obrazów. Istnieje limit 64 obrazów i 20 tagów. Jeśli wszystkie obrazy zostaną pomyślnie utworzone, zostanie zwrócony kod stanu 200(OK). W przeciwnym razie zostanie zwrócony kod stanu 207 (Stan wielokrotny), a stan szczegółów każdego obrazu zostanie wyświetlony w ładunku odpowiedzi.
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/urls
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Obsługiwane punkty końcowe usług Cognitive Services. |
|
project
|
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 |
|---|---|---|
| images | ||
| metadata |
object |
Metadane obrazu. Ograniczone do 50 par klucz-wartość na obraz. Długość klucza jest ograniczona do 256. Długość wartości jest ograniczona do 512. |
| tagIds |
string[] (uuid) |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK Media Types: "application/json", "application/xml", "text/xml" |
|
| Other Status Codes |
207 Media Types: "application/json", "application/xml", "text/xml" |
|
| Other Status Codes |
Odpowiedź na błąd Media Types: "application/json", "application/xml", "text/xml" |
Zabezpieczenia
Training-Key
Typ:
apiKey
W:
header
Przykłady
Successful CreateImagesFromUrls request
Przykładowe żądanie
POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/images/urls
{
"images": [
{
"url": "{url to image}"
}
],
"tagIds": [
"b607964f-7bd6-4a3b-a869-6791fb6aab87"
]
}
Przykładowa odpowiedź
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "{url to image}",
"status": "OK",
"image": {
"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 name"
}
]
}
}
]
}
{
"isBatchSuccessful": false,
"images": [
{
"sourceUrl": "{url to image}",
"status": "OK",
"image": {
"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 name"
}
]
}
},
{
"sourceUrl": "{url to image}",
"status": "ErrorSource",
"image": null
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
|
Custom |
|
|
Custom |
Kod błędu. |
| Image |
Model obrazu do wysłania jako JSON. |
|
Image |
|
|
Image |
Stan tworzenia obrazu. |
|
Image |
|
|
Image |
|
|
Image |
|
|
Image |
|
|
Image |
|
| Region |
CustomVisionError
| Nazwa | Typ | Opis |
|---|---|---|
| code |
Kod błędu. |
|
| message |
string |
Komunikat wyjaśniający błąd zgłoszony przez usługę. |
CustomVisionErrorCodes
Kod błędu.
| Wartość | Opis |
|---|---|
| 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 |
Image
Model obrazu do wysłania jako JSON.
| Nazwa | Typ | Opis |
|---|---|---|
| created |
string (date-time) |
Data utworzenia obrazu. |
| height |
integer (int32) |
Wysokość obrazu. |
| id |
string (uuid) |
Identyfikator obrazu. |
| metadata |
object |
Metadane skojarzone z tym obrazem. |
| originalImageUri |
string |
Identyfikator URI oryginalnego przekazanego obrazu. 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. |
| regions |
Regiony skojarzone z tym obrazem. |
|
| resizedImageUri |
string |
Identyfikator URI do obrazu (zmieniany rozmiar) używany do trenowania. 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. |
| tags |
Image |
Tagi skojarzone z tym obrazem. |
| thumbnailUri |
string |
Identyfikator URI miniatury oryginalnego obrazu. 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. |
| width |
integer (int32) |
Szerokość obrazu. |
ImageCreateResult
| Nazwa | Typ | Opis |
|---|---|---|
| image |
Obraz. |
|
| sourceUrl |
string |
Źródłowy adres URL obrazu. |
| status |
Stan tworzenia obrazu. |
ImageCreateStatus
Stan tworzenia obrazu.
| Wartość | Opis |
|---|---|
| OK | |
| OKDuplicate | |
| ErrorSource | |
| ErrorImageFormat | |
| ErrorImageSize | |
| ErrorStorage | |
| ErrorLimitExceed | |
| ErrorTagLimitExceed | |
| ErrorRegionLimitExceed | |
| ErrorUnknown | |
| ErrorNegativeAndRegularTagOnSameImage |
ImageCreateSummary
| Nazwa | Typ | Opis |
|---|---|---|
| images |
Lista wyników tworzenia obrazu. |
|
| isBatchSuccessful |
boolean |
Prawda, jeśli wszystkie obrazy w partii zostały pomyślnie utworzone, w przeciwnym razie wartość false. |
ImageRegion
| Nazwa | Typ | Opis |
|---|---|---|
| created |
string (date-time) |
|
| height |
number (float) |
Wysokość. |
| left |
number (float) |
Współrzędna lewej granicy. |
| regionId |
string (uuid) |
|
| tagId |
string (uuid) |
Identyfikator tagu skojarzonego z tym regionem. |
| tagName |
string |
|
| top |
number (float) |
Współrzędna górnej granicy. |
| width |
number (float) |
Szerokość. |
ImageTag
| Nazwa | Typ | Opis |
|---|---|---|
| created |
string (date-time) |
|
| tagId |
string (uuid) |
|
| tagName |
string |
ImageUrlCreateBatch
| Nazwa | Typ | Opis |
|---|---|---|
| images | ||
| metadata |
object |
Metadane obrazu. Ograniczone do 50 par klucz-wartość na obraz. Długość klucza jest ograniczona do 256. Długość wartości jest ograniczona do 512. |
| tagIds |
string[] (uuid) |
ImageUrlCreateEntry
| Nazwa | Typ | Opis |
|---|---|---|
| regions |
Region[] |
|
| tagIds |
string[] (uuid) |
|
| url |
string |
Adres URL obrazu. |
Region
| Nazwa | Typ | Opis |
|---|---|---|
| height |
number (float) |
Wysokość. |
| left |
number (float) |
Współrzędna lewej granicy. |
| tagId |
string (uuid) |
Identyfikator tagu skojarzonego z tym regionem. |
| top |
number (float) |
Współrzędna górnej granicy. |
| width |
number (float) |
Szerokość. |