Transcriptions - Get

Служба:: Azure AI Services

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

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	Transcription	ХОРОШО Заголовки Retry-After: integer
Other Status Codes	Error	Произошла ошибка.

Имя

Тип

Описание

200 OK

Transcription

ХОРОШО

Заголовки

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 a transcription

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683

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

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

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
  },
  "properties": {
    "diarizationEnabled": false,
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "duration": "PT42S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  }
}

Определения

Имя	Описание
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Ошибка
ErrorCode	Код ошибки
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	Ненормативная лексикаFilterMode
PunctuationMode	Знак препинанияMode
Status	Состояние
Transcription	Транскрипция
TranscriptionLinks	ТранскрибированиеLinks
TranscriptionProperties	ТранскрибированиеProperties

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	Существует операция копирования модели.

DiarizationProperties

Object

DiarizationProperties

Имя	Тип	Описание
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Object

DiarizationSpeakersProperties

Имя	Тип	Описание
maxCount	integer (int32) minimum: 1	Максимальное количество динамиков для диаризации. Должно быть меньше 36 и больше или равно свойству minSpeakers.
minCount	integer (int32) minimum: 1	Указание минимального количества динамиков для диаризации. Должно быть меньше или равно свойству maxSpeakers.

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

LanguageIdentificationMode

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

LanguageIdentificationMode

Значение	Описание
Continuous	Непрерывная идентификация языка (по умолчанию).
Single	Идентификация одного языка.

LanguageIdentificationProperties

Object

LanguageIdentificationProperties

Имя	Тип	Default value	Описание
candidateLocales	string[]		Кандидат языковых стандартов для идентификации языка (например, ["en-US", "de-DE", ", "es-ES"]). Поддерживается не менее 2 и не более 10 языков-кандидатов, включая основной языковой стандарт для транскрибирования.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode Режим, используемый для идентификации языка.
speechModelMapping	<string, EntityReference>		Необязательное сопоставление языковых стандартов с сущностями модели речи. Если для языкового стандарта не задана модель, используется базовая модель по умолчанию. Ключи должны быть языковыми стандартами, содержащимися в языковых стандартах кандидата, значения — это сущности для моделей соответствующих языковых стандартов.

ProfanityFilterMode

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

Ненормативная лексикаFilterMode

Значение	Описание
None	Отключите фильтрацию ненормативной лексики.
Removed	Удаление ненормативной лексики.
Tags	Добавление xml-тегов "ненормативность"</Profanity>
Masked	Маскирование ненормативной лексики с * за исключением первой буквы, например f***

PunctuationMode

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

Знак препинанияMode

Значение	Описание
None	Нет препинания.
Dictated	Диктуированные знаки препинания только, т. е. явные знаки препинания.
Automatic	Автоматическое препинание.
DictatedAndAutomatic	Диктуированные знаки препинания или автоматические знаки препинания.

Status

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

Состояние

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

Transcription

Object

Транскрипция

Имя	Тип	Описание
contentContainerUrl	string (uri)	URL-адрес контейнера BLOB-объектов Azure, содержащего звуковые файлы. Контейнер может иметь максимальный размер 5 ГБ и максимальное число 10000 BLOB-объектов. Максимальный размер большого двоичного объекта составляет 2,5 ГБ. SAS контейнера должен содержать разрешения r (read) и l (list). Это свойство не будет возвращено в ответе.
contentUrls	string[] (uri)	Список URL-адресов содержимого для получения аудиофайлов для транскрибирования. Разрешено до 1000 URL-адресов. Это свойство не будет возвращено в ответе.
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.
dataset	EntityReference	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	TranscriptionLinks	ТранскрибированиеLinks
locale	string minLength: 1	Языковой стандарт содержащихся данных. Если используется идентификация языка, этот языковой стандарт используется для транскрибирования речи, для которой не удалось обнаружить язык.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	ТранскрибированиеProperties
self	string (uri)	Расположение этой сущности.
status	Status	Состояние Описание текущего состояния API

TranscriptionLinks

Object

ТранскрибированиеLinks

Имя	Тип	Описание
files	string (uri)	Расположение для получения всех файлов этой сущности. Дополнительные сведения см. в операции "Transcriptions_ListFiles".

TranscriptionProperties

Object

ТранскрибированиеProperties

Имя	Тип	Описание
channels	integer[] (int32)	Коллекция запрошенных номеров каналов. В случае по умолчанию рассматриваются каналы 0 и 1.
destinationContainerUrl	string (uri)	Запрошенный контейнер назначения. Замечания Если целевой контейнер используется в сочетании с `timeToLive`, метаданные транскрибирования будут удалены обычно, но данные, хранящиеся в целевом контейнере, включая результаты транскрибирования, останутся нетронутыми, так как для этого контейнера не требуются разрешения на удаление. Чтобы обеспечить автоматическую очистку, настройте время существования BLOB-объектов в контейнере или используйте команду "Принести собственное хранилище (BYOS)" вместо `destinationContainerUrl`, где можно очистить большие двоичные объекты.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Значение, указывающее, запрашивается ли диаризация (идентификация говорящего). Значение по умолчанию — `false`. Если для этого поля задано значение true, а улучшенная система диаризации настроена путем указания `DiarizationProperties`, улучшенная система диаризации обеспечит диаризацию для настраиваемого диапазона динамиков. Если для этого поля задано значение true, а улучшенная система диаризации не включена (не указывая `DiarizationProperties`), базовая система диаризации будет различать до двух динамиков. Дополнительные расходы не применяются к базовой диаризации. Базовая система диаризации устарела и будет удалена в следующей основной версии API. Этот параметр `diarizationEnabled` также будет удален.
displayFormWordLevelTimestampsEnabled	boolean	Значение, указывающее, запрашиваются ли метки времени уровня слова для формы отображения. Значение по умолчанию — `false`.
duration	string	Длительность транскрибирования. Длительность закодирована как длительность ISO 8601 ("PnYnMnDTnHnMnS", см. https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	Адрес электронной почты для отправки уведомлений по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	Ненормативная лексикаFilterMode Режим фильтрации ненормативной лексики.
punctuationMode	PunctuationMode	Знак препинанияMode Режим, используемый для препинания.
timeToLive	string	Как долго транскрибирование будет храниться в системе после завершения. После того как транскрибирование достигнет времени жизни после завершения (успешно или неудачно), оно будет автоматически удалено. Не устанавливайте это значение или не устанавливая значение 0, отключит автоматическое удаление. Самая длинная поддерживаемая длительность — 31 дней. Длительность закодирована как длительность ISO 8601 ("PnYnMnDTnHnMnS", см. https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Значение, указывающее, запрашиваются ли метки времени уровня слова. Значение по умолчанию — `false`.

Transcriptions - Get

Параметры URI

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Get a transcription

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

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

Определения

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Замечания