Projects - Create

Dienst:

Azure AI Services

API-Version:

2024-02-01-preview

Erstellt ein neues Projekt.

PUT {endpoint}/customvoice/projects/{id}?api-version=2024-02-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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Die ID der Ressource.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

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

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
kind	True	ProjectKind	Projektart
description		string	Projektbeschreibung
displayName		string minLength: 1	Projektname
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID

Antworten

Name	Typ	Beschreibung
201 Created	Project	Erstellt
Other Status Codes	ErrorResponse	Fehler. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Sprachressourcenschlüssel an.

Typ: apiKey
In: header

Beispiele

Create a project

Beispielanforderung

HTTP

PUT {endpoint}/customvoice/projects/Jessica?api-version=2024-02-01-preview


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

Beispiel für eine Antwort

Statuscode:

201

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

Definitionen

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

Error

Objekt

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

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

ErrorCode

Enumeration

Fehlercode der obersten Ebene

Wert	Beschreibung
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

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

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

InnerError

Objekt

Interner Fehler folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Diagnose.
innererror	InnerError	Interner Fehler folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
message	string	Detaillierte Fehlermeldung.
target	string	Die Quelle des Fehlers. Dies wäre z. B. "Modell" oder "Modell-ID" im Falle eines ungültigen Modells.

Project

Objekt

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

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Projektbeschreibung
displayName	string minLength: 1	Projektname
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID
kind	ProjectKind	Projektart

ProjectKind

Enumeration

Projektart

Wert	Beschreibung
PersonalVoice
ProfessionalVoice