Snapshot - List

Ссылка

Служба:: Azure AI Services

Версия API:: 1.0-preview

Список всех доступных моментальных снимков со связанными сведениями, включая моментальные снимки, созданные пользователем, или моментальные снимки, которые будут применены к пользователю (идентификатор подписки был включен в applyScope в snapshot — Take).

GET {Endpoint}/face/v1.0-preview/snapshots

С использованием необязательных параметров:

GET {Endpoint}/face/v1.0-preview/snapshots?type={type}&applyScope={applyScope}

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus.api.cognitive.microsoft.com).
applyScope	query		string[]	Указанный пользователем snapshot применять области в качестве фильтра поиска. ApplyScope — это массив целевых идентификаторов подписок Azure для snapshot, заданный пользователем, создавшим snapshot с помощью snapshot — Take.
type	query		SnapshotObjectType	Пользователь указал тип объекта в качестве фильтра поиска.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	Snapshot[]	Успешный вызов возвращает массив моментальных снимков с snapshot сведениями.
Other Status Codes	APIError	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

List snapshots example

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

HTTP

GET {Endpoint}/face/v1.0-preview/snapshots?type=FaceList&applyScope=64084E07-9B7F-4A98-BEA4-9986D3A1EDEB

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

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

[
  {
    "id": "e58b3f08-1e8b-4165-81df-aa9858f233dc",
    "account": "/subscriptions/f9b96b36-1f5e-4021-8959-51527e26e6d3/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
    "type": "FaceList",
    "applyScope": [
      "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
      "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
    ],
    "userData": "User-provided data attached to the snapshot1.",
    "createdTime": "2018-12-25T11:41:02.2331413Z",
    "lastUpdateTime": "2018-12-25T11:51:27.8705696Z"
  },
  {
    "id": "a61e61e4-c3d1-4d33-8ae8-676e6104757d",
    "account": "/subscriptions/6622996e-0149-4b22-9703-4216dc948d52/resourceGroups/TestRG/providers/Microsoft.CognitiveServices/accounts/FaceTest01",
    "type": "FaceList",
    "applyScope": [
      "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
    ],
    "userData": "User-provided data attached to the snapshot2.",
    "createdTime": "2018-12-29T17:09:32.3298483Z",
    "lastUpdateTime": "2018-12-29T17:14:34.5645877Z"
  }
]

Определения

Имя	Описание
APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
Snapshot	Объект моментального снимка. API моментальных снимков переместит данные за пределы географического расположения, выбранного для ресурса, в западную часть США, Западную Европу и Юго-Восточную Азию.
SnapshotObjectType	Тип исходного объекта в snapshot, заданный подписчиком, создавшим snapshot при вызове Snapshot — Take. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup.

APIError

Сведения об ошибке, возвращаемые API

Имя	Тип	Описание
error	Error	Текст ошибки.

Error

Текст ошибки.

Имя	Тип	Описание
code	string
message	string

Snapshot

Объект моментального снимка. API моментальных снимков переместит данные за пределы географического расположения, выбранного для ресурса, в западную часть США, Западную Европу и Юго-Восточную Азию.

Имя	Тип	Описание
account	string	Идентификатор учетной записи распознавания лиц Azure Cognitive Service подписчика, создавшего snapshot by Snapshot — Take.
applyScope	string[]	Массив идентификаторов целевых подписок на распознавание лиц для snapshot, заданный пользователем, создавшим snapshot при вызове Snapshot — Take. Для каждого snapshot могут применяться только подписки, включенные в applyScope of Snapshot — Take.
createdTime	string	Объединенная строка даты и времени в формате UTC, описывающая время создания snapshot. Например, 2018-12-25T11:41:02.2331413Z.
id	string	Идентификатор моментального снимка.
lastUpdateTime	string	Объединенная строка даты и времени в формате UTC, описывающая время последнего создания или обновления snapshot моментальным снимком — обновлением. Например, 2018-12-25T11:51:27.8705696Z.
type	SnapshotObjectType	Тип исходного объекта в snapshot, заданный подписчиком, создавшим snapshot при вызове Snapshot — Take. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup.
userData	string	Указанные пользователем данные о snapshot для любых целей. Длина не должна превышать 16 КБ.

SnapshotObjectType

Тип исходного объекта в snapshot, заданный подписчиком, создавшим snapshot при вызове Snapshot — Take. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup.

Имя	Тип	Описание
FaceList	string
LargeFaceList	string
LargePersonGroup	string
PersonGroup	string

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