Поделиться через


Endpoints - Create

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

POST {endpoint}/speechtotext/v3.2-preview.2/endpoints

Параметры URI

Имя В Обязательно Тип Описание
endpoint
path True

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://westus.api.cognitive.microsoft.com

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

Имя Обязательно Тип Описание
displayName True

string

Отображаемое имя объекта.

locale True

string

Языковой стандарт содержащихся данных.

customProperties

object

Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.

description

string

Описание объекта .

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointProperties

EndpointProperties

text

string

Текст, используемый для адаптации языковой модели для этой конечной точки.

Ответы

Имя Тип Описание
201 Created

Endpoint

Ответ содержит сведения о сущности в качестве полезных данных и ее расположении в качестве заголовка.

Заголовки

Location: string

Other Status Codes

Error

Произошла ошибка.

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

Ocp-Apim-Subscription-Key

Укажите ключ учетной записи Cognitive Services здесь.

Тип: apiKey
В: header

Authorization

Укажите маркер доступа из JWT, возвращенный службой маркеров безопасности этого региона. Обязательно добавьте область управления в маркер, добавив следующую строку запроса в URL-адрес службы маркеров безопасности: ?область=speechservicesmanagement

Тип: apiKey
В: header

Примеры

Create an endpoint

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

POST {
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "loggingEnabled": true
  },
  "locale": "en-US",
  "displayName": "Speech endpoint definition",
  "description": "This is a speech endpoint"
}/speechtotext/v3.2-preview.2/endpoints

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "loggingEnabled": true
  },
  "locale": "en-US",
  "displayName": "Speech endpoint definition",
  "description": "This is a speech endpoint"
}

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

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

Определения

Имя Описание
DetailedErrorCode

DetailedErrorCode

Endpoint

Конечная точка

EndpointLinks

EndpointLinks

EndpointProperties

EndpointProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Ошибка

ErrorCode

ErrorCode

InnerError

InnerError

Status

Состояние

DetailedErrorCode

DetailedErrorCode

Имя Тип Описание
DataImportFailed

string

Сбой импорта данных.

DeleteNotAllowed

string

Удаление запрещено.

DeployNotAllowed

string

Развертывание запрещено.

DeployingFailedModel

string

Развертывание модели, завершилось сбоем.

EmptyRequest

string

Пустой запрос.

EndpointCannotBeDefault

string

Конечная точка не может быть по умолчанию.

EndpointNotUpdatable

string

Конечная точка не является обновляемой.

EndpointWithoutLogging

string

Конечная точка без ведения журнала.

ExceededNumberOfRecordingsUris

string

Превышено число URI записей.

FailedDataset

string

Сбой набора данных.

Forbidden

string

Запрещено.

InUseViolation

string

Нарушение при использовании.

InaccessibleCustomerStorage

string

Недоступное хранилище клиента.

InvalidAdaptationMapping

string

Недопустимое сопоставление адаптации.

InvalidBaseModel

string

Недопустимая базовая модель.

InvalidCallbackUri

string

Недопустимый URI обратного вызова.

InvalidCollection

string

Недопустимая коллекция.

InvalidDataset

string

Недопустимый набор данных.

InvalidDocument

string

Недопустимый документ.

InvalidDocumentBatch

string

Недопустимый пакет документа.

InvalidLocale

string

Недопустимый языковой стандарт.

InvalidLogDate

string

Недопустимая дата журнала.

InvalidLogEndTime

string

Недопустимое время окончания журнала.

InvalidLogId

string

Недопустимый идентификатор журнала.

InvalidLogStartTime

string

Недопустимое время начала журнала.

InvalidModel

string

Недопустимая модель.

InvalidModelUri

string

Недопустимый универсальный код ресурса (URI) модели.

InvalidParameter

string

Недопустимый параметр.

InvalidParameterValue

string

Недопустимое значение параметра.

InvalidPayload

string

Недопустимые полезные данные.

InvalidPermissions

string

Недопустимые разрешения.

InvalidPrerequisite

string

Недопустимое предварительное условие.

InvalidProductId

string

Недопустимый идентификатор продукта.

InvalidProject

string

Недопустимый проект.

InvalidProjectKind

string

Недопустимый тип проекта.

InvalidRecordingsUri

string

Недопустимый URI записей.

InvalidRequestBodyFormat

string

Недопустимый формат текста запроса.

InvalidSasValidityDuration

string

Недопустимая длительность действия SAS.

InvalidSkipTokenForLogs

string

Недопустимый маркер пропуска для журналов.

InvalidSourceAzureResourceId

string

Недопустимый исходный идентификатор ресурса Azure.

InvalidSubscription

string

Недопустимая подписка.

InvalidTest

string

Недопустимый тест.

InvalidTimeToLive

string

Недопустимое время жизни.

InvalidTopForLogs

string

Недопустимое начало для журналов.

InvalidTranscription

string

Недопустимое транскрибирование.

InvalidWebHookEventKind

string

Недопустимый тип события веб-перехватчика.

MissingInputRecords

string

Отсутствуют входные записи.

ModelCopyOperationExists

string

Операция копирования модели существует.

ModelDeploymentNotCompleteState

string

Состояние развертывания модели не завершено.

ModelDeprecated

string

Модель не рекомендуется.

ModelExists

string

Модель существует.

ModelMismatch

string

Несоответствие модели.

ModelNotDeployable

string

Модель не развертывается.

ModelVersionIncorrect

string

Неправильная версия модели.

NoUtf8WithBom

string

Нет utf8 с bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Только один из URL-адресов, контейнера или набора данных.

ProjectGenderMismatch

string

Несоответствие пола проекта.

QuotaViolation

string

Нарушение квоты.

SingleDefaultEndpoint

string

Одна конечная точка по умолчанию.

SkuLimitsExist

string

Существуют ограничения номера SKU.

SubscriptionNotFound

string

Подписка не найдена.

UnexpectedError

string

Непредвиденная ошибка.

UnsupportedClassBasedAdaptation

string

Неподдерживаемая адаптация на основе класса.

UnsupportedDelta

string

Неподдерживаемая разностная разница.

UnsupportedDynamicConfiguration

string

Динамическая конфигурация не поддерживается.

UnsupportedFilter

string

Неподдерживаемый фильтр.

UnsupportedLanguageCode

string

Неподдерживаемый код языка.

UnsupportedOrderBy

string

Неподдерживаемый заказ.

UnsupportedPagination

string

Неподдерживаемое разбиение на страницы.

UnsupportedTimeRange

string

Неподдерживаемый диапазон времени.

Endpoint

Конечная точка

Имя Тип Описание
createdDateTime

string

Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).

customProperties

object

Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.

description

string

Описание объекта .

displayName

string

Отображаемое имя объекта.

lastActionDateTime

string

Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).

links

EndpointLinks

EndpointLinks

locale

string

Языковой стандарт содержащихся данных.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointProperties

EndpointProperties

self

string

Расположение этой сущности.

status

Status

Состояние
Описание текущего состояния API

text

string

Текст, используемый для адаптации языковой модели для этой конечной точки.

EndpointLinks

Имя Тип Описание
logs

string

Журналы звука и транскрибирования для этой конечной точки. Дополнительные сведения см. в разделе Операция "Endpoints_ListLogs".

restConversation

string

Конечная точка REST для запросов до 60 секунд.

restDictation

string

Конечная точка REST для запросов до 60 секунд, поддерживающая диктовку знаков препинания.

restInteractive

string

Конечная точка REST для коротких запросов до 15 секунд.

webSocketConversation

string

Конечная точка пакета SDK службы "Речь" для длительных запросов с несколькими конечными результатами.

webSocketDictation

string

Конечная точка пакета SDK службы "Речь" для длительных запросов с несколькими конечными результатами, поддерживающими диктовку знаков препинания.

webSocketInteractive

string

Конечная точка пакета SDK службы "Речь" для коротких запросов до 15 секунд с одним конечным результатом.

EndpointProperties

EndpointProperties

Имя Тип Описание
email

string

Адрес электронной почты для отправки Уведомления по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.

error

EntityError

EntityError

loggingEnabled

boolean

Значение, указывающее, используется ли для развертывания ведение журнала содержимого (аудио & транскрибирования).

timeToLive

string

Как долго конечная точка будет храниться в системе. Как только конечная точка достигнет срока жизни после завершения (успешного или неудачного) она будет автоматически удалена. Если не задать это значение или значение 0, автоматическое удаление будет отключено. Самая длинная поддерживаемая длительность — 31 день. Длительность закодирована в формате ISO 8601 duration ("PnYnMnDTnHnMnS", см https://en.wikipedia.org/wiki/ISO_8601#Durations. ).

EntityError

EntityError

Имя Тип Описание
code

string

Код этой ошибки.

message

string

Сообщение для этой ошибки.

EntityReference

EntityReference

Имя Тип Описание
self

string

Расположение упоминаемой сущности.

Error

Ошибка

Имя Тип Описание
code

ErrorCode

ErrorCode
Коды ошибок высокого уровня.

details

Error[]

Дополнительные сведения об ошибке и (или) ожидаемых политиках.

innerError

InnerError

InnerError
Новый формат внутренней ошибки, соответствующий рекомендациям по API Cognitive Services, который доступен по адресу https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Формат содержит обязательные свойства ErrorCode, сообщение и необязательные свойства target, подробности (пара значений ключа), внутреннюю ошибку (это может быть вложено).

message

string

Сообщение об ошибке высокого уровня.

target

string

Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

ErrorCode

ErrorCode

Имя Тип Описание
Conflict

string

Представляет код ошибки конфликта.

Forbidden

string

Представляет код запрещенной ошибки.

InternalCommunicationFailed

string

Представляет код ошибки сбоя внутреннего взаимодействия.

InternalServerError

string

Представляет код ошибки внутреннего сервера.

InvalidArgument

string

Представляет код ошибки недопустимого аргумента.

InvalidRequest

string

Представляет недопустимый код ошибки запроса.

NotAllowed

string

Представляет недопустимый код ошибки.

NotFound

string

Представляет код ошибки "Не найден".

PipelineError

string

Представляет код ошибки конвейера.

ServiceUnavailable

string

Представляет код ошибки недоступности службы.

TooManyRequests

string

Представляет код ошибки слишком большого количества запросов.

Unauthorized

string

Представляет код неавторизованной ошибки.

UnprocessableEntity

string

Представляет код ошибки необработаемой сущности.

UnsupportedMediaType

string

Представляет код ошибки типа неподдерживаемого носителя.

InnerError

InnerError

Имя Тип Описание
code

DetailedErrorCode

DetailedErrorCode
Подробное перечисление кода ошибки.

details

object

Дополнительные сведения об ошибке и (или) ожидаемых политиках.

innerError

InnerError

InnerError
Новый формат внутренней ошибки, соответствующий рекомендациям по API Cognitive Services, который доступен по адресу https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Формат содержит обязательные свойства ErrorCode, сообщение и необязательные свойства target, подробности (пара значений ключа), внутреннюю ошибку (это может быть вложено).

message

string

Сообщение об ошибке высокого уровня.

target

string

Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

Status

Состояние

Имя Тип Описание
Failed

string

Долго выполняющаяся операция завершилась сбоем.

NotStarted

string

Долго выполняющаяся операция еще не запущена.

Running

string

В настоящее время выполняется длительная операция.

Succeeded

string

Длительная операция успешно завершена.