Models - Get

Reference

Služba:: Azure AI Services

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

Získá model identifikovaný daným ID.

GET {endpoint}/customvoice/models/{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	string	Sem zadejte svůj klíč prostředku služby Speech.

Odpovědi

Name	Typ	Description
200 OK	Model	Success
Other Status Codes	ErrorResponse	Došlo k chybě. Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

Model

Success

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

Get a model

Ukázkový požadavek

HTTP

GET {endpoint}/customvoice/models/Jessica?api-version=2024-02-01-preview

Ukázková odpověď

Stavový kód:: 200

{
  "id": "Jessica",
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default",
    "version": "V7.2023.03"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "engineVersion": "2023.07.04.0",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definice

Name	Description
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 volitelný cíl vlastností, vnitřní chybu (může být vnořená).
Model	Objekt modelu
ModelFailureReason	Důvod selhání trénování modelu
ModelProperties	Vlastnosti modelu
PresetStyleItem	Přednastavené styly podporované receptem. Hlasový model může tyto styly podporovat bez jakékoli trénovací sady stylů.
Recipe	Recept na vytváření modelů Různé recepty mají různé možnosti.
Status	Stav prostředku.

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ší podpůrné podrobnosti 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 volitelný cíl vlastností, vnitřní chybu (může být vnořená).
message	string	Chybová zpráva nejvyšší úrovně
target	string	Zdroj chyby. V případě neplatného modelu by to bylo například "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 volitelný cíl 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 volitelný cíl vlastností, vnitřní chybu (může být vnořená).
message	string	Podrobná chybová zpráva
target	string	Zdroj chyby. V případě neplatného modelu by to bylo například "model" nebo "id modelu".

Model

Objekt modelu

Name	Typ	Description
consentId	string	ID prostředku
createdDateTime	string	Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódované 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 modelu
engineVersion	string	Verze modulu. Aktualizace této verze může získat nejnovější opravu chyby výslovnosti.
id	string	ID prostředku
lastActionDateTime	string	Časové razítko, kdy byl zadán aktuální stav. Časové razítko je kódované 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 modelu. Kód národního prostředí se řídí BCP-47. Seznam národního prostředí převodu textu na řeč najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	ID prostředku
properties	ModelProperties	Vlastnosti modelu
recipe	Recipe	Recept na vytváření modelů Různé recepty mají různé možnosti.
status	Status	Stav prostředku.
trainingSetId	string	ID prostředku
voiceName	string	Jméno hlasu

ModelFailureReason

Důvod selhání trénování modelu

Name	Typ	Description
InaccessibleCustomerStorage	string	Zákazník používá úložiště Přineste si vlastní v účtu služby Speech. Úložiště ale teď není přístupné. Projděte si dokument.
Internal	string	Chyba služby Custom Voice Service
SpeakerVerificationFailed	string	Vyjádření souhlasu a trénování nejsou od stejného mluvčího.
TerminateByUser	string	Zákazník zrušil trénování modelu.

ModelProperties

Vlastnosti modelu

Name	Typ	Description
failureReason	ModelFailureReason	Důvod selhání trénování modelu
presetStyles	string[]	Přednastavené styly tohoto modelu.
styleTrainingSetIds	object	Přizpůsobené styly a přidružené trénovací sady
voiceStyles	string[]	Všechny styly podporované tímto modelem

PresetStyleItem

Přednastavené styly podporované receptem. Hlasový model může tyto styly podporovat bez jakékoli trénovací sady stylů.

Name	Typ	Description
female	string[]	Přednastavené styly podporované u ženského hlasového modelu.
male	string[]	Přednastavené styly podporované u modelu mužského hlasu.

Recipe

Recept na vytváření modelů Různé recepty mají různé možnosti.

Name	Typ	Description
datasetLocales	string[]	Národní prostředí trénovací datové sady. Kód národního prostředí se řídí BCP-47. Seznam národního prostředí převodu textu na řeč najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Popis receptu
kind	string	Druh receptu
maxCustomStyleNum	integer	Maximální počet přizpůsobených stylů podporovaných v jednom hlasovém modelu
minStyleUtteranceCount	integer	Minimální počet promluv potřebný k trénování jednotlivých přizpůsobených stylů
minUtteranceCount	integer	Minimální počet promluv požadovaný k trénování hlasového modelu pomocí tohoto receptu.
modelLocales	string[]	Národní prostředí, které hlasový model může s tímto receptem mluvit. Kód národního prostředí se řídí BCP-47. Seznam národního prostředí převodu textu na řeč najdete tady https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Přednastavené styly podporované tímto receptem pro národní prostředí. Tyto styly můžete získat bez jakékoli trénovací sady stylů.
version	string	Verze receptu

Status

Stav prostředku.

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

Sdílet prostřednictvím

Models - Get

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Get a model

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Další materiály