Consents - Create

Reference

Služba:: Azure AI Services

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

Vytvoří nový souhlas hlasového talentu se zadanou adresou URL zvuku.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
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	ID prostředku. Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

endpoint

path

True

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://eastus.api.cognitive.microsoft.com).

path

True

string

ID prostředku.

Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description

Ocp-Apim-Subscription-Key

True

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Tady zadejte svůj klíč prostředku služby Speech.
Operation-Id		string	ID monitorování stavu operace Pokud hlavička Operation-Id odpovídá existující operaci a požadavek není shodný s předchozím požadavkem, selže s chybnou žádostí 400. Vzor regulárního výrazu: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

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

Operation-Id

string

ID monitorování stavu operace Pokud hlavička Operation-Id odpovídá existující operaci a požadavek není shodný s předchozím požadavkem, selže s chybnou žádostí 400.

Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Text požadavku

Name	Vyžadováno	Typ	Description
companyName	True	string	Název společnosti. Musí odpovídat názvu společnosti ve zvukovém souboru souhlasu.
locale	True	string	Národní prostředí tohoto souhlasu. Kód národního prostředí se řídí BCP-47. Seznam národního prostředí pro převod textu na řeč najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	ID prostředku
voiceTalentName	True	string	Jméno hlasového talentu. Musí se shodovat s názvem hlasového talentu ve zvukovém souboru pro vyjádření souhlasu.
audioUrl		string	Veřejně přístupná adresa URL zvukového souboru souhlasu. Doporučuje se být adresa URL objektu blob Azure se SAS. Tato vlastnost je k dispozici pouze na vyžádání.
description		string	Popis souhlasu.
displayName		string	Název souhlasu.
id		string	ID prostředku
properties		ConsentProperties	Vlastnosti souhlasu
status		Status	Stav prostředku.

Odpovědi

Name	Typ	Description
201 Created	Consent	Vytvořeno 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řeno

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

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

Typ: apiKey
V: header

Příklady

Ukázkový požadavek

HTTP

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



{
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
  "locale": "en-US"
}

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í vytváření souhlasu
ConsentProperties	Vlastnosti souhlasu
Error	Chyba nejvyšší úrovně se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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 k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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 (může být vnořená).
Status	Stav prostředku.

Objekt souhlasu

Name	Typ	Description
audioUrl	string	Veřejně přístupná adresa URL zvukového souboru souhlasu. Doporučuje se být adresa URL objektu blob Azure se SAS. Tato vlastnost je k dispozici pouze na vyžádání.
companyName	string	Název společnosti. Musí odpovídat názvu společnosti ve zvukovém souboru souhlasu.
createdDateTime	string	Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódováno jako formát data a času ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Popis souhlasu.
displayName	string	Název souhlasu.
id	string	ID prostředku
lastActionDateTime	string	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódováno jako formát data a času ISO 8601 ("YYYY-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. Seznam národního prostředí pro převod textu na řeč najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	ID prostředku
properties	ConsentProperties	Vlastnosti souhlasu
status	Status	Stav prostředku.
voiceTalentName	string	Jméno hlasového talentu. Musí se shodovat s názvem hlasového talentu ve zvukovém souboru pro vyjádření souhlasu.

ConsentFailureReason

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

Name	Typ	Description
AudioAndScriptNotMatch	string	Neshoda zvuku souhlasu se slovním prohlášením. Zkontrolujte prosím slovní výrok.
Internal	string	Chyba vlastní hlasové služby.

ConsentProperties

Vlastnosti souhlasu

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

Error

Chyba nejvyšší úrovně se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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 chyby nebo očekávaných zásad
innererror	InnerError	Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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 (může být vnořená).
message	string	Chybová zpráva nejvyšší úrovně.
target	string	Zdroj chyby. Například v případě neplatného modelu by to bylo "model" nebo "id modelu".

ErrorCode

Kód chyby nejvyšší úrovně

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

ErrorResponse

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

Name	Typ	Description
error	Error	Chyba nejvyšší úrovně se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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

Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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 (může být vnořená).

Name	Typ	Description
code	string	Podrobný kód chyby, který vám pomůže s diagnostikou
innererror	InnerError	Vnitřní chyba se řídí pokyny k rozhraní Microsoft Azure REST API, které jsou k dispozici na adrese 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 (může být vnořená).
message	string	Podrobná chybová zpráva
target	string	Zdroj chyby. Například v případě neplatného modelu by to bylo "model" nebo "id modelu".

Status

Stav prostředku.

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

Sdílet prostřednictvím

Consents - Create

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Ukázkový požadavek

Ukázková odpověď

Definice

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Další materiály

Sdílet prostřednictvím

Consents - Create

Parametry identifikátoru URI

Hlavička požadavku

Text 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

Další materiály