Models - List

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-02-01-preview

Obtém a lista de modelos para o recurso de serviço de Fala autenticado.

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

Com parâmetros opcionais:

GET {endpoint}/customvoice/models?skip={skip}&maxpagesize={maxpagesize}&filter={filter}&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).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
filter	query		string	Condição de filtro. propriedades com suporte: projectId, createdDateTime, localidade, tipo Operadores : eq, ne têm suporte para todas as propriedades. gt, ge, lt, le são compatíveis com createdDateTime. exemplo: `filter=projectId eq 'Jessica'` (filtrar por ID do projeto) `filter=kind eq 'ProfessionalVoice'` (filtrar projeto por tipo) `filter=locale eq 'en-US'` (conjunto de treinamento de filtro e modelo por localidade) `filter=createdDateTime gt 2022-12-30T23:59:59.99Z` (tempo de criação do recurso de filtro após 2023-11-01)
maxpagesize	query		integer (int32)	O número máximo de itens a serem incluídos em uma única resposta.
skip	query		integer (int32)	O número de itens de resultado a serem ignoradas.

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	PaginatedModels	Êxito
Other Status Codes	ErrorResponse	Ocorreu um erro. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

PaginatedModels

Ê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 all models

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "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"
    },
    {
      "id": "JessicaMultiStyle",
      "voiceName": "JessicaMultiStyleNeural",
      "description": "Jessica multi style voice",
      "recipe": {
        "kind": "MultiStyle",
        "version": "V3.2023.06"
      },
      "projectId": "Jessica",
      "consentId": "Jessica",
      "trainingSetId": "Jessica-300",
      "locale": "en-US",
      "engineVersion": "2023.07.04.0",
      "properties": {
        "presetStyles": [
          "cheerful",
          "sad"
        ],
        "styleTrainingSetIds": {
          "happy": "JessicaHappy-300",
          "myStyle2": "JessicaStyle2"
        },
        "voiceStyles": [
          "cheerful",
          "sad",
          "happy",
          "myStyle2"
        ]
      },
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/customvoice/models?skip=2&maxpagesize=2&api-version=2024-02-01-preview"
}

Definições

Nome	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. 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 model
ModelFailureReason	Motivo da falha no treinamento do modelo
ModelProperties	Propriedades do modelo
PaginatedModels	Lista de modelos paginados
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

Objeto

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. 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 "model id" em caso de modelo inválido.

ErrorCode

Enumeração

Código de erro de nível superior

Valor	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objeto

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ão disponíveis 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

Objeto

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 "model id" em caso de modelo inválido.

Model

Objeto

Objeto model

Nome	Tipo	Description
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
createdDateTime	string (date-time)	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYYY-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 essa versão pode obter a última correção de bugs de pronúncia.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYYY-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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
voiceName	string minLength: 1	Nome da voz

ModelFailureReason

Enumeração

Motivo da falha no treinamento do modelo

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

ModelProperties

Objeto

Propriedades do modelo

Nome	Tipo	Description
failureReason	ModelFailureReason	Motivo da falha no 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.

PaginatedModels

Objeto

Lista de modelos paginados

Nome	Tipo	Description
nextLink	string (uri)	Link para a próxima página.
value	Model[]	Lista de modelos

PresetStyleItem

Objeto

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 compatíveis com o modelo de voz feminina.
male	string[]	Estilos predefinidos compatíveis com o modelo de voz masculina.

Recipe

Objeto

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 (int32)	Número máximo de estilo personalizado com suporte em um modelo de voz.
minStyleUtteranceCount	integer (int32)	Contagem mínima de enunciados necessária para treinar cada estilo personalizado.
minUtteranceCount	integer (int32)	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

Enumeração

Status de um recurso.

Valor	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Compartilhar via

Models - List

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Get all models

Solicitação de exemplo

Resposta de exemplo

Definições

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PaginatedModels

PresetStyleItem

Recipe

Status