Projects - Create

Serviço:

Azure AI Services

Versão da API:

2024-02-01-preview

Cria um novo projeto.

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

Parâmetros do URI

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

Corpo do Pedido

Name	Necessário	Tipo	Description
kind	True	ProjectKind	Tipo de projeto
description		string	Descrição do projeto
displayName		string	Nome do projeto
id		string	ID do recurso

Respostas

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

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Exemplos

Create a project

Pedido de amostra

HTTP

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


{
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice"
}

Resposta da amostra

Código de estado:

201

{
  "id": "Jessica",
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice",
  "createdDateTime": "2023-04-01T05:30:00.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).
Project	Objeto de projeto. Os consentimentos, conjuntos de preparação, modelos e pontos finais estão organizados num projeto.
ProjectKind	Tipo de projeto

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.

Project

Objeto de projeto. Os consentimentos, conjuntos de preparação, modelos e pontos finais estão organizados num projeto.

Name	Tipo	Description
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 projeto
displayName	string	Nome do projeto
id	string	ID do recurso
kind	ProjectKind	Tipo de projeto

ProjectKind

Tipo de projeto

Name	Tipo	Description
PersonalVoice	string
ProfessionalVoice	string