Create Project - Create Project

リファレンス

サービス:: Azure AI Services

API バージョン:: 3.4-preview

プロジェクトを作成します。

POST {Endpoint}/customvision/v3.4-preview/training/projects?name={name}

省略可能なパラメーターを含む:

POST {Endpoint}/customvision/v3.4-preview/training/projects?name={name}&description={description}&domainId={domainId}&classificationType={classificationType}&targetExportPlatforms={targetExportPlatforms}

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント。
name	query	True	string	プロジェクトの名前。
classificationType	query		string	このプロジェクト用に作成する分類子の種類。
description	query		string	プロジェクトの説明です。
domainId	query		string (uuid)	このプロジェクトに使用するドメインの ID。既定値は [全般] です。
targetExportPlatforms	query		string[]	トレーニング済みモデルがエクスポートする予定のプラットフォームの一覧。

要求ヘッダー

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

名前	必須	型	説明
Training-Key	True	string

要求本文

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

名前	型	説明
exportModelContainerUri	string	エクスポートされたモデルの格納に使用される Azure Storage コンテナーの URI。
notificationQueueUri	string	プロジェクト関連の通知の送信に使用される Azure Storage キューへの URI。セットアップとメッセージ形式については、Storage 通知ドキュメントを参照してください。

応答

名前	型	説明
200 OK	Project	わかりました Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	エラー応答 Media Types: "application/json", "application/xml", "text/xml"

名前

型

説明

200 OK

Project

わかりました

Media Types: "application/json", "application/xml", "text/xml"

Other Status Codes

CustomVisionError

エラー応答

Media Types: "application/json", "application/xml", "text/xml"

セキュリティ

Training-Key

型: apiKey
/: header

例

Successful CreateProject request

要求のサンプル

HTTP

POST https://westus.api.cognitive.microsoft.com/customvision/v3.4-preview/training/projects?name=My New Project&description=A test project&domainId=ee85a74c-405e-4adc-bb47-ffa8ca0c9f31

応答のサンプル

状態コード:: 200

{
  "id": "bc3f7dad-5544-468c-8573-3ef04d55463e",
  "name": "My New Project",
  "description": "A test project",
  "settings": {
    "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31"
  },
  "created": "2017-12-18T05:43:18Z",
  "lastModified": "2017-12-18T05:43:18Z",
  "thumbnailUri": ""
}

定義

名前	説明
Classifier	プロジェクトの分類の種類を取得します。
CreateProjectOptions	createProject に使用されるオプション。
CustomVisionError
CustomVisionErrorCodes	エラーコード。
ImageProcessingSettings	イメージ拡張で使用される画像の前処理設定を表します。
Project	プロジェクトを表します。
ProjectSettings	プロジェクトに関連付けられている設定を表します。
ProjectStatus	プロジェクトの状態を取得します。
TargetExportPlatforms	トレーニング済みモデルでサポートできる ExportPlatform の一覧。

Classifier

列挙

プロジェクトの分類の種類を取得します。

値	説明
Multiclass
Multilabel

CreateProjectOptions

Object

createProject に使用されるオプション。

名前	型	説明
exportModelContainerUri	string	エクスポートされたモデルの格納に使用される Azure Storage コンテナーの URI。
notificationQueueUri	string	プロジェクト関連の通知の送信に使用される Azure Storage キューへの URI。セットアップとメッセージ形式については、Storage 通知ドキュメントを参照してください。

CustomVisionError

Object

名前	型	説明
code	CustomVisionErrorCodes	エラーコード。
message	string	サービスによって報告されたエラーを説明するメッセージ。

CustomVisionErrorCodes

列挙

エラーコード。

値	説明
BadRequest
BadRequestCannotMigrateProjectWithName
BadRequestClassificationTrainingValidationFailed
BadRequestCustomBaseModelArchitectureRetired
BadRequestCustomBaseModelDomainNotCompatible
BadRequestCustomBaseModelIterationStatusNotCompleted
BadRequestCustomerManagedKeyRevoked
BadRequestDetectionTrainingNotAllowNegativeTag
BadRequestDetectionTrainingValidationFailed
BadRequestDomainNotSupportedForAdvancedTraining
BadRequestExceedIterationPerProjectLimit
BadRequestExceedProjectLimit
BadRequestExceedTagPerImageLimit
BadRequestExceedTagPerProjectLimit
BadRequestExceededBatchSize
BadRequestExceededQuota
BadRequestExportAlreadyInProgress
BadRequestExportPlatformNotSupportedForAdvancedTraining
BadRequestExportValidationFailed
BadRequestExportWhileTraining
BadRequestImageAspectRatio
BadRequestImageBatch
BadRequestImageDimensions
BadRequestImageExceededCount
BadRequestImageFormat
BadRequestImageMetadataKey
BadRequestImageMetadataValue
BadRequestImageRegions
BadRequestImageSizeBytes
BadRequestImageStream
BadRequestImageTags
BadRequestImageUrl
BadRequestInvalid
BadRequestInvalidArtifactUri
BadRequestInvalidEmailAddress
BadRequestInvalidIds
BadRequestInvalidImportToken
BadRequestInvalidPublishName
BadRequestInvalidPublishTarget
BadRequestInvalidUri
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
BadRequestRetiredDomainNotSupportedForTraining
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
ErrorServerTimeOut
ErrorUnknown
ErrorUnknownBaseModel
Forbidden
ForbiddenDRModeEnabled
ForbiddenInvalid
ForbiddenUser
ForbiddenUserDisabled
ForbiddenUserDoesNotExist
ForbiddenUserInsufficientCapability
ForbiddenUserResource
ForbiddenUserSignupAllowanceExceeded
ForbiddenUserSignupDisabled
NoError
NotFound
NotFoundApimSubscription
NotFoundDomain
NotFoundImage
NotFoundInvalid
NotFoundIteration
NotFoundIterationPerformance
NotFoundProject
NotFoundProjectDefaultIteration
NotFoundTag
UnsupportedMediaType

ImageProcessingSettings

Object

イメージ拡張で使用される画像の前処理設定を表します。

名前	型	説明
augmentationMethods	object	有効なイメージ変換を取得または設定します。キーは変換名に対応します。値が true に設定されている場合、対応する変換が有効になります。それ以外の場合、この変換は使用されません。拡張は、有効な変換間で均一に分散されます。

Project

Object

プロジェクトを表します。

名前	型	説明
created	string (date-time)	このプロジェクトが作成された日付を取得します。
description	string	プロジェクトの説明を取得または設定します。
drModeEnabled	boolean	ディザスターリカバリー (DR) モードがオンになっているかどうかを取得します。これは、プロジェクトが一時的に読み取り専用であることを示します。
id	string (uuid)	プロジェクト ID を取得します。
lastModified	string (date-time)	このプロジェクトが最後に変更された日付を取得します。
name	string	プロジェクトの名前を取得または設定します。
settings	ProjectSettings	プロジェクト設定を取得または設定します。
status	ProjectStatus	プロジェクトの状態を取得します。
thumbnailUri	string	画像を表すサムネイル URL を取得します。 VNET 機能が有効になっている場合、これは GetArtifact で使用される相対パスになります。それ以外の場合は、リソースへの絶対 URI になります。

ProjectSettings

Object

プロジェクトに関連付けられている設定を表します。

名前	型	説明
classificationType	Classifier	プロジェクトの分類の種類を取得または設定します。
detectionParameters	string	使用中の検出パラメーター (存在する場合)。
domainId	string (uuid)	このプロジェクトで使用するドメインの ID を取得または設定します。
exportModelContainerUri	string	エクスポートされたモデルの格納に使用される Azure Storage コンテナーの URI。
imageProcessingSettings	ImageProcessingSettings	イメージの前処理設定を取得または設定します。
notificationQueueUri	string	プロジェクト関連の通知の送信に使用される Azure Storage キューへの URI。セットアップとメッセージ形式については、Storage 通知ドキュメントを参照してください。
targetExportPlatforms	TargetExportPlatforms[]	トレーニング済みモデルでサポートできる ExportPlatform の一覧。
useNegativeSet	boolean	負のセットが使用されているかどうかを示します。

ProjectStatus

列挙

プロジェクトの状態を取得します。

値	説明
Failed
Importing
Succeeded

TargetExportPlatforms

列挙

トレーニング済みモデルでサポートできる ExportPlatform の一覧。

値	説明
CoreML
DockerFile
ONNX
OpenVino
TensorFlow
VAIDK

次の方法で共有

Create Project - Create Project

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Training-Key

例

Successful CreateProject request

要求のサンプル

応答のサンプル

定義

Classifier

CreateProjectOptions

CustomVisionError

CustomVisionErrorCodes

ImageProcessingSettings

Project

ProjectSettings

ProjectStatus

TargetExportPlatforms