Models - Get Base Model

Ссылка

Служба:: Azure AI Services

Версия API:: v3.2-preview.2

Возвращает базовую модель, определяемую заданным идентификатором.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/{id}

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	BaseModel	ХОРОШО
Other Status Codes	Error	Произошла ошибка.

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get a base model

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

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

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

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": true,
      "supportsAdaptationsWith": [
        "Language",
        "Acoustic"
      ],
      "supportedOutputFormats": [
        "Display",
        "Lexical"
      ]
    },
    "chargeForAdaptation": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "en-US Base model"
}

Определения

Имя	Описание
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Ошибка
ErrorCode	Код ошибки
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Состояние

BaseModel

Object

BaseModel

Имя	Тип	Описание
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	Отображаемое имя объекта.
lastActionDateTime	string (date-time)	Метка времени при вводе текущего состояния. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	Языковой стандарт содержащихся данных.
properties	BaseModelProperties	BaseModelProperties
self	string (uri)	Расположение этой сущности.
status	Status	Состояние Описание текущего состояния API

BaseModelDeprecationDates

Object

BaseModelDeprecationDates

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

BaseModelFeatures

Object

BaseModelFeatures

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

BaseModelLinks

Object

BaseModelLinks

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

BaseModelProperties

Object

BaseModelProperties

Имя	Тип	Описание
chargeForAdaptation	boolean	Значение, указывающее, взимается ли адаптация модели.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Функции, поддерживаемые моделью.

DatasetKind

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

DatasetKind

Значение	Описание
Acoustic	Акустический набор данных.
AudioFiles	Набор данных аудиофайлов.
Language	Набор данных языка.
LanguageMarkdown	Набор данных markdown языка.
OutputFormatting	Набор данных, содержащий правила для настройки обратной нормализации текста, прописи, переформулирования, ненормативной лексики, а также определяет тесты для проверки набора данных
Pronunciation	Набор данных произношения.

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	Недопустимый маркер пропуска для журналов.
InvalidSourceAzureResourceId	Недопустимый исходный идентификатор ресурса Azure.
InvalidSubscription	Недопустимая подписка.
InvalidTest	Недопустимый тест.
InvalidTimeToLive	Недопустимое время жизни.
InvalidTopForLogs	Недопустимое начало для журналов.
InvalidTranscription	Недопустимое транскрибирование.
InvalidWebHookEventKind	Недопустимый тип события веб-перехватчика.
MissingInputRecords	Отсутствуют входные записи.
ModelCopyOperationExists	Существует операция копирования модели.
ModelDeploymentNotCompleteState	Развертывание модели не завершено.
ModelDeprecated	Модель устарела.
ModelExists	Существует модель.
ModelMismatch	Несоответствие модели.
ModelNotDeployable	Модель недоступна для развертывания.
ModelVersionIncorrect	Неправильная версия модели.
NoUtf8WithBom	Нет utf8 с бомом.
OnlyOneOfUrlsOrContainerOrDataset	Только один url-адрес или контейнер или набор данных.
ProjectGenderMismatch	Несоответствие пола проекта.
QuotaViolation	Нарушение квоты.
SingleDefaultEndpoint	Одна конечная точка по умолчанию.
SkuLimitsExist	Существуют ограничения SKU.
SubscriptionNotFound	Подписка не найдена.
UnexpectedError	Непредвиденная ошибка.
UnsupportedClassBasedAdaptation	Неподдерживаемая адаптация на основе класса.
UnsupportedDelta	Неподдерживаемые разностные данные.
UnsupportedDynamicConfiguration	Неподдерживаемая динамическая конфигурация.
UnsupportedFilter	Неподдерживаемый фильтр.
UnsupportedLanguageCode	Неподдерживаемый код языка.
UnsupportedOrderBy	Неподдерживаемый заказ.
UnsupportedPagination	Неподдерживаемая разбивка на страницы.
UnsupportedTimeRange	Неподдерживаемый диапазон времени.

Error

Object

Ошибка

Имя	Тип	Описание
code	ErrorCode	Код ошибки Коды ошибок высокого уровня.
details	Error[]	Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innerError	InnerError	InnerError Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

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, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

OutputFormatType

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

OutputFormatType

Значение	Описание
Display	Модель поддерживает отображение выходных данных транскрибирования или конечных точек форматирования.
Lexical	Модель предоставляет выходные данные транскрибирования без форматирования.

Status

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

Состояние

Значение	Описание
Failed	Сбой длительной операции.
NotStarted	Долго выполняющаяся операция еще не запущена.
Running	В настоящее время выполняется длительная операция.
Succeeded	Долго выполняющаяся операция успешно завершена.

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

Models - Get Base Model

Параметры URI

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Get a base model

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

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

Определения

BaseModel

BaseModelDeprecationDates

BaseModelFeatures

BaseModelLinks

BaseModelProperties

DatasetKind

DetailedErrorCode

Error

ErrorCode

InnerError

OutputFormatType

Status

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