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


Projects - List Transcriptions

Возвращает список транскрибирования для указанного проекта.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions
GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions?skip={skip}&top={top}&filter={filter}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
path True

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://westus.api.cognitive.microsoft.com

id
path True

string

uuid

Идентификатор проекта.

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=createdDateTime gt 2022-02-01T11:00:00Z
skip
query

integer

int32

Количество наборов данных, которые будут пропущены.

top
query

integer

int32

Количество наборов данных, которые будут включены после пропуска.

Ответы

Имя Тип Описание
200 OK

PaginatedTranscriptions

ОК

Заголовки

Retry-After: integer

Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get all transcriptions

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

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

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

{
  "values": [
    {
      "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"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "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": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Определения

Имя Описание
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Ошибка

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

Свойства LanguageIdentificationProperties

PaginatedTranscriptions

Разбивка на страницы

ProfanityFilterMode

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

PunctuationMode

PunctuationMode

Status

Состояние

Transcription

Расшифровка

TranscriptionLinks

Транскрибирование Ссылок

TranscriptionProperties

ТранскрибированиеСвойства

DetailedErrorCode

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

Неподдерживаемый диапазон времени.

DiarizationProperties

DiarizationProperties

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

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Имя Тип Описание
maxCount

integer

Максимальное количество динамиков для диаризации. Значение должно быть меньше 36 и больше или равно свойству minSpeakers.

minCount

integer

Указание минимального количества динамиков для диаризации. Значение должно быть меньше или равно свойству maxSpeakers.

EntityError

EntityError

Имя Тип Описание
code

string

Код этой ошибки.

message

string

Сообщение об этой ошибке.

EntityReference

EntityReference

Имя Тип Описание
self

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

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

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

Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

LanguageIdentificationMode

LanguageIdentificationMode

Имя Тип Описание
Continuous

string

Непрерывная идентификация языка (по умолчанию).

Single

string

Идентификация одного языка.

LanguageIdentificationProperties

Свойства LanguageIdentificationProperties

Имя Тип Default value Описание
candidateLocales

string[]

Языковые параметры-кандидаты для идентификации языка (например, ["en-US", "de-DE", "es-ES"]). Поддерживается не менее 2 и не более 10 потенциальных языковых стандартов, включая языковой стандарт main для транскрибирования.

mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
Режим, используемый для идентификации языка.

speechModelMapping

<string,  EntityReference>

Необязательное сопоставление языковых стандартов с сущностями модели речи. Если модель не указана для языкового стандарта, используется базовая модель по умолчанию. Ключи должны быть языковыми стандартами, содержащимися в потенциальных языковых стандартах, значения — это сущности для моделей соответствующих языковых стандартов.

PaginatedTranscriptions

Разбивка на страницы

Имя Тип Описание
@nextLink

string

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

values

Transcription[]

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

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

ProfanityFilterMode

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

Имя Тип Описание
Masked

string

Маскируйте ненормативную лексику с помощью * за исключением первой буквы, например f***

None

string

Отключите фильтрацию ненормативной лексики.

Removed

string

Удалите ненормативную лексику.

Tags

string

Добавление xml-тегов< "ненормативной лексики" или ненормативной лексики>

PunctuationMode

PunctuationMode

Имя Тип Описание
Automatic

string

Автоматическая пунктуация.

Dictated

string

Только знаки препинания, т. е. явные знаки препинания.

DictatedAndAutomatic

string

Продиктированные знаки препинания или автоматические знаки препинания.

None

string

Нет знаков препинания.

Status

Состояние

Имя Тип Описание
Failed

string

Долго выполняющаяся операция завершилась сбоем.

NotStarted

string

Долго выполняющаяся операция еще не запущена.

Running

string

В настоящее время выполняется длительная операция.

Succeeded

string

Длительная операция успешно завершена.

Transcription

Расшифровка

Имя Тип Описание
contentContainerUrl

string

URL-адрес контейнера BLOB-объектов Azure, содержащего звуковые файлы. Контейнер может иметь максимальный размер 5 ГБ и максимальное количество blob-объектов 10 000. Максимальный размер большого двоичного объекта — 2,5 ГБ. SAS контейнера должен содержать разрешения r (чтение) и l (список). Это свойство не будет возвращено в ответе.

contentUrls

string[]

Список URL-адресов содержимого для получения аудиофайлов для транскрибирования. Допускается до 1000 URL-адресов. Это свойство не будет возвращено в ответе.

createdDateTime

string

Метка времени создания объекта. Метка времени кодируется в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).

customProperties

object

Настраиваемые свойства этой сущности. Максимальная допустимая длина ключа — 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.

dataset

EntityReference

EntityReference

description

string

Описание объекта .

displayName

string

Отображаемое имя объекта.

lastActionDateTime

string

Метка времени ввода текущего состояния. Метка времени кодируется в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).

links

TranscriptionLinks

Транскрибирование Ссылок

locale

string

Языковой стандарт содержащихся данных. Если используется идентификация языка, этот языковой стандарт используется для транскрибирования речи, для которой не удалось обнаружить язык.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

TranscriptionProperties

ТранскрибированиеСвойства

self

string

Расположение этой сущности.

status

Status

Состояние
Описание текущего состояния API

Транскрибирование Ссылок

Имя Тип Описание
files

string

Расположение для получения всех файлов этой сущности. Дополнительные сведения см. в разделе операция "Transcriptions_ListFiles".

TranscriptionProperties

ТранскрибированиеСвойства

Имя Тип Описание
channels

integer[]

Коллекция запрошенных номеров каналов. В случае по умолчанию используются каналы 0 и 1.

destinationContainerUrl

string

Запрошенный целевой контейнер.

Комментарии

Если целевой контейнер используется в сочетании с timeToLive, метаданные транскрибирования обычно удаляются, но данные, хранящиеся в целевом контейнере, включая результаты транскрибирования, останутся нетронутыми, так как для этого контейнера не требуются разрешения на удаление.
Для поддержки автоматической очистки настройте время существования BLOB-объектов в контейнере или используйте "Использование собственного destinationContainerUrlхранилища (BYOS)" вместо , где большие двоичные объекты можно очистить.

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

PunctuationMode
Режим, используемый для пунктуации.

timeToLive

string

Как долго транскрибирование будет храниться в системе после завершения. Когда транскрибирование достигнет срока жизни после завершения (успешно или неудачно), оно будет автоматически удалено. Если не задать это значение или задать для него значение 0, автоматическое удаление будет отключено. Самая длинная поддерживаемая продолжительность — 31 день. Длительность закодирована как длительность ISO 8601 ("PnYnMnDTnHnMnS", см https://en.wikipedia.org/wiki/ISO_8601#Durations. ).

wordLevelTimestampsEnabled

boolean

Значение, указывающее, запрашиваются ли метки времени на уровне слов. Значение по умолчанию — false.