Datasets - Create

  • Ссылка
Служба:
Azure AI Services
Версия API:
v3.2-preview.2

Отправляет и создает новый набор данных, получая данные по указанному URL-адресу, или начинает ожидать отправки блоков данных.

POST {endpoint}/speechtotext/v3.2-preview.2/datasets

Параметры URI

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

string

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

Текст запроса

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

string

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

DatasetKind

DatasetKind
Тип импорта данных.
locale True

string

Языковой стандарт содержащихся данных.
contentUrl

string

URL-адрес данных для набора данных.
customProperties

object

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

string

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

EntityReference

EntityReference
properties

DatasetProperties

DatasetProperties

Ответы

Имя Тип Описание
201 Created

Dataset

Ответ содержит сведения о сущности в качестве полезных данных и ее расположении в качестве заголовка.

Заголовки

Location: string
Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Create a dataset with content url
Create dataset from data blocks

Create a dataset with content url

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

POST {endpoint}/speechtotext/v3.2-preview.2/datasets

{
  "kind": "Acoustic",
  "contentUrl": "https://contoso.com/location",
  "locale": "en-US",
  "displayName": "My speech dataset name",
  "description": "My speech dataset description"
}

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

Код состояния:
201 
Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1
{
  "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"
}

Create dataset from data blocks

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

POST {endpoint}/speechtotext/v3.2-preview.2/datasets

{
  "kind": "Acoustic",
  "locale": "en-US",
  "displayName": "My speech dataset name",
  "description": "My speech dataset description"
}

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

Код состояния:
201 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
  "kind": "Acoustic",
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files",
    "commitBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks:commit",
    "listBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks",
    "uploadBlocks": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/blocks"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "NotStarted",
  "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

Dataset

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

string

URL-адрес данных для набора данных.
createdDateTime

string

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

object

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

string

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

string

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

DatasetKind

DatasetKind
Тип импорта данных.
lastActionDateTime

string

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

DatasetLinks

DatasetLinks
locale

string

Языковой стандарт содержащихся данных.
project

EntityReference

EntityReference
properties

DatasetProperties

DatasetProperties
self

string

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

Status

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

DatasetKind

DatasetKind

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

string

Набор акустических данных.
AudioFiles

string

Набор данных звуковых файлов.
Language

string

Набор языковых данных.
LanguageMarkdown

string

Языковой набор данных Markdown.
OutputFormatting

string

Набор данных, который содержит правила для настройки обратной нормализации текста, прописных букв, переформатирования, ненормативной лексики, а также определяет тесты для проверки набора данных
Pronunciation

string

Набор данных произношения.

DatasetLinks

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

string

Расположение для фиксации списка блоков при отправке набора данных с помощью блоков. Дополнительные сведения см. в разделе операция "Datasets_CommitBlocks".
files

string

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

string

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

string

Расположение для отправки блоков при отправке набора данных с помощью блоков. Дополнительные сведения см. в разделе операция "Datasets_UploadBlock".

DatasetProperties

DatasetProperties

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

integer

Количество строк, принятых для этого набора данных.
duration

string

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

string

Адрес электронной почты для отправки Уведомления по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error

EntityError

EntityError
rejectedLineCount

integer

Число отклоненных строк для этого набора данных.
textNormalizationKind

TextNormalizationKind

TextNormalizationKind
Тип нормализации текста.

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

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

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

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

Status

Состояние

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

string

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

string

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

string

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

string

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

TextNormalizationKind

TextNormalizationKind

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

string

Нормализация текста по умолчанию (например, "2–3" заменяется на "два к трем" в en-US).
None

string

Нормализация текста не применяется к входным текстом. Это параметр переопределения, который следует использовать только при нормализации текста перед отправкой.