Models - Get

Servizio:

Azure AI Services

Versione API:

2024-02-01-preview

Ottiene il modello identificato dall'ID specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	ID della risorsa. Criterio di espressione regolare: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Specificare qui la chiave della risorsa Voce.

Risposte

Nome	Tipo	Descrizione
200 OK	Model	Operazione riuscita
Other Status Codes	ErrorResponse	Si è verificato un errore. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave della risorsa Voce.

Tipo: apiKey
In: header

Esempio

Get a model

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
Error	L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.
ErrorCode	Codice di errore di primo livello
ErrorResponse	Risposta agli errori segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
Model	Oggetto Model
ModelFailureReason	Motivo dell'errore di training del modello
ModelProperties	Proprietà dei modelli
PresetStyleItem	Stili predefiniti supportati dalla ricetta. Il modello vocale può supportare questi stili senza alcun set di training di stile.
Recipe	Ricetta per la costruzione di modelli. Le diverse ricette hanno capacità diverse.
Status	Stato di una risorsa.

Error

L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

Nome	Tipo	Descrizione
code	ErrorCode	Codice di errore di primo livello
details	Error[]	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innererror	InnerError	L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
message	string	Messaggio di errore di primo livello.
target	string	Indica l'origine dell'errore. Ad esempio, sarebbe "modello" o "id modello" nel caso di modello non valido.

ErrorCode

Codice di errore di primo livello

Nome	Tipo	Descrizione
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Risposta agli errori segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Descrizione
error	Error	L'errore di primo livello segue le linee guida per le API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

InnerError

L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).

Nome	Tipo	Descrizione
code	string	Codice di errore dettagliato per facilitare la diagnostica.
innererror	InnerError	L'errore interno segue le linee guida per l'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà richieste, il messaggio e la destinazione delle proprietà facoltative, l'errore interno(può essere annidato).
message	string	Messaggio di errore dettagliato.
target	string	Indica l'origine dell'errore. Ad esempio, sarebbe "modello" o "id modello" nel caso di modello non valido.

Model

Oggetto Model

Nome	Tipo	Descrizione
consentId	string	ID risorsa
createdDateTime	string	Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Descrizione modello
engineVersion	string	Versione del motore. Aggiornare questa versione può ottenere la correzione più recente del bug di pronuncia.
id	string	ID risorsa
lastActionDateTime	string	Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Impostazioni locali di questo modello. Il codice delle impostazioni locali segue BCP-47. È possibile trovare l'elenco delle impostazioni locali per la voce qui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	ID risorsa
properties	ModelProperties	Proprietà dei modelli
recipe	Recipe	Ricetta per la costruzione di modelli. Le diverse ricette hanno capacità diverse.
status	Status	Stato di una risorsa.
trainingSetId	string	ID risorsa
voiceName	string	Nome della voce

ModelFailureReason

Motivo dell'errore di training del modello

Nome	Tipo	Descrizione
InaccessibleCustomerStorage	string	Il cliente usa Bring Your Own Storage in Speech Account. Ma l'archiviazione non è accessibile ora. Controllare la documentazione.
Internal	string	Errore del servizio vocale personalizzato.
SpeakerVerificationFailed	string	Il consenso e l'audio di training non provengono dallo stesso altoparlante.
TerminateByUser	string	Il cliente ha annullato il training del modello.

ModelProperties

Proprietà dei modelli

Nome	Tipo	Descrizione
failureReason	ModelFailureReason	Motivo dell'errore di training del modello
presetStyles	string[]	Stili predefiniti di questo modello.
styleTrainingSetIds	object	Stili personalizzati e set di training associati.
voiceStyles	string[]	Tutti gli stili supportati da questo modello.

PresetStyleItem

Stili predefiniti supportati dalla ricetta. Il modello vocale può supportare questi stili senza alcun set di training di stile.

Nome	Tipo	Descrizione
female	string[]	Stili predefiniti supportati nel modello vocale femminile.
male	string[]	Stili predefiniti supportati nel modello voce maschile.

Recipe

Ricetta per la costruzione di modelli. Le diverse ricette hanno capacità diverse.

Nome	Tipo	Descrizione
datasetLocales	string[]	Impostazioni locali del set di dati di training. Il codice delle impostazioni locali segue BCP-47. È possibile trovare l'elenco delle impostazioni locali per la voce qui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Descrizione della ricetta
kind	string	Tipo di ricetta
maxCustomStyleNum	integer	Numero di stile personalizzato massimo supportato in un modello vocale.
minStyleUtteranceCount	integer	Numero minimo di espressioni necessarie per eseguire il training di ogni stile personalizzato.
minUtteranceCount	integer	Numero minimo di espressioni necessarie per eseguire il training di un modello vocale con questa ricetta.
modelLocales	string[]	Le impostazioni locali che un modello vocale può parlare con questa ricetta. Il codice delle impostazioni locali segue BCP-47. È possibile trovare l'elenco delle impostazioni locali per la voce qui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string,  PresetStyleItem>	Stili predefiniti supportati da questa ricetta per impostazioni locali. È possibile ottenere questi stili senza alcun set di training di stile.
version	string	Versione della ricetta

Status

Stato di una risorsa.

Nome	Tipo	Descrizione
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string