Models - Get

Referens

Tjänst:: Cognitive Services - Custom Voice

API-version:: 2023-12-01-preview

Hämtar modellen som identifieras av det angivna ID:t.

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

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	Resursens ID. Reguljärt uttrycksmönster: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

endpoint

path

True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).

path

True

string

Resursens ID.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Ange din Speech-resursnyckel här.

Svar

Name	Typ	Description
200 OK	Model	Klart
Other Status Codes	ErrorResponse	Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

Exempel

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

Definitioner

Name	Description
Error	Toppnivåfel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.
ErrorCode	Felkod på den översta nivån
ErrorResponse	Felsvaret följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
Model	Modellobjekt
ModelFailureReason	Orsak till modellträningsfel
ModelProperties	Modellegenskaper
PresetStyleItem	Förinställda format som stöds av receptet. Röstmodellen har stöd för dessa format utan någon formatträningsuppsättning.
Recipe	Recept för modellbyggnad. Olika recept har olika funktioner.
Status	Status för en resurs.

Error

Toppnivåfel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

Name	Typ	Description
code	ErrorCode	Felkod på den översta nivån
details	Error[]	Ytterligare stödjande information om fel- och/eller förväntade principer.
innererror	InnerError	Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Felmeddelande på den översta nivån.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" om modellen är ogiltig.

ErrorCode

Felkod på den översta nivån

Name	Typ	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Felsvaret följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Description
error	Error	Toppnivåfel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

InnerError

Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Name	Typ	Description
code	string	Detaljerad felkod för att hjälpa till med diagnostiken.
innererror	InnerError	Inre fel följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller felkod för obligatoriska egenskaper, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Detaljerat felmeddelande.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" om modellen är ogiltig.

Model

Modellobjekt

Name	Typ	Description
consentId	string	Resurs-ID
createdDateTime	string	Tidsstämpeln när objektet skapades. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Modellbeskrivning
engineVersion	string	Motorversion. Uppdatera den här versionen kan få den senaste uttalsfelkorrigeringen.
id	string	Resurs-ID
lastActionDateTime	string	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Den här modellens nationella inställningar. Språkkod följer BCP-47. Du hittar listan med språkvarianter för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Resurs-ID
properties	ModelProperties	Modellegenskaper
recipe	Recipe	Recept för modellbyggnad. Olika recept har olika funktioner.
status	Status	Status för en resurs.
trainingSetId	string	Resurs-ID
voiceName	string	Röstnamn

ModelFailureReason

Orsak till modellträningsfel

Name	Typ	Description
InaccessibleCustomerStorage	string
Internal	string
None	string
SpeakerVerificationFailed	string
TerminateByUser	string

ModelProperties

Modellegenskaper

Name	Typ	Description
failureReason	ModelFailureReason	Orsak till modellträningsfel
presetStyles	string[]	Förinställda format för den här modellen.
styleTrainingSetIds	object	Anpassade format och tillhörande träningsuppsättningar.
voiceStyles	string[]	Alla format som stöds av den här modellen.

PresetStyleItem

Förinställda format som stöds av receptet. Röstmodellen har stöd för dessa format utan någon formatträningsuppsättning.

Name	Typ	Description
female	string[]	Förinställda format stöds i kvinnliga röstmodeller.
male	string[]	Förinställda format stöds på manliga röstmodeller.

Recipe

Recept för modellbyggnad. Olika recept har olika funktioner.

Name	Typ	Description
datasetLocales	string[]	Språkvarianten för träningsdatauppsättningen. Språkkod följer BCP-47. Du hittar listan med språkvarianter för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Beskrivning av recept
kind	string	Recepttyp
maxCustomStyleNum	integer	Maximalt anpassat formatnummer som stöds i en röstmodell.
minStyleUtteranceCount	integer	Minsta antal yttranden som krävs för att träna varje anpassat format.
minUtteranceCount	integer	Minsta antal yttranden som krävs för att träna en röstmodell med det här receptet.
modelLocales	string[]	Det språk som en röstmodell kan tala med det här receptet. Språkkod följer BCP-47. Du hittar listan med språkvarianter för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Förinställda format som stöds av det här receptet per språk. Du kan hämta dessa format utan någon formatträningsuppsättning.
version	string	Receptversion

Status

Status för en resurs.

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

Dela via

Models - Get

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Get a model

Sample request

Sample response

Definitioner

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Ytterligare resurser