Models - Create

Ссылка

Служба:: Azure AI Services

Версия API:: v3.1

Создает новую модель.

POST {endpoint}/speechtotext/v3.1/models

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus.api.cognitive.microsoft.com).

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

Имя	Обязательно	Тип	Описание
displayName	True	string minLength: 1	Отображаемое имя объекта.
locale	True	string minLength: 1	Языковой стандарт содержащихся данных.
baseModel		EntityReference	EntityReference
customProperties		object	Настраиваемые свойства этой сущности. Максимальная допустимая длина ключа — 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.
datasets		EntityReference[]	Наборы данных, используемые для адаптации.
description		string	Описание объекта .
links		CustomModelLinks	CustomModelLinks
project		EntityReference	EntityReference
properties		CustomModelProperties	CustomModelProperties
text		string	Текст, используемый для адаптации этой языковой модели.

Ответы

Имя	Тип	Описание
201 Created	CustomModel	Ответ содержит сведения о сущности в качестве полезных данных и ее расположении в качестве заголовка. Заголовки Location: string
Other Status Codes	Error	Произошла ошибка.

Имя

Тип

Описание

201 Created

CustomModel

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

Заголовки

Location: string

Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Create a model

Create a model with custom model weight

Create a model

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

HTTP

POST {endpoint}/speechtotext/v3.1/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

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

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

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 30,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Create a model with custom model weight

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

HTTP

POST {endpoint}/speechtotext/v3.1/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

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

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

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 42,
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}

Определения

Имя	Описание
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Ошибка
ErrorCode	ErrorCode
InnerError	InnerError
Status	Состояние

CustomModel

Object

CustomModel

Имя	Тип	Описание
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.
datasets	EntityReference[]	Наборы данных, используемые для адаптации.
description	string	Описание объекта .
displayName	string minLength: 1	Отображаемое имя объекта.
lastActionDateTime	string (date-time)	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
links	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	Языковой стандарт содержащихся данных.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
self	string (uri)	Расположение этой сущности.
status	Status	Состояние Описание текущего состояния API
text	string	Текст, используемый для адаптации этой языковой модели.

CustomModelDeprecationDates

Object

CustomModelDeprecationDates

Имя	Тип	Описание
transcriptionDateTime	string (date-time)	Дата, когда транскрибирование становится нерекомендуемой.

CustomModelFeatures

Object

CustomModelFeatures

Имя	Тип	Описание
supportsEndpoints	boolean	Значение, указывающее, поддерживается ли создание конечных точек для динамического транскрибирования.
supportsTranscriptions	boolean	Значение, указывающее, поддерживается ли пакетное транскрибирование.
supportsTranscriptionsOnSpeechContainers	boolean	Значение , указывающее, можно ли использовать эту модель для транскрибирования в контейнере речи. Эту функцию можно добавить в существующие модели, когда она станет пригодной для использования в контейнере речи.

CustomModelLinks

Object

CustomModelLinks

Имя	Тип	Описание
copyTo	string (uri)	Расположение действия копирования модели. Дополнительные сведения см. в разделе операция "Models_CopyTo".
files	string (uri)	Расположение для получения всех файлов этой сущности. Дополнительные сведения см. в разделе операция "Models_ListFiles".
manifest	string (uri)	Расположение для получения манифеста для этой модели, которое будет использоваться в локальном контейнере. Дополнительные сведения см. в разделе операция "Models_GetCustomModelManifest".

CustomModelProperties

Object

CustomModelProperties

Имя	Тип	Описание
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Вес пользовательской модели в диапазоне от 1 (1 % настраиваемой модели и 99 % базовой модели) до 100 (100 % настраиваемая модель и 0 % базовая модель). Если это свойство не задано, служба выбирает подходящее значение (получает модель для получения выбранного веса). Начните без использования этого свойства. При необходимости выберите больший (или меньший) вес, чтобы увеличить (или уменьшить) влияние пользовательской модели.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
email	string	Адрес электронной почты для отправки Уведомления по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Функции, поддерживаемые моделью.

DetailedErrorCode

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

DetailedErrorCode

Значение	Описание
DataImportFailed	Сбой импорта данных.
DeleteNotAllowed	Удаление запрещено.
DeployNotAllowed	Развертывание запрещено.
DeployingFailedModel	Развертывание модели со сбоем.
EmptyRequest	Пустой запрос.
EndpointCannotBeDefault	Конечная точка не может быть по умолчанию.
EndpointNotUpdatable	Конечная точка не обновляема.
EndpointWithoutLogging	Конечная точка без ведения журнала.
ExceededNumberOfRecordingsUris	Превышено число URI записей.
FailedDataset	Сбой набора данных.
Forbidden	Запрещено.
InUseViolation	Нарушение при использовании.
InaccessibleCustomerStorage	Недоступное хранилище клиента.
InvalidAdaptationMapping	Недопустимое сопоставление адаптации.
InvalidBaseModel	Недопустимая базовая модель.
InvalidCallbackUri	Недопустимый URI обратного вызова.
InvalidCollection	Недопустимая коллекция.
InvalidDataset	Недопустимый набор данных.
InvalidDocument	Недопустимый документ.
InvalidDocumentBatch	Недопустимый пакет документа.
InvalidLocale	Недопустимый языковой стандарт.
InvalidLogDate	Недопустимая дата журнала.
InvalidLogEndTime	Недопустимое время окончания журнала.
InvalidLogId	Недопустимый идентификатор журнала.
InvalidLogStartTime	Недопустимое время начала журнала.
InvalidModel	Недопустимая модель.
InvalidModelUri	Недопустимый URI модели.
InvalidParameter	Недопустимый параметр.
InvalidParameterValue	Недопустимое значение параметра.
InvalidPayload	Недопустимые полезные данные.
InvalidPermissions	Недопустимые разрешения.
InvalidPrerequisite	Недопустимое условие.
InvalidProductId	Недопустимый идентификатор продукта.
InvalidProject	Недопустимый проект.
InvalidProjectKind	Недопустимый тип проекта.
InvalidRecordingsUri	Недопустимый URI записей.
InvalidRequestBodyFormat	Недопустимый формат текста запроса.
InvalidSasValidityDuration	Недопустимая длительность действия SAS.
InvalidSkipTokenForLogs	Недопустимый маркер пропуска для журналов.
InvalidSubscription	Недопустимая подписка.
InvalidTest	Недопустимый тест.
InvalidTimeToLive	Недопустимое время жизни.
InvalidTopForLogs	Недопустимый верхний для журналов.
InvalidTranscription	Недопустимое транскрибирование.
InvalidWebHookEventKind	Недопустимый тип события веб-перехватчика.
MissingInputRecords	Отсутствуют входные записи.
ModelDeploymentNotCompleteState	Развертывание модели не завершено.
ModelDeprecated	Модель не рекомендуется.
ModelExists	Модель существует.
ModelMismatch	Несоответствие модели.
ModelNotDeployable	Модель не развертывается.
ModelVersionIncorrect	Неправильная версия модели.
NoUtf8WithBom	Нет utf8 с bom.
OnlyOneOfUrlsOrContainerOrDataset	Только один из URL-адресов, контейнера или набора данных.
ProjectGenderMismatch	Несоответствие пола проекта.
QuotaViolation	Нарушение квоты.
SingleDefaultEndpoint	Одна конечная точка по умолчанию.
SkuLimitsExist	Существуют ограничения SKU.
SubscriptionNotFound	Подписка не найдена.
UnexpectedError	Непредвиденная ошибка.
UnsupportedClassBasedAdaptation	Неподдерживаемая адаптация на основе класса.
UnsupportedDelta	Неподдерживаемая разностная разница.
UnsupportedDynamicConfiguration	Неподдерживаемая динамическая конфигурация.
UnsupportedFilter	Неподдерживаемый фильтр.
UnsupportedLanguageCode	Неподдерживаемый код языка.
UnsupportedOrderBy	Неподдерживаемый порядок.
UnsupportedPagination	Неподдерживаемое разбиение на страницы.
UnsupportedTimeRange	Неподдерживаемый диапазон времени.

EntityError

Object

EntityError

Имя	Тип	Описание
code	string	Код этой ошибки.
message	string	Сообщение для этой ошибки.

EntityReference

Object

EntityReference

Имя	Тип	Описание
self	string (uri)	Расположение упоминаемой сущности.

Error

Object

Ошибка

Имя	Тип	Описание
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	Представляет код ошибки конфликта.
Forbidden	Представляет код запрещенной ошибки.
InternalCommunicationFailed	Представляет код ошибки сбоя внутреннего взаимодействия.
InternalServerError	Представляет код ошибки внутреннего сервера.
InvalidArgument	Представляет код ошибки недопустимого аргумента.
InvalidRequest	Представляет недопустимый код ошибки запроса.
NotAllowed	Представляет недопустимый код ошибки.
NotFound	Представляет код ошибки "Не найден".
PipelineError	Представляет код ошибки конвейера.
ServiceUnavailable	Представляет код ошибки недоступности службы.
TooManyRequests	Представляет код ошибки слишком большого количества запросов.
Unauthorized	Представляет код неавторизованной ошибки.
UnprocessableEntity	Представляет код ошибки необработаемой сущности.
UnsupportedMediaType	Представляет код ошибки типа неподдерживаемого носителя.

InnerError

Object

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	Долго выполняющаяся операция завершилась сбоем.
NotStarted	Долго выполняющаяся операция еще не запущена.
Running	В настоящее время выполняется длительная операция.
Succeeded	Длительная операция успешно завершена.

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

Models - Create

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Create a model

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

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

Create a model with custom model weight

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

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

Определения

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

Дополнительные ресурсы