Models - Get

Referência

Service:: Cognitive Services - Custom Voice

API Version:: 2023-12-01-preview

Obtém o modelo identificado pelo ID especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	O ID do recurso. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	A versão da API a utilizar para esta operação.

endpoint

path

True

string

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://eastus.api.cognitive.microsoft.com).

path

True

string

O ID do recurso.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a sua chave de recurso de Voz aqui.

Respostas

Name	Tipo	Description
200 OK	Model	Com êxito
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a sua chave de recurso de Voz aqui.

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isto contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.
ErrorCode	Código de erro de nível superior
ErrorResponse	A resposta ao erro segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).
Model	Objeto de modelo
ModelFailureReason	Motivo da falha de preparação do modelo
ModelProperties	Propriedades do modelo
PresetStyleItem	Estilos predefinidos suportados pela receita. O modelo de voz pode suportar estes estilos sem qualquer conjunto de preparação de estilos.
Recipe	Receita para a criação de modelos. Diferentes receitas têm uma capacidade diferente.
Status	Estado de um recurso.

Error

O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isto contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

Name	Tipo	Description
code	ErrorCode	Código de erro de nível superior
details	Error[]	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innererror	InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).
message	string	Mensagem de erro de nível superior.
target	string	A origem do erro. Por exemplo, seria "modelo" ou "ID de modelo" em caso de modelo inválido.

ErrorCode

Código de erro de nível superior

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

ErrorResponse

A resposta ao erro segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Tipo	Description
error	Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isto contém um erro de nível superior com código de erro, mensagem, detalhes, destino e um erro interno com detalhes mais descritivos.

InnerError

O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).

Name	Tipo	Description
code	string	Código de erro detalhado para ajudar no diagnóstico.
innererror	InnerError	O erro interno segue as Diretrizes da API REST do Microsoft Azure que estão disponíveis em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contém o código de erro das propriedades necessárias, a mensagem e o destino das propriedades opcionais, o erro interno (isto pode ser aninhado).
message	string	Mensagem de erro detalhada.
target	string	A origem do erro. Por exemplo, seria "modelo" ou "ID de modelo" em caso de modelo inválido.

Model

Objeto de modelo

Name	Tipo	Description
consentId	string	ID do recurso
createdDateTime	string	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Descrição do modelo
engineVersion	string	Versão do motor. Atualizar esta versão pode obter a correção de erros de pronúncia mais recente.
id	string	ID do recurso
lastActionDateTime	string	O carimbo de data/hora em que o estado atual foi introduzido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A região deste modelo. O código de região segue BCP-47. Pode encontrar a lista de região de conversão de texto em voz aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	ID do recurso
properties	ModelProperties	Propriedades do modelo
recipe	Recipe	Receita para a criação de modelos. Diferentes receitas têm uma capacidade diferente.
status	Status	Estado de um recurso.
trainingSetId	string	ID do recurso
voiceName	string	Nome da voz

ModelFailureReason

Motivo da falha de preparação do modelo

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

ModelProperties

Propriedades do modelo

Name	Tipo	Description
failureReason	ModelFailureReason	Motivo da falha de preparação do modelo
presetStyles	string[]	Estilos predefinidos deste modelo.
styleTrainingSetIds	object	Estilos personalizados e conjuntos de preparação associados.
voiceStyles	string[]	Todos os estilos suportados por este modelo.

PresetStyleItem

Estilos predefinidos suportados pela receita. O modelo de voz pode suportar estes estilos sem qualquer conjunto de preparação de estilos.

Name	Tipo	Description
female	string[]	Estilos predefinidos suportados no modelo de voz feminina.
male	string[]	Estilos predefinidos suportados no modelo de voz masculina.

Recipe

Receita para a criação de modelos. Diferentes receitas têm uma capacidade diferente.

Name	Tipo	Description
datasetLocales	string[]	A região do conjunto de dados de preparação. O código de região segue BCP-47. Pode encontrar a lista de região de conversão de texto em voz aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
description	string	Descrição da receita
kind	string	Tipo de receita
maxCustomStyleNum	integer	Número máximo de estilo personalizado suportado num modelo de voz.
minStyleUtteranceCount	integer	Contagem mínima de expressões necessária para preparar cada estilo personalizado.
minUtteranceCount	integer	Contagem mínima de expressões necessária para preparar um modelo de voz com esta receita.
modelLocales	string[]	A região em que um modelo de voz pode falar com esta receita. O código de região segue BCP-47. Pode encontrar a lista de região de conversão de texto em voz aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Estilos predefinidos suportados por esta receita por região. Pode obter estes estilos sem qualquer conjunto de preparação de estilos.
version	string	Versão da receita

Status

Estado de um recurso.

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

Models - Get

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Get a model

Sample Request

Sample Response

Definições

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status

Recursos adicionais