Consents - Post

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-02-01-preview

Erstellt eine neue Voice-Talent-Zustimmung mit der bereitgestellten Audiodatei.

POST {endpoint}/customvoice/consents/{id}?api-version=2024-02-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
audiodata	formData	True	file	Eine Audiodatei, die die Audiodaten enthält.
companyName	formData	True	string	Der Name des Unternehmens.
locale	formData	True	string	Das Gebietsschema dieser Zustimmung. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachsynthese finden Sie hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	formData	True	string	Die Projekt-ID. RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
voiceTalentName	formData	True	string	Der Name des Sprechers.
description	formData		string	Optionale Beschreibung dieser Einwilligung.
displayName	formData		string	Der Anzeigename dieser Zustimmung.
properties	formData		string	properties (Eigenschaften).
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

Media Types: "multipart/form-data"

Name Erforderlich Typ Beschreibung

Ocp-Apim-Subscription-Key

True

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Geben Sie hier Ihren Speech-Ressourcenschlüssel an.
Operation-Id		string	ID des Statusmonitors für den Vorgang. Wenn der Operation-Id-Header mit einem vorhandenen Vorgang übereinstimmt und die Anforderung nicht mit der vorherigen Anforderung identisch ist, schlägt er mit einer ungültigen 400-Anforderung fehl. RegEx-Muster: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Operation-Id

string

ID des Statusmonitors für den Vorgang. Wenn der Operation-Id-Header mit einem vorhandenen Vorgang übereinstimmt und die Anforderung nicht mit der vorherigen Anforderung identisch ist, schlägt er mit einer ungültigen 400-Anforderung fehl.

RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Antworten

Name	Typ	Beschreibung
201 Created	Consent	Erstellt Header Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten. Header x-ms-error-code: string

Name

Typ

Beschreibung

201 Created

Consent

Erstellt

Header

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ein Fehler ist aufgetreten.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Typ: apiKey
In: header

Beispiele

Beispielanforderung

HTTP

POST {endpoint}/customvoice/consents/Jessica?api-version=2024-02-01-preview

Beispiel für eine Antwort

Statuscode:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2024-02-01-preview
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314

{
  "id": "Jessica",
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "locale": "en-US",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definitionen

Name	Beschreibung
Consent	Consent-Objekt
ConsentFailureReason	Grund für Fehler bei der Zustimmungserstellung
ConsentProperties	Zustimmungseigenschaften
Error	Fehler der obersten Ebene folgen 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 aussagekräftigeren Details.
ErrorCode	Fehlercode der obersten 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 sind.
InnerError	Der innere 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 den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
Status	Status einer Ressource.

Consent-Objekt

Name	Typ	Beschreibung
audioUrl	string	Die öffentlich zugängliche URL der Zustimmungsaudiodatei. Es wird empfohlen, eine Azure-Blob-URL mit SAS zu sein. Diese Eigenschaft ist nur in der Anforderung verfügbar.
companyName	string	Firmenname. Muss mit dem Firmennamen in der Zustimmungsaudiodatei übereinstimmen.
createdDateTime	string	Der Zeitstempel, bei dem das Objekt erstellt wurde. Der Zeitstempel ist 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	Beschreibung der Einwilligung.
displayName	string	Name der Zustimmung.
id	string	Ressourcen-ID
lastActionDateTime	string	Der Zeitstempel, bei dem der aktuelle Status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("YYYY-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Das Gebietsschema dieser Zustimmung. Gebietsschemacode folgt BCP-47. Die Gebietsschemaliste für Sprachsynthese finden Sie hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Ressourcen-ID
properties	ConsentProperties	Zustimmungseigenschaften
status	Status	Status einer Ressource.
voiceTalentName	string	Name des Stimmtalents. Muss mit dem Namen des Sprechers in der Zustimmungsaudiodatei übereinstimmen.

ConsentFailureReason

Grund für Fehler bei der Zustimmungserstellung

Name	Typ	Beschreibung
AudioAndScriptNotMatch	string	Die Zustimmungsaudio stimmt mit der verbalen Aussage überein. Bitte überprüfen Sie die verbale Aussage.
Internal	string	Custom Voice Service-Fehler.

ConsentProperties

Zustimmungseigenschaften

Name	Typ	Beschreibung
failureReason	ConsentFailureReason	Grund für Fehler bei der Zustimmungserstellung

Error

Fehler der obersten Ebene folgen 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 aussagekräftigeren Details.

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode der obersten Ebene
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innererror	InnerError	Der innere 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 den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
message	string	Fehlermeldung der obersten Ebene.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

ErrorCode

Fehlercode der obersten 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 sind.

Name	Typ	Beschreibung
error	Error	Fehler der obersten Ebene folgen 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 aussagekräftigeren Details.

InnerError

Der innere 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 den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Unterstützung der Diagnose.
innererror	InnerError	Der innere 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 den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser 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".

Status

Status einer Ressource.

Name	Typ	Beschreibung
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Freigeben über

Consents - Post

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Zusätzliche Ressourcen

Freigeben über

Consents - Post

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Create a consent

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Zusätzliche Ressourcen