Models - Get

Service:: Azure AI Services

API-versie:: 2026-01-01

Hiermee haalt u het model op dat wordt geïdentificeerd door de opgegeven id.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: 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]$	Resource-id
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	Model	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

Model

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Get a model

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Model	Modelobject
ModelFailureReason	Reden voor modeltrainingsfalen
ModelProperties	Modeleigenschappen
PresetStyleItem	Vooraf ingestelde stijlen die door het recept worden ondersteund. Het stemmodel kan deze stijlen ondersteunen zonder enige stijltraining.
Recipe	Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
Status	Status van een hulpbron.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

Model

Object

Modelobject

Name	Type	Description
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
createdDateTime	string (date-time)	De tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modelbeschrijving
engineVersion	string	Engineversie. Deze versie kan de nieuwste uitspraakfouten fixen.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
lastActionDateTime	string (date-time)	De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	De locatie van dit model. De locatiecode volgt BCP-47. Je kunt hier de tekst-naar-spraak locatielijst https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsvinden.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
properties	ModelProperties	Modeleigenschappen
recipe	Recipe	Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.
status	Status	Status van een hulpbron.
trainingSetId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
voiceName	string minLength: 1	Spraaknaam

ModelFailureReason

Opsomming

Reden voor modeltrainingsfalen

Waarde	Description
InaccessibleCustomerStorage	De klant gebruikt het Bring Your Own Storage in Speech-account. Maar de opslag is nu niet toegankelijk. Controleer alsjeblieft het document.
SpeakerVerificationFailed	De toestemming en de trainingsaudio komen niet van dezelfde luidspreker.
TerminateByUser	De klant annuleerde de modeltraining.
Internal	Fout bij aangepaste spraakservice.
DataNotReady	Trainingsdata zijn nog niet klaar voor modeltraining.
DataNotEnough	Trainingsdata is niet voldoende voor modeltraining.

ModelProperties

Object

Modeleigenschappen

Name	Type	Description
failedTrainingsets	string[]	ID's van mislukte trainingssets.
failureReason	ModelFailureReason	Reden voor modeltrainingsfalen
presetStyles	string[]	Vooraf ingestelde stijlen van dit model.
secondaryLocales	string[]	Secundaire locaties waar dit model kan spreken. De locatiecode volgt BCP-47.
styleTrainingSetIds	object	Aangepaste stijlen en bijbehorende trainingssets.
voiceStyles	string[]	Alle stijlen worden door dit model ondersteund.

PresetStyleItem

Object

Vooraf ingestelde stijlen die door het recept worden ondersteund. Het stemmodel kan deze stijlen ondersteunen zonder enige stijltraining.

Name	Type	Description
female	string[]	Preset-stijlen worden ondersteund op vrouwelijke stemmodel.
male	string[]	Preset-stijlen worden ondersteund op het mannelijke stemmodel.

Recipe

Object

Recept voor modelbouw. Verschillende recepten hebben verschillende mogelijkheden.

Name	Type	Description
datasetLocales	string[]	De locatie van de trainingsdataset. De locatiecode volgt BCP-47. Je kunt hier de tekst-naar-spraak locatielijst https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsvinden.
description	string	Receptbeschrijving
kind	string	Recepttype
maxCustomStyleNum	integer (int32)	Maximaal gepersonaliseerd stijlnummer dat in één stemmodel wordt ondersteund.
minDurationInSeconds	number (double)	Minimale audioduur in seconden nodig om een stemmodel met dit recept te trainen.
minStyleUtteranceCount	integer (int32)	Minimaal aantal uitingen vereist om elke aangepaste stijl te trainen.
minUtteranceCount	integer (int32)	Minimaal aantal uitingen vereist om een stemmodel met dit recept te trainen.
modelLocales	string[]	De plek waar een stemmodel met dit recept kan communiceren. De locatiecode volgt BCP-47. Je kunt hier de tekst-naar-spraak locatielijst https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsvinden.
presetStyles	<string, PresetStyleItem>	Preset-stijlen die door dit recept per locatie worden ondersteund. Je kunt deze stijlen krijgen zonder enige stijltraining.
version	string	Receptversie

Status

Opsomming

Status van een hulpbron.

Waarde	Description
NotStarted	Niet gestart
Running	Hardlopen
Succeeded	Geslaagd
Failed	Mislukt
Disabling	Uitschakelen
Disabled	Disabled