Datasets - Get

Ссылка

Служба:: Azure AI Services

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

Возвращает набор данных, идентифицируемый заданным идентификатором.

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

Параметры URI

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

Ответы

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

Имя

Тип

Описание

200 OK

Dataset

ОК

Заголовки

Retry-After: integer

Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get a dataset

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1

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

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

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
  "kind": "Acoustic",
  "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
  },
  "properties": {
    "textNormalizationKind": "Default",
    "acceptedLineCount": 11,
    "rejectedLineCount": 2,
    "duration": "PT4M12S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Acoustic dataset"
}

Определения

Имя	Описание
Dataset	Dataset
DatasetKind	DatasetKind
DatasetLinks	DatasetLinks
DatasetProperties	DatasetProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Ошибка
ErrorCode	ErrorCode
InnerError	InnerError
Status	Состояние
TextNormalizationKind	TextNormalizationKind

Dataset

Object

Dataset

Имя	Тип	Описание
contentUrl	string (uri)	URL-адрес данных для набора данных.
createdDateTime	string (date-time)	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.
description	string	Описание объекта .
displayName	string minLength: 1	Отображаемое имя объекта.
kind	DatasetKind	DatasetKind Тип импорта данных.
lastActionDateTime	string (date-time)	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
links	DatasetLinks	DatasetLinks
locale	string minLength: 1	Языковой стандарт содержащихся данных.
project	EntityReference	EntityReference
properties	DatasetProperties	DatasetProperties
self	string (uri)	Расположение этой сущности.
status	Status	Состояние Описание текущего состояния API

DatasetKind

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

DatasetKind

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

DatasetLinks

Object

DatasetLinks

Имя	Тип	Описание
commitBlocks	string (uri)	Расположение для фиксации списка блоков при отправке набора данных с помощью блоков. Дополнительные сведения см. в разделе операция "Datasets_CommitBlocks".
files	string (uri)	Расположение для получения всех файлов этой сущности. Дополнительные сведения см. в разделе операция "Datasets_ListFiles".
listBlocks	string (uri)	Расположение для перечисления уже отправленных блоков этой сущности при отправке набора данных с помощью блоков. Дополнительные сведения см. в разделе операция "Datasets_GetBlocks".
uploadBlocks	string (uri)	Расположение для отправки блоков при отправке набора данных с помощью блоков. Дополнительные сведения см. в разделе Операция "Datasets_UploadBlock".

DatasetProperties

Object

DatasetProperties

Имя	Тип	Описание
acceptedLineCount	integer (int32)	Количество строк, принятых для этого набора данных.
duration	string	Общая продолжительность наборов данных, если они содержат звуковые файлы. Длительность закодирована в формате ISO 8601 duration ("PnYnMnDTnHnMnS", см https://en.wikipedia.org/wiki/ISO_8601#Durations. ).
email	string	Адрес электронной почты для отправки Уведомления по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error	EntityError	EntityError
rejectedLineCount	integer (int32)	Число отклоненных строк для этого набора данных.
textNormalizationKind	TextNormalizationKind	TextNormalizationKind Тип нормализации текста.

DetailedErrorCode

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

DetailedErrorCode

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

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

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

Error

Object

Ошибка

Имя	Тип	Описание
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	Представляет код ошибки конфликта.
Forbidden	Представляет код запрещенной ошибки.
InternalCommunicationFailed	Представляет код ошибки сбоя внутреннего взаимодействия.
InternalServerError	Представляет код ошибки внутреннего сервера.
InvalidArgument	Представляет код ошибки недопустимого аргумента.
InvalidRequest	Представляет недопустимый код ошибки запроса.
NotAllowed	Представляет недопустимый код ошибки.
NotFound	Представляет код ошибки "Не найден".
PipelineError	Представляет код ошибки конвейера.
ServiceUnavailable	Представляет код ошибки недоступности службы.
TooManyRequests	Представляет код ошибки слишком большого количества запросов.
Unauthorized	Представляет код неавторизованной ошибки.
UnprocessableEntity	Представляет код ошибки необработаемой сущности.
UnsupportedMediaType	Представляет код ошибки типа неподдерживаемого носителя.

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, сообщение и необязательные свойства target, подробности (пара значений ключа), внутреннюю ошибку (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

Status

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

Состояние

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

TextNormalizationKind

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

TextNormalizationKind

Значение	Описание
Default	Нормализация текста по умолчанию (например, "от 2 до 3" заменяется на "два к трем" в en-US).
None	Нормализация текста не будет применена к входным текстам. Это параметр переопределения, который следует использовать только при нормализации текста перед отправкой.

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

Datasets - Get

Параметры URI

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Get a dataset

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

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

Определения

Dataset

DatasetKind

DatasetLinks

DatasetProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

TextNormalizationKind

Дополнительные ресурсы