Models - Get

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-02-01-preview

Pobiera model zidentyfikowany przez podany identyfikator.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	Identyfikator zasobu. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Tutaj podaj klucz zasobu usługi Mowa.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Model	Powodzenie
Other Status Codes	ErrorResponse	Wystąpił błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz zasobu usługi Mowa.

Typ: apiKey
W: header

Przykłady

Get a model

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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"
}

Definicje

Nazwa	Opis
Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.
ErrorCode	Kod błędu najwyższego poziomu
ErrorResponse	Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
Model	Obiekt modelu
ModelFailureReason	Przyczyna niepowodzenia trenowania modelu
ModelProperties	Właściwości modelu
PresetStyleItem	Ustawienia wstępne stylów obsługiwane przez przepis. Model głosu może obsługiwać te style bez żadnego zestawu treningowego stylu.
Recipe	Przepis na budowanie modelu. Różne przepisy mają różne możliwości.
Status	Stan zasobu.

Error

Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu najwyższego poziomu
details	Error[]	Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie najwyższego poziomu.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

ErrorCode

Kod błędu najwyższego poziomu

Nazwa	Typ	Opis
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nazwa	Typ	Opis
error	Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

InnerError

Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).

Nazwa	Typ	Opis
code	string	Szczegółowy kod błędu pomocny w diagnostyce.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
message	string	Szczegółowy komunikat o błędzie.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

Model

Obiekt modelu

Nazwa	Typ	Opis
consentId	string	Identyfikator zasobu
createdDateTime	string	Sygnatura czasowa utworzenia obiektu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Opis modelu
engineVersion	string	Wersja aparatu. Aktualizacja tej wersji może uzyskać najnowszą poprawkę usterek wymowy.
id	string	Identyfikator zasobu
lastActionDateTime	string	Sygnatura czasowa wprowadzenia bieżącego stanu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Ustawienia regionalne tego modelu. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Identyfikator zasobu
properties	ModelProperties	Właściwości modelu
recipe	Recipe	Przepis na budowanie modelu. Różne przepisy mają różne możliwości.
status	Status	Stan zasobu.
trainingSetId	string	Identyfikator zasobu
voiceName	string	Nazwa głosu

ModelFailureReason

Przyczyna niepowodzenia trenowania modelu

Nazwa	Typ	Opis
InaccessibleCustomerStorage	string	Klient korzysta z usługi Bring Your Own Storage na koncie mowy. Jednak magazyn nie jest teraz dostępny. Sprawdź dokument.
Internal	string	Błąd usługi Custom Voice Service.
SpeakerVerificationFailed	string	Zgoda i dźwięk treningowy nie pochodzą z tego samego głośnika.
TerminateByUser	string	Klient anulował trenowanie modelu.

ModelProperties

Właściwości modelu

Nazwa	Typ	Opis
failureReason	ModelFailureReason	Przyczyna niepowodzenia trenowania modelu
presetStyles	string[]	Ustawienia wstępne stylów tego modelu.
styleTrainingSetIds	object	Dostosowane style i skojarzone zestawy treningowe.
voiceStyles	string[]	Wszystkie style obsługiwane przez ten model.

PresetStyleItem

Ustawienia wstępne stylów obsługiwane przez przepis. Model głosu może obsługiwać te style bez żadnego zestawu treningowego stylu.

Nazwa	Typ	Opis
female	string[]	Wstępnie ustawione style obsługiwane w modelu głosu kobiecego.
male	string[]	Wstępnie ustawione style obsługiwane w modelu głosu męskiego.

Recipe

Przepis na budowanie modelu. Różne przepisy mają różne możliwości.

Nazwa	Typ	Opis
datasetLocales	string[]	Ustawienia regionalne zestawu danych trenowania. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Opis przepisu
kind	string	Rodzaj przepisu
maxCustomStyleNum	integer	Maksymalna niestandardowa liczba stylów obsługiwana w jednym modelu głosowym.
minStyleUtteranceCount	integer	Minimalna liczba wypowiedzi wymagana do trenowania każdego dostosowanego stylu.
minUtteranceCount	integer	Minimalna liczba wypowiedzi wymagana do wytrenowania modelu głosu przy użyciu tego przepisu.
modelLocales	string[]	Ustawienia regionalne, które model głosowy może mówić z tym przepisem. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string,  PresetStyleItem>	Ustawienia wstępne obsługiwane przez ten przepis na ustawienia regionalne. Możesz uzyskać te style bez żadnego zestawu treningowego stylu.
version	string	Wersja przepisu

Status

Stan zasobu.

Nazwa	Typ	Opis
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string