Models - Get

Usługa:: Azure AI Services

Wersja interfejsu API:: 2026-01-01

Pobiera model identyfikowany przez podany identyfikator.

GET {endpoint}/customvoice/models/{id}?api-version=2026-01-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Model	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

Model

Żądanie zakończyło się pomyślnie.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get a model

Przykładowe żądanie

HTTP

GET {endpoint}/customvoice/models/Jessica?api-version=2026-01-01

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Model	Obiekt modelu
ModelFailureReason	Przyczyna niepowodzenia treningu modelu
ModelProperties	Właściwości modelu
PresetStyleItem	Wstępnie ustalone style wspierane przez przepis. Model głosu może obsługiwać te style bez żadnego zestawu treningowego stylu.
Recipe	Przepis na budowanie modeli. Różne przepisy mają różne możliwości.
Status	Status zasobu.

Azure.Core.Foundations.Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z Azure wytycznymi API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

Model

Objekt

Obiekt modelu

Nazwa	Typ	Opis
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
createdDateTime	string (date-time)	Znacznik czasu utworzenia obiektu. Znacznik czasu jest kodowany jako format daty i godziny ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", patrz ).https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations
description	string	Opis modelu
engineVersion	string	Wersja aparatu. Aktualizacja tej wersji pozwala uzyskać najnowszą poprawkę błędów wymowy.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
lastActionDateTime	string (date-time)	Znacznik czasu wpisania aktualnego statusu. Znacznik czasu jest kodowany jako format daty i godziny ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", patrz ).https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations
locale	string	Miejsce powstania 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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
properties	ModelProperties	Właściwości modelu
recipe	Recipe	Przepis na budowanie modeli. Różne przepisy mają różne możliwości.
status	Status	Status zasobu.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
voiceName	string minLength: 1	Nazwa głosu

ModelFailureReason

Wyliczenie

Przyczyna niepowodzenia treningu modelu

Wartość	Opis
InaccessibleCustomerStorage	Klient korzysta z konta Bring Your Own Storage w Speech. Ale obecnie magazyn nie jest dostępny. Proszę sprawdzić dokument.
SpeakerVerificationFailed	Zgoda i dźwięk szkoleniowy nie pochodzą z tego samego głośnika.
TerminateByUser	Klient odwołał trening modelu.
Internal	Błąd niestandardowej usługi głosowej.
DataNotReady	Dane treningowe nie są gotowe do trenowania modelu.
DataNotEnough	Dane treningowe nie wystarczą do trenowania modelu.

ModelProperties

Objekt

Właściwości modelu

Nazwa	Typ	Opis
failedTrainingsets	string[]	ID nieudanych zestawów treningowych.
failureReason	ModelFailureReason	Przyczyna niepowodzenia treningu modelu
presetStyles	string[]	Ustalone style tego modelu.
secondaryLocales	string[]	Drugorzędne lokalizacje, w których ten model może mówić. Kod ustawień regionalnych jest zgodny z kodem BCP-47.
styleTrainingSetIds	object	Spersonalizowane style i powiązane zestawy treningowe.
voiceStyles	string[]	Wszystkie style wspierane przez ten model.

PresetStyleItem

Objekt

Wstępnie ustalone style wspierane przez przepis. Model głosu może obsługiwać te style bez żadnego zestawu treningowego stylu.

Nazwa	Typ	Opis
female	string[]	Obsługiwane są presety na modelu głosu kobiecego.
male	string[]	Obsługiwane są presetowe style na męskim modelu głosowym.

Recipe

Objekt

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

Nazwa	Typ	Opis
datasetLocales	string[]	Lokalizacja zbioru danych treningowych. 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 (int32)	Maksymalna liczba spersonalizowanych stylów obsługiwana w jednym modelu głosowym.
minDurationInSeconds	number (double)	Minimalny czas trwania dźwięku w sekundach potrzebny do wytrenowania modelu głosu według tego przepisu.
minStyleUtteranceCount	integer (int32)	Minimalna liczba wypowiedzi wymagana do trenowania każdego spersonalizowanego stylu.
minUtteranceCount	integer (int32)	Minimalna liczba wypowiedzi wymagana do wytrenowania modelu głosu według tego przepisu.
modelLocales	string[]	Miejsce, w którym model głosu może mówić, jest 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>	Wstępnie ustawione style obsługiwane przez ten przepis dla każdego miejsca. Można uzyskać te style bez żadnego zestawu treningowego.
version	string	Wersja z przepisem

Status

Wyliczenie

Status zasobu.

Wartość	Opis
NotStarted	Nierozpoczęty
Running	Bieganie
Succeeded	Powodzenie
Failed	Niepowodzenie
Disabling	Wyłączanie
Disabled	Wyłączony