Models - Create

Serviço:: Azure AI Services

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

Cria um novo modelo de voz.

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

Parâmetros do URI

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça sua chave de recurso de fala aqui.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do monitor de status da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e a solicitação não for idêntica à solicitação anterior, ela falhará com uma solicitação incorreta de 400.

Corpo do Pedido

Name	Necessário	Tipo	Description
consentId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
recipe	True	Recipe	Receita para construção de modelos. Receitas diferentes têm capacidades diferentes.
trainingSetId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
description		string	Descrição do modelo
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
locale		string	A localidade deste modelo. O código de localidade segue o BCP-47. Você pode encontrar a lista de localidades de texto para fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
properties		ModelProperties	Propriedades do modelo
status		Status	Status de um recurso.
voiceName		string minLength: 1	Nome da voz

Respostas

Name	Tipo	Description
201 Created	Model	Criado Cabeçalhos Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

201 Created

Model

Criado

Cabeçalhos

Operation-Id: string
Operation-Location: string

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

Create a model

Create a multi style model

Create a model

Pedido de amostra

HTTP

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



{
  "voiceName": "JessicaNeural",
  "description": "Jessica voice",
  "recipe": {
    "kind": "Default"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300"
}

Resposta da amostra

Código de estado:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/1f4352df-f247-40c0-a7b1-a54d017933e1?api-version=2024-02-01-preview
Operation-Id: 1f4352df-f247-40c0-a7b1-a54d017933e1

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

Create a multi style model

Pedido de amostra

HTTP

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



{
  "voiceName": "JessicaMultiStyleNeural",
  "description": "Jessica multi style voice",
  "recipe": {
    "kind": "MultiStyle"
  },
  "projectId": "Jessica",
  "consentId": "Jessica",
  "trainingSetId": "Jessica-300",
  "locale": "en-US",
  "properties": {
    "presetStyles": [
      "cheerful",
      "sad"
    ],
    "styleTrainingSetIds": {
      "happy": "JessicaHappy-300",
      "myStyle2": "JessicaStyle2"
    }
  }
}

Resposta da amostra

Código de estado:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/a01a127a-c204-4e46-a8c1-fab01559b05b?api-version=2024-02-01-preview
Operation-Id: a01a127a-c204-4e46-a8c1-fab01559b05b

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

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. Este 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 no treinamento do modelo
ModelProperties	Propriedades do modelo
PresetStyleItem	Estilos predefinidos suportados pela receita. O modelo de voz pode suportar esses estilos sem qualquer conjunto de treinamento de estilo.
Recipe	Receita para construção de modelos. Receitas diferentes têm capacidades diferentes.
Status	Status de um recurso.

Error

Object

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. Este 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 adicionais de suporte sobre o erro e/ou 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 "modelo" ou "id do modelo" no caso de modelo inválido.

ErrorCode

Enumeração

Código de erro de nível superior

Valor	Description
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

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.

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. Este 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

Object

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).

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. 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 "modelo" ou "id do modelo" no caso de modelo inválido.

Model

Object

Objeto de modelo

Name	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 ("AAAA-MM-DDThh:mm:ssZ", ver 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 mais recente 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 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	A localidade deste modelo. O código de localidade segue o BCP-47. Você pode encontrar a lista de localidades de texto para 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 construção de modelos. Receitas diferentes têm capacidades diferentes.
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 Bring Your Own Storage in Speech Account. Mas o armazenamento não está acessível agora. Por favor, verifique doc.
SpeakerVerificationFailed	O consentimento e o áudio de treinamento não são do mesmo alto-falante.
TerminateByUser	O cliente cancelou o treinamento do modelo.
Internal	Erro do Serviço de Voz Personalizado.

ModelProperties

Object

Propriedades do modelo

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

PresetStyleItem

Object

Estilos predefinidos suportados pela receita. O modelo de voz pode suportar esses estilos sem qualquer conjunto de treinamento de estilo.

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

Recipe

Object

Receita para construção de modelos. Receitas diferentes têm capacidades diferentes.

Name	Tipo	Description
datasetLocales	string[]	A localidade do conjunto de dados de treinamento. O código de localidade segue o BCP-47. Você pode encontrar a lista de localidades de texto para 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 suportado 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 esta receita. O código de localidade segue o BCP-47. Você pode encontrar a lista de localidades de texto para fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
presetStyles	<string, PresetStyleItem>	Estilos predefinidos suportados por esta receita por localidade. Você pode obter esses estilos sem qualquer conjunto de treinamento de estilo.
version	string	Versão da receita

Status

Enumeração

Status de um recurso.

Valor	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

Partilhar via

Models - Create

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Create a model

Pedido de amostra

Resposta da amostra

Create a multi style model

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorCode

ErrorResponse

InnerError

Model

ModelFailureReason

ModelProperties

PresetStyleItem

Recipe

Status