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


Datasets - List Files

Возвращает файлы набора данных, определяемые заданным ИД.

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/{id}/files
GET {endpoint}/speechtotext/v3.2-preview.2/datasets/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&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: name, createdDateTime, kind.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime.

          - and, or, not are supported.

        - Example:

          filter=name eq 'myaudio.wav' and kind eq 'Audio'
sasValidityInSeconds
query

integer

int32

Длительность действия URL-адреса SAS (в секундах). Длительность по умолчанию — 12 часов. При использовании BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): значение 0 означает, что будет создан простой URI большого двоичного объекта без маркера SAS.

skip
query

integer

int32

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

top
query

integer

int32

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

Ответы

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

PaginatedFiles

ОК

Заголовки

Retry-After: integer

Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get all dataset report files
Get all files

Get all dataset report files

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

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasValidityInSeconds=120&skip=0&top=10&filter=kind%20eq%20'DatasetReport'

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

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "report.json",
      "kind": "DatasetReport",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ]
}

Get all files

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

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasValidityInSeconds=120&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/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "report.json",
      "kind": "DatasetReport",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86",
      "name": "language_data.txt",
      "kind": "LanguageData",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Определения

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

DetailedErrorCode

Error

Ошибка

ErrorCode

ErrorCode

File

File

FileKind

FileKind

FileLinks

FileLinks

FileProperties

Свойства FileProperties

InnerError

InnerError

PaginatedFiles

Файлы с разбивкой на страницы

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

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

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

Представляет код ошибки типа неподдерживаемого носителя.

File

File

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

string

Время создания этого файла. Метка времени закодирована в формате даты и времени ISO 8601 (см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

kind

FileKind

FileKind
Тип данных.

links

FileLinks

FileLinks

name

string

Имя этого файла.

properties

FileProperties

Свойства FileProperties

self

string

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

FileKind

FileKind

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

string

Тип данных — архив акустических данных.

AcousticDataTranscriptionV2

string

Тип данных — акустическое транскрибирование данных версии 2.

Audio

string

Тип данных — аудио.

DatasetReport

string

Тип данных — отчет о наборе данных.

EvaluationDetails

string

Тип данных — сведения об оценке.

LanguageData

string

Тип данных — языковые данные.

ModelReport

string

Тип данных — отчет модели.

OutputFormattingData

string

Тип данных — входной файл форматирования выходных данных.

PronunciationData

string

Тип данных — данные произношения.

Transcription

string

Тип данных — транскрибирование.

TranscriptionReport

string

Тип данных — отчет о транскрибировании.

FileLinks

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

string

URL-адрес для получения содержимого этого файла.

FileProperties

Свойства FileProperties

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

string

Длительность на случай, если этот файл является звуковым. Длительность закодирована в формате ISO 8601 duration ("PnYnMnDTnHnMnS", см https://en.wikipedia.org/wiki/ISO_8601#Durations. ).

size

integer

Размер данных в байтах.

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

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

PaginatedFiles

Файлы с разбивкой на страницы

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

string

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

values

File[]

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

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