Images - Create From Urls
Lägg till de angivna bild-URL:erna i uppsättningen träningsbilder. Det här API:et accepterar en batch med URL:er och eventuellt taggar för att skapa avbildningar. Det finns en gräns på 64 bilder och 20 taggar. Om alla avbildningar har skapats returneras statuskoden 200 (OK). Annars returneras statuskoden 207 (Multi-Status) och detaljstatusen för varje bild visas i svarsnyttolasten.
POST {Endpoint}/customvision/v3.3/training/projects/{projectId}/images/urls
URI-parametrar
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
Cognitive Services-slutpunkter som stöds. |
|
project
|
path | True |
string (uuid) |
Projekt-ID:t. |
Begärandehuvud
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| Training-Key | True |
string |
Begärandetext
Media Types: "application/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Typ | Description |
|---|---|---|
| images | ||
| metadata |
object |
Metadata för bilden. Begränsat till 50 nyckel/värde-par per bild. Längden på nyckeln är begränsad till 256. Längden på värdet är begränsad till 512. |
| tagIds |
string[] (uuid) |
Svar
| Name | Typ | Description |
|---|---|---|
| 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 |
Felsvar Media Types: "application/json", "application/xml", "text/xml" |
Säkerhet
Training-Key
Typ:
apiKey
I:
header
Exempel
Successful CreateImagesFromUrls request
Exempelbegäran
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"
]
}
Exempelsvar
{
"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
}
]
}
Definitioner
| Name | Description |
|---|---|
|
Custom |
|
|
Custom |
Felkoden. |
| Image |
Bildmodell som ska skickas som JSON. |
|
Image |
|
|
Image |
Status för skapandet av avbildningen. |
|
Image |
|
|
Image |
|
|
Image |
|
|
Image |
|
|
Image |
|
| Region |
CustomVisionError
| Name | Typ | Description |
|---|---|---|
| code |
Felkoden. |
|
| message |
string |
Ett meddelande som förklarar felet som rapporterats av tjänsten. |
CustomVisionErrorCodes
Felkoden.
| Värde | 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 |
Image
Bildmodell som ska skickas som JSON.
| Name | Typ | Description |
|---|---|---|
| created |
string (date-time) |
Datum då avbildningen skapades. |
| height |
integer (int32) |
Bildens höjd. |
| id |
string (uuid) |
Id för bilden. |
| metadata |
object |
Metadata som är associerade med den här bilden. |
| originalImageUri |
string |
URI:n till den ursprungliga uppladdade bilden. Om VNET-funktionen är aktiverad är detta en relativ sökväg som ska användas med GetArtifact, annars blir detta en absolut URI för resursen. |
| regions |
Regioner som är associerade med den här bilden. |
|
| resizedImageUri |
string |
URI:n till den (storleksanpassade) avbildningen som används för träning. Om VNET-funktionen är aktiverad är detta en relativ sökväg som ska användas med GetArtifact, annars blir detta en absolut URI för resursen. |
| tags |
Image |
Taggar som är associerade med den här bilden. |
| thumbnailUri |
string |
URI:n till miniatyrbilden av den ursprungliga bilden. Om VNET-funktionen är aktiverad är detta en relativ sökväg som ska användas med GetArtifact, annars blir detta en absolut URI för resursen. |
| width |
integer (int32) |
Bredd på bilden. |
ImageCreateResult
| Name | Typ | Description |
|---|---|---|
| image |
Bilden. |
|
| sourceUrl |
string |
Käll-URL för bilden. |
| status |
Status för skapandet av avbildningen. |
ImageCreateStatus
Status för skapandet av avbildningen.
| Värde | Description |
|---|---|
| OK | |
| OKDuplicate | |
| ErrorSource | |
| ErrorImageFormat | |
| ErrorImageSize | |
| ErrorStorage | |
| ErrorLimitExceed | |
| ErrorTagLimitExceed | |
| ErrorRegionLimitExceed | |
| ErrorUnknown | |
| ErrorNegativeAndRegularTagOnSameImage |
ImageCreateSummary
| Name | Typ | Description |
|---|---|---|
| images |
Lista över resultatet av bildskapandet. |
|
| isBatchSuccessful |
boolean |
Sant om alla avbildningar i batchen har skapats, annars falskt. |
ImageRegion
| Name | Typ | Description |
|---|---|---|
| created |
string (date-time) |
|
| height |
number (float) |
Höjd. |
| left |
number (float) |
Koordinat för den vänstra gränsen. |
| regionId |
string (uuid) |
|
| tagId |
string (uuid) |
ID för taggen som är associerad med den här regionen. |
| tagName |
string |
|
| top |
number (float) |
Koordinat för den övre gränsen. |
| width |
number (float) |
Bredd. |
ImageTag
| Name | Typ | Description |
|---|---|---|
| created |
string (date-time) |
|
| tagId |
string (uuid) |
|
| tagName |
string |
ImageUrlCreateBatch
| Name | Typ | Description |
|---|---|---|
| images | ||
| metadata |
object |
Metadata för bilden. Begränsat till 50 nyckel/värde-par per bild. Längden på nyckeln är begränsad till 256. Längden på värdet är begränsad till 512. |
| tagIds |
string[] (uuid) |
ImageUrlCreateEntry
| Name | Typ | Description |
|---|---|---|
| regions |
Region[] |
|
| tagIds |
string[] (uuid) |
|
| url |
string |
Url till bilden. |
Region
| Name | Typ | Description |
|---|---|---|
| height |
number (float) |
Höjd. |
| left |
number (float) |
Koordinat för den vänstra gränsen. |
| tagId |
string (uuid) |
ID för taggen som är associerad med den här regionen. |
| top |
number (float) |
Koordinat för den övre gränsen. |
| width |
number (float) |
Bredd. |