Models - Get

Serviço:

Azure AI Services

Versão da API:

2024-02-01-preview

Obtém o modelo identificado pela ID fornecida.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	A ID do recurso. Padrão Regex: ^[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 ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça sua chave de recurso de Fala aqui.

Respostas

Nome	Tipo	Description
200 OK	Model	Êxito
Other Status Codes	ErrorResponse	Ocorreu um erro. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Forneça sua chave de recurso de Fala aqui.

Tipo: apiKey
Em: header

Exemplos

Get a model

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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

Nome	Description
Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que está disponível em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isso 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 de 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. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).
Model	Objeto de modelo
ModelFailureReason	Motivo da falha de treinamento do modelo
ModelProperties	Propriedades do modelo
PresetStyleItem	Estilos predefinidos compatíveis com a receita. O modelo de voz pode dar suporte a esses estilos sem nenhum conjunto de treinamento de estilo.
Recipe	Receita para a criação de modelos. Receitas diferentes têm capacidade diferente.
Status	Status de um recurso.

Error

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

Nome	Tipo	Description
code	ErrorCode	Código de erro de nível superior
details	Error[]	Detalhes adicionais de suporte 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. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).
message	string	Mensagem de erro de nível superior.
target	string	A origem do erro. Por exemplo, seria "model" ou "id de modelo" em caso de modelo inválido.

ErrorCode

Código de erro de nível superior

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

ErrorResponse

A resposta de 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.

Nome	Tipo	Description
error	Error	O erro de nível superior segue as Diretrizes da API REST do Microsoft Azure que está disponível em https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Isso 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. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).

Nome	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. Isso contém código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isso pode ser aninhado).
message	string	Mensagem de erro detalhada.
target	string	A origem do erro. Por exemplo, seria "model" ou "id de modelo" em caso de modelo inválido.

Model

Objeto de modelo

Nome	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 ("YYYY-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 mecanismo. Atualizar esta versão pode obter a correção de bugs de pronúncia mais recente.
id	string	ID do recurso
lastActionDateTime	string	O carimbo de data/hora em que o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A localidade desse modelo. O código de localidade segue BCP-47. Você pode encontrar a lista de localidades de texto em fala 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. Receitas diferentes têm capacidade diferente.
status	Status	Status de um recurso.
trainingSetId	string	ID do recurso
voiceName	string	Nome da voz

ModelFailureReason

Motivo da falha de treinamento do modelo

Nome	Tipo	Description
InaccessibleCustomerStorage	string	O cliente usa o Bring Your Own Storage na Conta de Fala. Mas o armazenamento não está acessível agora. Verifique o documento.
Internal	string	Erro do Serviço de Voz Personalizado.
SpeakerVerificationFailed	string	O consentimento e o áudio de treinamento não são do mesmo alto-falante.
TerminateByUser	string	O cliente cancelou o treinamento do modelo.

ModelProperties

Propriedades do modelo

Nome	Tipo	Description
failureReason	ModelFailureReason	Motivo da falha de treinamento do modelo
presetStyles	string[]	Estilos predefinidos desse modelo.
styleTrainingSetIds	object	Estilos personalizados e conjuntos de treinamento associados.
voiceStyles	string[]	Todos os estilos compatíveis com esse modelo.

PresetStyleItem

Estilos predefinidos compatíveis com a receita. O modelo de voz pode dar suporte a esses estilos sem nenhum conjunto de treinamento de estilo.

Nome	Tipo	Description
female	string[]	Estilos predefinidos com suporte no modelo de voz feminina.
male	string[]	Estilos predefinidos com suporte no modelo de voz masculina.

Recipe

Receita para a criação de modelos. Receitas diferentes têm capacidade diferente.

Nome	Tipo	Description
datasetLocales	string[]	A localidade do conjunto de dados de treinamento. O código de localidade segue BCP-47. Você pode encontrar a lista de localidades de texto em fala 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 com suporte em um modelo de voz.
minStyleUtteranceCount	integer	Contagem mínima de enunciados necessária para treinar cada estilo personalizado.
minUtteranceCount	integer	Contagem mínima de enunciados necessária para treinar um modelo de voz com esta receita.
modelLocales	string[]	A localidade que um modelo de voz pode falar com essa receita. O código de localidade segue BCP-47. Você pode encontrar a lista de localidades de texto em fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string,  PresetStyleItem>	Estilos predefinidos compatíveis com essa receita por localidade. Você pode obter esses estilos sem nenhum conjunto de treinamento de estilo.
version	string	Versão da receita

Status

Status de um recurso.

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