Models - List Base Models

Ссылка

Служба:: Azure AI Services

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

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

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

С использованием необязательных параметров:

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip={skip}&top={top}&filter={filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus.api.cognitive.microsoft.com).
filter	query		string	Выражение фильтрации для выбора подмножества доступных базовых моделей. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running'`
skip	query		integer int32	Количество наборов данных, которые будут пропущены.
top	query		integer int32	Количество наборов данных, которые будут включены после пропуска.

Ответы

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get all english base models

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

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

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

{
  "values": [
    {
      "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	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedBaseModels	Разбиение на страницыBaseModels
Status	Состояние

BaseModel

Имя	Тип	Описание
createdDateTime	string	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
description	string	Описание объекта .
displayName	string	Отображаемое имя объекта.
lastActionDateTime	string	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
links	BaseModelLinks	BaseModelLinks
locale	string	Языковой стандарт содержащихся данных.
properties	BaseModelProperties	BaseModelProperties
self	string	Расположение этой сущности.
status	Status	Состояние Описание текущего состояния API

BaseModelDeprecationDates

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

BaseModelFeatures

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

BaseModelLinks

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

BaseModelProperties

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

DatasetKind

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

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	Неподдерживаемый диапазон времени.

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

Имя	Тип	Описание
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

Имя	Тип	Описание
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	Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

OutputFormatType

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

PaginatedBaseModels

Разбиение на страницыBaseModels

Имя	Тип	Описание
@nextLink	string	Ссылка на следующий набор результатов с разбивкой на страницы, если доступно больше сущностей; в противном случае — null.
values	BaseModel[]	Список сущностей, ограниченных либо переданными параметрами запроса skip и top, либо значениями по умолчанию. При итерации списка с использованием разбиения на страницы и параллельного удаления сущностей некоторые сущности будут пропущены в результатах. Рекомендуется создать список на клиенте и удалить после получения полного списка.

Имя

Тип

Описание

@nextLink

string

Ссылка на следующий набор результатов с разбивкой на страницы, если доступно больше сущностей; в противном случае — null.

values

BaseModel[]

Список сущностей, ограниченных либо переданными параметрами запроса skip и top, либо значениями по умолчанию.

При итерации списка с использованием разбиения на страницы и параллельного удаления сущностей некоторые сущности будут пропущены в результатах. Рекомендуется создать список на клиенте и удалить после получения полного списка.

Status

Состояние

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

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