Images - Create From Data

Service:

Cognitive Services - Custom Vision

API Version:

3.3

API ini menerima konten isi sebagai multipart/form-data dan application/octet-stream. Saat menggunakan beberapa file gambar multipihak dapat dikirim sekaligus, dengan maksimum 64 file. Jika semua gambar berhasil dibuat, kode status 200 (OK) akan dikembalikan. Jika tidak, kode status 207 (Multi-Status) akan dikembalikan dan status detail untuk setiap gambar akan tercantum dalam payload respons.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
imageData	formData	True	file	Data gambar biner. Format yang didukung adalah JPEG, GIF, PNG, dan BMP. Mendukung gambar hingga 6MB.
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung.
projectId	path	True	string uuid	Id proyek.
tagIds	query		string[]	Tag id untuk menandai setiap gambar. Dibatasi hingga 20.

Header Permintaan

Media Types: "multipart/form-data", "application/octet-stream"

Nama	Diperlukan	Jenis	Deskripsi
Training-Key	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	ImageCreateSummary	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	ImageCreateSummary	207 Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Respons kesalahan Media Types: "application/json", "application/xml", "text/xml"

Keamanan

Training-Key

Type: apiKey
In: header

Contoh

Successful CreateImagesFromData request

Sample Request

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/64b822c5-8082-4b36-a426-27225f4aa18c/images?tagIds=b607964f-7bd6-4a3b-a869-6791fb6aab87

Sample Response

Status code:

200

{
  "isBatchSuccessful": true,
  "images": [
    {
      "sourceUrl": "\"hemlock_10.jpg\"",
      "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 1"
          }
        ]
      }
    },
    {
      "sourceUrl": "\"hemlock_6.jpg\"",
      "status": "OK",
      "image": {
        "id": "f1855a92-b873-47e7-b513-f07a667ceda1",
        "created": "2017-12-19T15:56:10Z",
        "width": 900,
        "height": 1531,
        "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 1"
          }
        ]
      }
    }
  ]
}

Status code:

207

{
  "isBatchSuccessful": false,
  "images": [
    {
      "sourceUrl": "\"hemlock_10.jpg\"",
      "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 1"
          }
        ]
      }
    },
    {
      "sourceUrl": "\"hemlock_6.jpg\"",
      "status": "ErrorLimitExceed"
    }
  ]
}

Definisi

Nama	Deskripsi
CustomVisionError
CustomVisionErrorCodes	Kode kesalahan.
Image	Model gambar yang akan dikirim sebagai JSON.
ImageCreateResult
ImageCreateStatus	Status pembuatan gambar.
ImageCreateSummary
ImageRegion
ImageTag

CustomVisionError

Nama	Jenis	Deskripsi
code	CustomVisionErrorCodes	Kode kesalahan.
message	string	Pesan yang menjelaskan kesalahan yang dilaporkan oleh layanan.

CustomVisionErrorCodes

Kode kesalahan.

Nama	Jenis	Deskripsi
BadRequest	string
BadRequestCannotMigrateProjectWithName	string
BadRequestClassificationTrainingValidationFailed	string
BadRequestCustomerManagedKeyRevoked	string
BadRequestDetectionTrainingNotAllowNegativeTag	string
BadRequestDetectionTrainingValidationFailed	string
BadRequestDomainNotSupportedForAdvancedTraining	string
BadRequestExceedIterationPerProjectLimit	string
BadRequestExceedProjectLimit	string
BadRequestExceedTagPerImageLimit	string
BadRequestExceedTagPerProjectLimit	string
BadRequestExceededBatchSize	string
BadRequestExceededQuota	string
BadRequestExportAlreadyInProgress	string
BadRequestExportPlatformNotSupportedForAdvancedTraining	string
BadRequestExportValidationFailed	string
BadRequestExportWhileTraining	string
BadRequestImageBatch	string
BadRequestImageDimensions	string
BadRequestImageExceededCount	string
BadRequestImageFormat	string
BadRequestImageMetadataKey	string
BadRequestImageMetadataValue	string
BadRequestImageRegions	string
BadRequestImageSizeBytes	string
BadRequestImageStream	string
BadRequestImageTags	string
BadRequestImageUrl	string
BadRequestInvalid	string
BadRequestInvalidArtifactUri	string
BadRequestInvalidEmailAddress	string
BadRequestInvalidIds	string
BadRequestInvalidImportToken	string
BadRequestInvalidPublishName	string
BadRequestInvalidPublishTarget	string
BadRequestIterationDescription	string
BadRequestIterationIsNotTrained	string
BadRequestIterationIsPublished	string
BadRequestIterationName	string
BadRequestIterationNameNotUnique	string
BadRequestIterationNotPublished	string
BadRequestIterationValidationFailed	string
BadRequestMultiClassClassificationTrainingValidationFailed	string
BadRequestMultiLabelClassificationTrainingValidationFailed	string
BadRequestMultipleGeneralProductTag	string
BadRequestMultipleNegativeTag	string
BadRequestNegativeAndRegularTagOnSameImage	string
BadRequestNotLimitedTrial	string
BadRequestNotSupported	string
BadRequestOperationNotSupported	string
BadRequestPredictionIdsExceededCount	string
BadRequestPredictionIdsMissing	string
BadRequestPredictionInvalidApplicationName	string
BadRequestPredictionInvalidQueryParameters	string
BadRequestPredictionResultsExceededCount	string
BadRequestPredictionTagsExceededCount	string
BadRequestProjectDescription	string
BadRequestProjectDuplicated	string
BadRequestProjectImagePreprocessingSettings	string
BadRequestProjectName	string
BadRequestProjectNameNotUnique	string
BadRequestProjectUnknownClassification	string
BadRequestProjectUnknownDomain	string
BadRequestProjectUnsupportedDomainTypeChange	string
BadRequestProjectUnsupportedExportPlatform	string
BadRequestRequiredParamIsNull	string
BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining	string
BadRequestSubscriptionApi	string
BadRequestTagDescription	string
BadRequestTagName	string
BadRequestTagNameNotUnique	string
BadRequestTagType	string
BadRequestTrainingAlreadyInProgress	string
BadRequestTrainingNotNeeded	string
BadRequestTrainingNotNeededButTrainingPipelineUpdated	string
BadRequestTrainingValidationFailed	string
BadRequestUnpublishFailed	string
BadRequestUnsupportedDomain	string
BadRequestWorkspaceCannotBeModified	string
BadRequestWorkspaceNotDeletable	string
Conflict	string
ConflictInvalid	string
ErrorExporterInvalidClassifier	string
ErrorExporterInvalidFeaturizer	string
ErrorExporterInvalidPlatform	string
ErrorFeaturizationAugmentationError	string
ErrorFeaturizationAugmentationUnavailable	string
ErrorFeaturizationInvalidFeaturizer	string
ErrorFeaturizationQueueTimeout	string
ErrorFeaturizationServiceUnavailable	string
ErrorFeaturizationUnrecognizedJob	string
ErrorInvalid	string
ErrorIterationCopyFailed	string
ErrorPrediction	string
ErrorPredictionModelNotCached	string
ErrorPredictionModelNotFound	string
ErrorPredictionServiceUnavailable	string
ErrorPredictionStorage	string
ErrorPreparePerformanceMigrationFailed	string
ErrorProjectExportRequestFailed	string
ErrorProjectImportRequestFailed	string
ErrorProjectInvalidDomain	string
ErrorProjectInvalidPipelineConfiguration	string
ErrorProjectInvalidWorkspace	string
ErrorProjectTrainingRequestFailed	string
ErrorRegionProposal	string
ErrorUnknown	string
ErrorUnknownBaseModel	string
Forbidden	string
ForbiddenDRModeEnabled	string
ForbiddenInvalid	string
ForbiddenUser	string
ForbiddenUserDisabled	string
ForbiddenUserDoesNotExist	string
ForbiddenUserInsufficientCapability	string
ForbiddenUserResource	string
ForbiddenUserSignupAllowanceExceeded	string
ForbiddenUserSignupDisabled	string
NoError	string
NotFound	string
NotFoundApimSubscription	string
NotFoundDomain	string
NotFoundImage	string
NotFoundInvalid	string
NotFoundIteration	string
NotFoundIterationPerformance	string
NotFoundProject	string
NotFoundProjectDefaultIteration	string
NotFoundTag	string
UnsupportedMediaType	string

Image

Model gambar yang akan dikirim sebagai JSON.

Nama	Jenis	Deskripsi
created	string	Tanggal gambar dibuat.
height	integer	Tinggi gambar.
id	string	Id gambar.
metadata	object	Metadata yang terkait dengan gambar ini.
originalImageUri	string	URI ke gambar asli yang diunggah. Jika fitur VNET diaktifkan, ini akan menjadi jalur relatif untuk digunakan dengan GetArtifact, jika tidak, ini akan menjadi URI absolut ke sumber daya.
regions	ImageRegion[]	Wilayah yang terkait dengan gambar ini.
resizedImageUri	string	URI ke gambar (diubah ukurannya) yang digunakan untuk pelatihan. Jika fitur VNET diaktifkan, ini akan menjadi jalur relatif untuk digunakan dengan GetArtifact, jika tidak, ini akan menjadi URI absolut ke sumber daya.
tags	ImageTag[]	Tag yang terkait dengan gambar ini.
thumbnailUri	string	URI ke gambar mini gambar asli. Jika fitur VNET diaktifkan, ini akan menjadi jalur relatif untuk digunakan dengan GetArtifact, jika tidak, ini akan menjadi URI absolut ke sumber daya.
width	integer	Lebar gambar.

ImageCreateResult

Nama	Jenis	Deskripsi
image	Image	Gambarnya.
sourceUrl	string	URL sumber gambar.
status	ImageCreateStatus	Status pembuatan gambar.

ImageCreateStatus

Status pembuatan gambar.

Nama	Jenis	Deskripsi
ErrorImageFormat	string
ErrorImageSize	string
ErrorLimitExceed	string
ErrorNegativeAndRegularTagOnSameImage	string
ErrorRegionLimitExceed	string
ErrorSource	string
ErrorStorage	string
ErrorTagLimitExceed	string
ErrorUnknown	string
OK	string
OKDuplicate	string

ImageCreateSummary

Nama	Jenis	Deskripsi
images	ImageCreateResult[]	Daftar hasil pembuatan gambar.
isBatchSuccessful	boolean	True jika semua gambar dalam batch berhasil dibuat, jika tidak salah.

ImageRegion

Nama	Jenis	Deskripsi
created	string
height	number	Tinggi.
left	number	Koordinat batas kiri.
regionId	string
tagId	string	Id tag yang terkait dengan wilayah ini.
tagName	string
top	number	Koordinat batas atas.
width	number	Lebar.

ImageTag

Nama	Jenis	Deskripsi
created	string
tagId	string
tagName	string