Projects - Get

Service:

Cognitive Services - Custom Vision

API Version:

3.3

取得特定專案。

GET {Endpoint}/customvision/v3.3/training/projects/{projectId}

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點。
projectId	path	True	string uuid	要取得之項目的標識碼。

要求標頭

名稱	必要	類型	Description
Training-Key	True	string

回應

名稱	類型	Description
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

Type: apiKey
In: header

範例

Successful GetProject request

Sample Request

HTTP

GET https://westus.api.cognitive.microsoft.com/customvision/v3.3/training/projects/bc3f7dad-5544-468c-8573-3ef04d55463e

Sample Response

Status code:

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

定義

名稱	Description
Classifier	取得項目的分類類型。
CustomVisionError
CustomVisionErrorCodes	錯誤碼。
ImageProcessingSettings	表示影像增強所使用的影像前置處理設定。
Project	代表專案。
ProjectSettings	表示與專案相關聯的設定。
ProjectStatus	取得項目的狀態。
TargetExportPlatforms	定型模型應該能夠支援的ExportPlatform清單。

Classifier

取得項目的分類類型。

名稱	類型	Description
Multiclass	string
Multilabel	string

CustomVisionError

名稱	類型	Description
code	CustomVisionErrorCodes	錯誤碼。
message	string	說明服務所報告錯誤的訊息。

CustomVisionErrorCodes

錯誤碼。

名稱	類型	Description
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

ImageProcessingSettings

表示影像增強所使用的影像前置處理設定。

名稱	類型	Description
augmentationMethods	object	取得或設定啟用的影像轉換。 索引鍵會對應至轉換名稱。 如果值設定為 true，則會啟用對應轉換。 否則，將不會使用此轉換。 擴增將會在啟用的轉換之間統一散發。

Project

代表專案。

名稱	類型	Description
created	string	取得建立此專案的日期。
description	string	取得或設定專案的描述。
drModeEnabled	boolean	取得當災害復原 (DR) 模式開啟時，表示項目暫時為只讀狀態。
id	string	取得項目標識碼。
lastModified	string	取得上次修改此專案的日期。
name	string	取得或設定專案的名稱。
settings	ProjectSettings	取得或設定項目設定。
status	ProjectStatus	取得項目的狀態。
thumbnailUri	string	取得代表影像的縮圖 URL。 如果已啟用 VNET 功能，這會是與 GetArtifact 搭配使用的相對路徑，否則這會是資源的絕對 URI。

ProjectSettings

表示與專案相關聯的設定。

名稱	類型	Description
classificationType	Classifier	取得或設定項目的分類類型。
detectionParameters	string	如果使用中的偵測參數，如果有的話。
domainId	string	取得或設定要與此專案搭配使用的網域標識碼。
imageProcessingSettings	ImageProcessingSettings	取得或設定影像前置處理設定。
targetExportPlatforms	TargetExportPlatforms[]	定型模型應該能夠支援的ExportPlatform清單。
useNegativeSet	boolean	指出是否使用負數集。

ProjectStatus

取得項目的狀態。

名稱	類型	Description
Failed	string
Importing	string
Succeeded	string

TargetExportPlatforms

定型模型應該能夠支援的ExportPlatform清單。

名稱	類型	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string