Endpoints - Create

Serviço:

Azure AI Services

Versão da API:

2024-02-01-preview

Cria um novo ponto de extremidade.

PUT {endpoint}/customvoice/endpoints/{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 (uuid)	O ID do recurso, que deve ser UUID.
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
modelId	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
description		string	Descrição do ponto final
displayName		string minLength: 1	Nome do ponto final
id		string (uuid)	ID do ponto de extremidade
properties		EndpointProperties	Propriedades do ponto final
status		Status	Status de um recurso.

Respostas

Name	Tipo	Description
201 Created	Endpoint	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 an endpoint

Pedido de amostra

HTTP

PUT {
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb?api-version=2024-02-01-preview



{
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}

Resposta da amostra

Código de estado:

201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/2595b58d-40d6-4032-a618-482dcce1c130?api-version=2024-02-01-preview
Operation-Id: 2595b58d-40d6-4032-a618-482dcce1c130

{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definições

Name	Description
Endpoint	Objeto de ponto de extremidade
EndpointKind	Tipo de ponto final
EndpointProperties	Propriedades do ponto final
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).
Status	Status de um recurso.

Endpoint

Object

Objeto de ponto de extremidade

Name	Tipo	Description
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 ponto final
displayName	string minLength: 1	Nome do ponto final
id	string (uuid)	ID do ponto de extremidade
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).
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
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	EndpointProperties	Propriedades do ponto final
status	Status	Status de um recurso.

EndpointKind

Enumeração

Tipo de ponto final

Valor	Description
HighPerformance
FastResume

EndpointProperties

Object

Propriedades do ponto final

Name	Tipo	Description
kind	EndpointKind	Tipo de ponto final

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.

Status

Enumeração

Status de um recurso.

Valor	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled