Datasets - Update

Ссылка

Служба:: Azure AI Services

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

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

PATCH {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)	Идентификатор набора данных.

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

Media Types: "application/json", "application/merge-patch+json"

Имя	Тип	Описание
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символов, максимальная допустимая длина — 256 символов, а число разрешенных записей — 10.
description	string	Описание объекта.
displayName	string	Имя объекта.
project	EntityReference	EntityReference

Ответы

Имя	Тип	Описание
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-адресу STS: ?scope=speechservicesmanagement

Тип: apiKey
В: header

Примеры

Update a dataset

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

HTTP

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

{
  "displayName": "Updated dataset name",
  "description": "Updated dataset description",
  "customProperties": {
    "key": "value"
  }
}

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

Код состояния:: 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	Набор данных
DatasetKind	DatasetKind
DatasetLinks	DatasetLinks
DatasetProperties	DatasetProperties
DatasetUpdate	DatasetUpdate
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Ошибка
ErrorCode	Код ошибки
InnerError	InnerError
Status	Состояние
TextNormalizationKind	TextNormalizationKind

Dataset

Object

Набор данных

Имя	Тип	Описание
contentUrl	string (uri)	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.
description	string	Описание объекта.
displayName	string minLength: 1	Отображаемое имя объекта.
kind	DatasetKind	DatasetKind Тип импорта данных.
lastActionDateTime	string (date-time)	Метка времени при вводе текущего состояния. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. 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 ("PnYnMnDTnHnMnS", см. https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	Адрес электронной почты для отправки уведомлений по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error	EntityError	EntityError
rejectedLineCount	integer (int32)	Количество строк, отклоненных для этого набора данных.
textNormalizationKind	TextNormalizationKind	TextNormalizationKind Тип нормализации текста.

DatasetUpdate

Object

DatasetUpdate

Имя	Тип	Описание
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символов, максимальная допустимая длина — 256 символов, а число разрешенных записей — 10.
description	string	Описание объекта.
displayName	string	Имя объекта.
project	EntityReference	EntityReference

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 с бомом.
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	Код ошибки Коды ошибок высокого уровня.
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

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

Код ошибки

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

Status

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

Состояние

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

TextNormalizationKind

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

TextNormalizationKind

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

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

Datasets - Update

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Update a dataset

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

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

Определения

Dataset

DatasetKind

DatasetLinks

DatasetProperties

DatasetUpdate

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

TextNormalizationKind

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