Projects - Create

Dienst:

Cognitive Services - Custom Voice

API-Version:

2023-12-01-preview

Erstellt ein neues Projekt.

PUT {endpoint}/customvoice/projects/{id}?api-version=2023-12-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://eastus.api.cognitive.microsoft.com
id	path	True	string	Die ID der Ressource. RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
kind	True	ProjectKind	Projektart
description		string	Projektbeschreibung
displayName		string	Projektname
id		string	Ressourcen-ID

Antworten

Name	Typ	Beschreibung
201 Created	Project	Erstellt
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Typ: apiKey
In: header

Beispiele

Create a project

Sample request

HTTP

PUT {endpoint}/customvoice/projects/Jessica?api-version=2023-12-01-preview


{
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice"
}

Sample response

Status code:

201

{
  "id": "Jessica",
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice",
  "createdDateTime": "2023-04-01T05:30:00.000Z"
}

Definitionen

Name	Beschreibung
Error	Fehler auf oberster Ebene folgen den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler der obersten Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.
ErrorCode	Fehlercode auf oberster Ebene
ErrorResponse	Die Fehlerantwort folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist.
InnerError	Der innere Fehler folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist. Dies enthält den erforderlichen Eigenschaftenfehlercode, Nachricht und optionale Eigenschaften ziel, innerer Fehler (dies kann geschachtelt werden).
Project	Project-Objekt. Zustimmungen, Trainingssätze, Modelle und Endpunkte werden in einem Projekt organisiert.
ProjectKind	Projektart

Error

Fehler auf oberster Ebene folgen den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler der obersten Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode auf oberster Ebene
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innererror	InnerError	Der innere Fehler folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist. Dies enthält den erforderlichen Eigenschaftenfehlercode, Nachricht und optionale Eigenschaften ziel, innerer Fehler (dies kann geschachtelt werden).
message	string	Fehlermeldung auf oberster Ebene.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

ErrorCode

Fehlercode auf oberster Ebene

Name	Typ	Beschreibung
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Die Fehlerantwort folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist.

Name	Typ	Beschreibung
error	Error	Fehler auf oberster Ebene folgen den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler der obersten Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.

InnerError

Der innere Fehler folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist. Dies enthält den erforderlichen Eigenschaftenfehlercode, Nachricht und optionale Eigenschaften ziel, innerer Fehler (dies kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Unterstützung der Diagnose.
innererror	InnerError	Der innere Fehler folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar ist. Dies enthält den erforderlichen Eigenschaftenfehlercode, Nachricht und optionale Eigenschaften ziel, innerer Fehler (dies kann geschachtelt werden).
message	string	Ausführliche Fehlermeldung.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

Project

Project-Objekt. Zustimmungen, Trainingssätze, Modelle und Endpunkte werden in einem Projekt organisiert.

Name	Typ	Beschreibung
createdDateTime	string	Der Zeitstempel, bei dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Projektbeschreibung
displayName	string	Projektname
id	string	Ressourcen-ID
kind	ProjectKind	Projektart

ProjectKind

Projektart

Name	Typ	Beschreibung
PersonalVoice	string
ProfessionalVoice	string