Endpoints - Create
Cria um novo ponto final.
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 finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, 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 |
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. |
Operation-Id |
string |
ID do monitor de estado da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e o pedido não for idêntico ao pedido anterior, falhará com um Pedido Incorreto 400. Padrão Regex: |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
modelId | True |
string |
ID do recurso |
projectId | True |
string |
ID do recurso |
description |
string |
Descrição do ponto final |
|
displayName |
string |
Nome do ponto final |
|
id |
string |
ID do Ponto Final |
|
properties |
Propriedades do ponto final |
||
status |
Estado de um recurso. |
Respostas
Name | Tipo | Description |
---|---|---|
201 Created |
Criado Cabeçalhos
|
|
Other Status Codes |
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 an endpoint
Pedido de amostra
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
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 final |
Endpoint |
Tipo de ponto final |
Endpoint |
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. 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. |
Error |
Código de erro de nível superior |
Error |
A resposta a erros 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. |
Inner |
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. Isto contém o código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isto pode ser aninhado). |
Status |
Estado de um recurso. |
Endpoint
Objeto de ponto final
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 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
description |
string |
Descrição do ponto final |
displayName |
string |
Nome do ponto final |
id |
string |
ID do Ponto Final |
lastActionDateTime |
string |
O carimbo de data/hora quando o estado atual foi introduzido. 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). |
modelId |
string |
ID do recurso |
projectId |
string |
ID do recurso |
properties |
Propriedades do ponto final |
|
status |
Estado de um recurso. |
EndpointKind
Tipo de ponto final
Name | Tipo | Description |
---|---|---|
FastResume |
string |
|
HighPerformance |
string |
EndpointProperties
Propriedades do ponto final
Name | Tipo | Description |
---|---|---|
kind |
Tipo de 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. 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 |
Código de erro de nível superior |
|
details |
Error[] |
Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas. |
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. Isto contém o código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isto 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
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 a erros 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 |
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. Isto contém o código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isto pode ser aninhado).
Name | Tipo | Description |
---|---|---|
code |
string |
Código de erro detalhado para ajudar no diagnóstico. |
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. Isto contém o código de erro de propriedades necessárias, mensagem e destino de propriedades opcionais, erro interno (isto 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. |
Status
Estado de um recurso.
Name | Tipo | Description |
---|---|---|
Disabled |
string |
|
Disabling |
string |
|
Failed |
string |
|
NotStarted |
string |
|
Running |
string |
|
Succeeded |
string |