Endpoints - Create

Служба:

Azure AI Services

Версия API:

2024-02-01-preview

Создает новую конечную точку.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Идентификатор ресурса, который должен быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Укажите здесь ключ ресурса службы "Речь".
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор монитора состояния для операции. Если заголовок Operation-Id соответствует существующей операции, и запрос не идентичен предыдущему запросу, он завершится ошибкой с 400 недопустимым запросом.

Текст запроса

Имя	Обязательно	Тип	Описание
modelId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
description		string	Описание конечной точки
displayName		string minLength: 1	Имя конечной точки
id		string (uuid)	Идентификатор конечной точки
properties		EndpointProperties	Свойства конечной точки
status		Status	Состояние ресурса.

Ответы

Имя	Тип	Описание
201 Created	Endpoint	Созданный Заголовки Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Произошла ошибка. Заголовки x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Укажите здесь ключ ресурса службы "Речь".

Тип: apiKey
В: header

Примеры

Create an endpoint

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
Endpoint	Объект Endpoint
EndpointKind	Тип конечной точки
EndpointProperties	Свойства конечной точки
Error	Ошибка верхнего уровня следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более описательными сведениями.
ErrorCode	Код ошибки верхнего уровня
ErrorResponse	Ответ на ошибку следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
Status	Состояние ресурса.

Endpoint

Object

Объект Endpoint

Имя	Тип	Описание
createdDateTime	string (date-time)	Метка времени создания объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Описание конечной точки
displayName	string minLength: 1	Имя конечной точки
id	string (uuid)	Идентификатор конечной точки
lastActionDateTime	string (date-time)	Метка времени ввода текущего состояния. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. 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]$	Идентификатор ресурса
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
properties	EndpointProperties	Свойства конечной точки
status	Status	Состояние ресурса.

EndpointKind

Перечисление

Тип конечной точки

Значение	Описание
FastResume
HighPerformance

EndpointProperties

Object

Свойства конечной точки

Имя	Тип	Описание
kind	EndpointKind	Тип конечной точки

Error

Object

Ошибка верхнего уровня следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более описательными сведениями.

Имя	Тип	Описание
code	ErrorCode	Код ошибки верхнего уровня
details	Error[]	Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
message	string	Сообщение об ошибке верхнего уровня.
target	string	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

ErrorCode

Перечисление

Код ошибки верхнего уровня

Значение	Описание
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

Ответ на ошибку следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Имя	Тип	Описание
error	Error	Ошибка верхнего уровня следует рекомендациям по REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит ошибку верхнего уровня с кодом ошибки, сообщением, сведениями, целевым объектом и внутренней ошибкой с более описательными сведениями.

InnerError

Object

Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).

Имя	Тип	Описание
code	string	Подробный код ошибки для диагностики.
innererror	InnerError	Внутренняя ошибка соответствует рекомендациям ПО REST API Microsoft Azure, которые доступны в https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Это содержит код ошибки обязательных свойств, сообщение и необязательные свойства, внутреннюю ошибку (это можно вложить).
message	string	Подробное сообщение об ошибке.
target	string	Источник ошибки. Например, это будет "модель" или "идентификатор модели" в случае недопустимой модели.

Status

Перечисление

Состояние ресурса.

Значение	Описание
Disabled
Disabling
Failed
NotStarted
Running
Succeeded