Projects - Create

Service:

Cognitive Services - Custom Vision

API Version:

3.3

Create projektu.

POST {Endpoint}/customvision/v3.3/training/projects?name={name}

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporované koncové body služeb Cognitive Services
name	query	True	string	Název projektu
classificationType	query		string	Typ klasifikátoru pro tento projekt.
description	query		string	Popis projektu.
domainId	query		string uuid	ID domény, která se má použít pro tento projekt. Výchozí hodnota je Obecné.
targetExportPlatforms	query		string[]	Seznam platforem, na které má vytrénovaný model exportovat.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Training-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	Project	OK Media Types: "application/json", "application/xml", "text/xml"
Other Status Codes	CustomVisionError	Chybová odpověď Media Types: "application/json", "application/xml", "text/xml"

Zabezpečení

Training-Key

Type: apiKey
In: header

Příklady

Successful CreateProject request

Sample Request

HTTP

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

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

Definice

Name	Description
Classifier	Získá typ klasifikace projektu.
CustomVisionError
CustomVisionErrorCodes	Kód chyby
ImageProcessingSettings	Představuje nastavení předběžného zpracování obrázku používané rozšířením image.
Project	Představuje projekt.
ProjectSettings	Představuje nastavení přidružená k projektu.
ProjectStatus	Získá stav projektu.
TargetExportPlatforms	Seznam exportníchplatform, které by měl trénovaný model podporovat.

Classifier

Získá typ klasifikace projektu.

Name	Typ	Description
Multiclass	string
Multilabel	string

CustomVisionError

Name	Typ	Description
code	CustomVisionErrorCodes	Kód chyby
message	string	Zpráva vysvětlující chybu hlášenou službou

CustomVisionErrorCodes

Kód chyby

Name	Typ	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

Představuje nastavení předběžného zpracování obrázku používané rozšířením image.

Name	Typ	Description
augmentationMethods	object	Získá nebo nastaví povolené transformace obrázků. Klíč odpovídá názvu transformace. Pokud je hodnota nastavena na true, je povolena odpovídající transformace. Jinak se tato transformace nepoužije. Rozšíření bude rovnoměrně distribuováno mezi povolené transformace.

Project

Představuje projekt.

Name	Typ	Description
created	string	Získá datum vytvoření tohoto projektu.
description	string	Získá nebo nastaví popis projektu.
drModeEnabled	boolean	Získá, pokud je zapnutý režim zotavení po havárii (DR), což znamená, že projekt je dočasně jen pro čtení.
id	string	Získá ID projektu.
lastModified	string	Získá datum poslední změny tohoto projektu.
name	string	Získá nebo nastaví název projektu.
settings	ProjectSettings	Získá nebo nastaví nastavení projektu.
status	ProjectStatus	Získá stav projektu.
thumbnailUri	string	Získá adresu URL miniatury představující obrázek. Pokud je povolená funkce virtuální sítě, bude se jednat o relativní cestu, která se použije s getArtifact, jinak se bude jednat o absolutní identifikátor URI prostředku.

ProjectSettings

Představuje nastavení přidružená k projektu.

Name	Typ	Description
classificationType	Classifier	Získá nebo nastaví typ klasifikace projektu.
detectionParameters	string	Používané parametry detekce, pokud nějaké jsou.
domainId	string	Získá nebo nastaví ID domény pro použití s tímto projektem.
imageProcessingSettings	ImageProcessingSettings	Získá nebo nastaví nastavení předběžného zpracování obrázku.
targetExportPlatforms	TargetExportPlatforms[]	Seznam exportníchplatform, které by měl trénovaný model podporovat.
useNegativeSet	boolean	Označuje, jestli se používá záporná sada.

ProjectStatus

Získá stav projektu.

Name	Typ	Description
Failed	string
Importing	string
Succeeded	string

TargetExportPlatforms

Seznam exportníchplatform, které by měl trénovaný model podporovat.

Name	Typ	Description
CoreML	string
DockerFile	string
ONNX	string
TensorFlow	string
VAIDK	string