Datasets - Get

Служба:

Azure AI Services

Версия API:

2023-04-01-preview

Получение сведений о конкретном наборе данных.

Возвращенные коды состояния:

• 200: операция успешно завершена.
• 400: запрос был неправильно сформирован.
• 404: набор данных с указанным именем не найден.

GET /datasets/{name}?api-version=2023-04-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя получаемого набора данных. Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9._-]*$
api-version	query	True	string	Запрошенная версия API.

Ответы

Имя	Тип	Описание
200 OK	Dataset	Успех
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Примеры

Datasets_Get

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

HTTP

GET /datasets/my_dataset_name?api-version=2023-04-01-preview

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

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

200

{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "https://example.com/dataset.json"
  ],
  "name": "my_dataset_name",
  "createdDateTime": "2023-01-13T20:46:20.189Z",
  "updatedDateTime": "2023-01-13T20:46:20.189Z",
  "eTag": "kzktjgnqkjagdlkualdzikaseg"
}

Определения

Имя	Описание
AnnotationKind	Тип заметок, содержащихся в файлах заметок. Например, "ImageClassification", чтобы указать, что файл заметок содержит метки объектов для обучения или тестирования модели многоклассовой классификации изображений.
Dataset	Описывает набор данных, представляющий набор изображений и заметок, которые можно использовать для обучения или тестирования модели.
ErrorResponse	Ответ возвращается при возникновении ошибки.
ErrorResponseDetails	Сведения об ошибке.
ErrorResponseInnerError	Подробная ошибка.
StorageAuthenticationKind	Тип проверки подлинности хранилища.
StorageAuthenticationSettingsApiModel	Описывает параметры проверки подлинности хранилища.

AnnotationKind

Тип заметок, содержащихся в файлах заметок. Например, "ImageClassification", чтобы указать, что файл заметок содержит метки объектов для обучения или тестирования модели многоклассовой классификации изображений.

Имя	Тип	Описание
imageClassification	string
imageObjectDetection	string

Dataset

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

Имя	Тип	Описание
annotationFileUris	string[]	Список абсолютных универсальных кодов ресурса (URI) для файлов заметок, каждый из которых должен храниться в виде большого двоичного объекта в контейнере больших двоичных объектов службы хранилища Azure. Каждый файл должен соответствовать формату COCO для указанного AnnotationKind, при этом путь к каждому изображению является абсолютным URI для большого двоичного объекта в контейнере BLOB-объектов. Ресурс Компьютерного зрения должен иметь разрешение на чтение файлов заметок и всех файлов изображений, на которые ссылается ссылка. Это можно сделать, включив управляемые системой удостоверения для ресурса Компьютерного зрения, а затем назначив удостоверение роли, которая имеет разрешение на чтение из контейнера BLOB-объектов, содержащего файлы заметок и изображений.
annotationKind	AnnotationKind	Тип заметок, содержащихся в файлах заметок. Например, "ImageClassification", чтобы указать, что файл заметок содержит метки объектов для обучения или тестирования модели многоклассовой классификации изображений.
authentication	StorageAuthenticationSettingsApiModel	Описывает параметры проверки подлинности хранилища.
createdDateTime	string	Только для чтения. Дата и время первой регистрации набора данных в формате UTC.
customProperties	object	Словарь произвольных пар "ключ-значение" для использования приложением. Допускается не более 10 пар "ключ-значение".
eTag	string	Только для чтения. Последний ETag для набора данных. Может использоваться с заголовком If-Match при обновлении или удалении набора данных.
name	string	Только для чтения. Имя, используемое для уникальной идентификации набора данных.
updatedDateTime	string	Только для чтения. Дата и время последнего обновления набора данных в формате UTC.

ErrorResponse

Ответ возвращается при возникновении ошибки.

Имя	Тип	Описание
error	ErrorResponseDetails	Сведения об ошибке.

ErrorResponseDetails

Сведения об ошибке.

Имя	Тип	Описание
code	string	Код ошибки.
details	ErrorResponseDetails[]	Список подробных ошибок.
innererror	ErrorResponseInnerError	Подробная ошибка.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponseInnerError

Подробная ошибка.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	ErrorResponseInnerError	Подробная ошибка.
message	string	Сообщение об ошибке.

StorageAuthenticationKind

Тип проверки подлинности хранилища.

Имя	Тип	Описание
managedIdentity	string
none	string
sas	string

StorageAuthenticationSettingsApiModel

Описывает параметры проверки подлинности хранилища.

Имя	Тип	Описание
kind	StorageAuthenticationKind	Тип проверки подлинности хранилища.
sasToken	string	Необязательный элемент. Маркер SAS для доступа к контейнеру. Требуется только в том случае, если Kind = Sas.