Models - Get

Referencia

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Lekéri a megadott azonosító által azonosított modellt.

GET {endpoint}/customvoice/models/{id}?api-version=2023-12-01-preview

URI-paraméterek

Name In Kötelező Típus Description

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	Az erőforrás azonosítója. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	A művelethez használandó API-verzió.

endpoint

path

True

string

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://eastus.api.cognitive.microsoft.com).

path

True

string

Az erőforrás azonosítója.

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

api-version

query

True

string

A művelethez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Itt adja meg a Speech-erőforráskulcsot.

Válaszok

Name	Típus	Description
200 OK	Model	Siker
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adja meg a Speech-erőforráskulcsot.

Type: apiKey
In: header

Példák

Get a model

Sample Request

HTTP

GET {endpoint}/customvoice/models/Jessica?api-version=2023-12-01-preview

Sample Response

Status code:: 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"
}

Definíciók

Name	Description
Error	A legfelső szintű hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez egy legfelső szintű hibát tartalmaz, amely hibakódot, üzenetet, részleteket, célt és egy belső hibát tartalmaz, leíróbb részletekkel.
ErrorCode	Legfelső szintű hibakód
ErrorResponse	A hibaválasz a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	A belső hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez tartalmazza a szükséges tulajdonságok hibakódját, az üzenetet és a választható tulajdonságok célhelyét, a belső hibát (ez beágyazható).
Model	Modellobjektum
ModelFailureReason	Modellbetanítási hiba oka
ModelProperties	Modell tulajdonságai
PresetStyleItem	A recept által támogatott előre beállított stílusok. A hangmodell stílusbetanítási készlet nélkül is támogatja ezeket a stílusokat.
Recipe	A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.
Status	Egy erőforrás állapota.

Error

A legfelső szintű hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez egy legfelső szintű hibát tartalmaz, amely hibakódot, üzenetet, részleteket, célt és egy belső hibát tartalmaz, leíróbb részletekkel.

Name	Típus	Description
code	ErrorCode	Legfelső szintű hibakód
details	Error[]	További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.
innererror	InnerError	A belső hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez tartalmazza a szükséges tulajdonságok hibakódját, az üzenetet és a választható tulajdonságok célhelyét, a belső hibát (ez beágyazható).
message	string	Felső szintű hibaüzenet.
target	string	A hiba forrása. Érvénytelen modell esetén például "modell" vagy "modellazonosító" lenne.

ErrorCode

Legfelső szintű hibakód

Name	Típus	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

A hibaválasz a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Típus	Description
error	Error	A legfelső szintű hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez egy legfelső szintű hibát tartalmaz, amely hibakódot, üzenetet, részleteket, célt és egy belső hibát tartalmaz, leíróbb részletekkel.

InnerError

A belső hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez tartalmazza a szükséges tulajdonságok hibakódját, az üzenetet és a választható tulajdonságok célhelyét, a belső hibát (ez beágyazható).

Name	Típus	Description
code	string	Részletes hibakód a diagnosztikához.
innererror	InnerError	A belső hiba a Microsoft Azure REST API irányelveit követi, amely a következő címen érhető el: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Ez tartalmazza a szükséges tulajdonságok hibakódját, az üzenetet és a választható tulajdonságok célhelyét, a belső hibát (ez beágyazható).
message	string	Részletes hibaüzenet.
target	string	A hiba forrása. Érvénytelen modell esetén például "modell" vagy "modellazonosító" lenne.

Model

Modellobjektum

Name	Típus	Description
consentId	string	Erőforrás-azonosító
createdDateTime	string	Az objektum létrehozásának időbélyege. Az időbélyeg iso 8601 dátum- és időformátumként van kódolva ("ÉÉÉÉ-HH-NN:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modell leírása
engineVersion	string	Motorverzió. Ennek a verziónak a frissítésével a kiejtési hibák legújabb javítása érhető el.
id	string	Erőforrás-azonosító
lastActionDateTime	string	Az aktuális állapot megadásának időbélyege. Az időbélyeg iso 8601 dátum- és időformátumként van kódolva ("ÉÉÉÉ-HH-NN:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A modell területi beállítása. A területi beállítás kódja a BCP-47-et követi. A beszédfelismerési területi beállítások listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
projectId	string	Erőforrás-azonosító
properties	ModelProperties	Modell tulajdonságai
recipe	Recipe	A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.
status	Status	Egy erőforrás állapota.
trainingSetId	string	Erőforrás-azonosító
voiceName	string	Hangnév

ModelFailureReason

Modellbetanítási hiba oka

Name	Típus	Description
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

Modell tulajdonságai

Name	Típus	Description
failureReason	ModelFailureReason	Modellbetanítási hiba oka
presetStyles	string[]	A modell előre beállított stílusai.
styleTrainingSetIds	object	Testre szabott stílusok és a hozzájuk tartozó betanítási készletek.
voiceStyles	string[]	A modell által támogatott összes stílus.

PresetStyleItem

A recept által támogatott előre beállított stílusok. A hangmodell stílusbetanítási készlet nélkül is támogatja ezeket a stílusokat.

Name	Típus	Description
female	string[]	A női hangmodellben támogatott előre beállított stílusok.
male	string[]	A férfi hangmodellben támogatott előre beállított stílusok.

Recipe

A modellépítés receptje. A különböző receptek különböző képességekkel rendelkeznek.

Name	Típus	Description
datasetLocales	string[]	A betanítási adatkészlet területi beállítása. A területi beállítás kódja a BCP-47-et követi. A beszédfelismerési területi beállítások listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
description	string	Recept leírása
kind	string	Recept típusa
maxCustomStyleNum	integer	Egyetlen hangmodellben támogatott maximális egyéni stílusszám.
minStyleUtteranceCount	integer	Az egyes testreszabott stílusok betanításához szükséges minimális beszédelemek száma.
minUtteranceCount	integer	A hangmodellek ezzel a recepttel történő betanításához szükséges minimális beszédelemek száma.
modelLocales	string[]	Az a területi beállítás, amellyel a hangmodellek beszélhetnek ezzel a recepttel. A területi beállítás kódja a BCP-47-et követi. A beszédfelismerési területi beállítások listáját itt https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttstalálja.
presetStyles	<string, PresetStyleItem>	A recept által támogatott előre beállított stílusok területi beállításonként. Ezeket a stílusokat stílusbetanítási készlet nélkül is beszerezheti.
version	string	Recept verziója

Status

Egy erőforrás állapota.

Name	Típus	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Share via

Models - Get

URI-paraméterek

Kérelem fejléce

Válaszok

Biztonság

Ocp-Apim-Subscription-Key

Példák

Get a model

Sample Request

Sample Response

Definíciók

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

További források