Consents - Post

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2024-02-01-preview

Vytvoří nový souhlas hlasu s poskytnutým zvukovým souborem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
audiodata	formData	True	file	Zvukový soubor obsahující zvuková data.
companyName	formData	True	string	Název společnosti.
locale	formData	True	string	Národní prostředí tohoto souhlasu. Kód národního prostředí se řídí BCP-47. Text na seznam národního prostředí řeči najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	formData	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID projektu.
voiceTalentName	formData	True	string	Jméno talentu hlasu.
description	formData		string	Volitelný popis tohoto souhlasu.
displayName	formData		string	Zobrazovaný název tohoto souhlasu.
properties	formData		string	vlastnosti.
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: 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]$	ID prostředku.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Media Types: "multipart/form-data"

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Sem zadejte svůj klíč prostředku služby Speech.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID monitorování stavu operace. Pokud hlavička Operation-Id odpovídá existující operaci a požadavek není stejný jako předchozí požadavek, selže s chybou 400 Chybný požadavek.

Odpovědi

Name	Typ	Description
201 Created	Consent	Vytvořil Hlavičky Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Došlo k chybě. Hlavičky x-ms-error-code: string

Name

Typ

Description

201 Created

Consent

Vytvořil

Hlavičky

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Došlo k chybě.

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Sem zadejte svůj klíč prostředku služby Speech.

Typ: apiKey
V: header

Příklady

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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"
}

Definice

Name	Description
Consent	Objekt souhlasu
ConsentFailureReason	Důvod selhání vytvoření souhlasu
ConsentProperties	Vlastnosti souhlasu
Error	Chyba nejvyšší úrovně se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici na https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje chybu nejvyšší úrovně s kódem chyby, zprávou, podrobnostmi, cílem a vnitřní chybou s popisnějšími podrobnostmi.
ErrorCode	Kód chyby nejvyšší úrovně
ErrorResponse	Odpověď na chybu se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (jde vnořit).
Status	Stav prostředku

Objekt

Objekt souhlasu

Name	Typ	Description
audioUrl	string (uri)	Veřejná přístupná adresa URL zvukového souboru souhlasu. Doporučuje se použít adresu URL objektu blob Azure s SAS. Tato vlastnost je k dispozici pouze v požadavku.
companyName	string minLength: 1	Název společnosti. Musí odpovídat názvu společnosti ve zvukovém souboru souhlasu.
createdDateTime	string (date-time)	Časové razítko při vytvoření objektu. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Popis souhlasu
displayName	string minLength: 1	Název souhlasu.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID prostředku
lastActionDateTime	string (date-time)	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódované jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Národní prostředí tohoto souhlasu. Kód národního prostředí se řídí BCP-47. Text na seznam národního prostředí řeči najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID prostředku
properties	ConsentProperties	Vlastnosti souhlasu
status	Status	Stav prostředku
voiceTalentName	string minLength: 1	Jméno talentu hlasu. Musí odpovídat názvu talentu hlasu v zvukovém souboru souhlasu.

ConsentFailureReason

Výčet

Důvod selhání vytvoření souhlasu

Hodnota	Description
AudioAndScriptNotMatch	Neshoda zvuku souhlasu se slovním prohlášením. Zkontrolujte slovní prohlášení.
Internal	Vlastní chyba hlasové služby

ConsentProperties

Objekt

Vlastnosti souhlasu

Name	Typ	Description
failureReason	ConsentFailureReason	Důvod selhání vytvoření souhlasu

Error

Objekt

Chyba nejvyšší úrovně se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici na https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje chybu nejvyšší úrovně s kódem chyby, zprávou, podrobnostmi, cílem a vnitřní chybou s popisnějšími podrobnostmi.

Name	Typ	Description
code	ErrorCode	Kód chyby nejvyšší úrovně
details	Error[]	Další podrobnosti podpory týkající se chyb a/nebo očekávaných zásad
innererror	InnerError	Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (jde vnořit).
message	string	Chybová zpráva nejvyšší úrovně
target	string	Zdroj chyby. Například v případě neplatného modelu by to byl model nebo ID modelu.

ErrorCode

Výčet

Kód chyby nejvyšší úrovně

Hodnota	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

Odpověď na chybu se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Description
error	Error	Chyba nejvyšší úrovně se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici na https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje chybu nejvyšší úrovně s kódem chyby, zprávou, podrobnostmi, cílem a vnitřní chybou s popisnějšími podrobnostmi.

InnerError

Objekt

Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (jde vnořit).

Name	Typ	Description
code	string	Podrobný kód chyby, který vám pomůže s diagnostikou
innererror	InnerError	Vnitřní chyba se řídí pokyny rozhraní MICROSOFT Azure REST API, které jsou k dispozici v https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Obsahuje kód chyby požadovaných vlastností, zprávu a cíl volitelných vlastností, vnitřní chybu (jde vnořit).
message	string	Podrobná chybová zpráva
target	string	Zdroj chyby. Například v případě neplatného modelu by to byl model nebo ID modelu.

Status

Výčet

Stav prostředku

Hodnota	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Sdílet prostřednictvím

Consents - Post

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Create a consent

Ukázkový požadavek

Ukázková odpověď

Definice

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status