Models - List Custom Models

Служба:: Azure AI Services

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

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

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

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

GET {endpoint}/speechtotext/v3.2-preview.2/models?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	PaginatedCustomModels	ХОРОШО Заголовки Retry-After: integer
Other Status Codes	Error	Произошла ошибка.

Имя

Тип

Описание

200 OK

PaginatedCustomModels

ХОРОШО

Заголовки

Retry-After: integer

Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get all models in state 'Running'

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models?skip=0&top=2&filter=status%20eq%20'Running'

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

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

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic model",
      "description": "Example for an acoustic model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Определения

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

CustomModel

Object

CustomModel

Имя	Тип	Описание
baseModel	EntityReference	EntityReference
createdDateTime	string (date-time)	Метка времени при создании объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. 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 ("ГГГГ-ММ-DDThh:мм:ssZ", см. 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

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

CustomModelLinks

Object

CustomModelLinks

Имя	Тип	Описание
copy	string (uri)	Расположение действия копирования модели. Дополнительные сведения см. в операции "Models_Copy".
copyTo	string (uri)	Расположение для устаревшего действия копирования модели. Дополнительные сведения см. в операции "Models_CopyTo".
files	string (uri)	Расположение для получения всех файлов этой сущности. Дополнительные сведения см. в операции "Models_ListFiles".
manifest	string (uri)	Расположение для получения манифеста для этой модели, которое будет использоваться в контейнере on-prem. Дополнительные сведения см. в операции "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

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

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

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

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

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

Код ошибки

Значение	Описание
InvalidRequest	Представляет недопустимый код ошибки запроса.
InvalidArgument	Представляет недопустимый код ошибки аргумента.
InternalServerError	Представляет код ошибки внутреннего сервера.
ServiceUnavailable	Представляет недоступный код ошибки службы.
NotFound	Представление не найденного кода ошибки.
PipelineError	Представляет код ошибки конвейера.
Conflict	Представляет код ошибки конфликта.
InternalCommunicationFailed	Представляет код ошибки внутренней связи.
Forbidden	Представляет запрещенный код ошибки.
NotAllowed	Представляет недопустимый код ошибки.
Unauthorized	Представляет несанкционированный код ошибки.
UnsupportedMediaType	Представляет неподдерживаемый код ошибки типа носителя.
TooManyRequests	Представление слишком большого количества запросов кода ошибки.
UnprocessableEntity	Представляет код ошибки необработанной сущности.

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

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

PaginatedCustomModels

Object

PaginatedCustomModels

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

Имя

Тип

Описание

@nextLink

string (uri)

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

values

CustomModel[]

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

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

Status

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

Состояние

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