Snapshot - Take

Служба:

Azure AI Services

Версия API:

1.0-preview

Отправьте операцию для получения snapshot списка лиц, большого списка лиц, группы пользователей или большой группы пользователей с указанным пользователем типом snapshot, идентификатором исходного объекта, применением область и необязательными пользовательскими данными.
Интерфейсы snapshot предназначены для резервного копирования и восстановления данных о лицах из одной подписки на лица в другую, внутри одного региона или между регионами. Рабочий процесс состоит из двух этапов: сначала пользователь вызывает Snapshot — Take, чтобы создать копию исходного объекта и сохранить ее как snapshot, а затем вызывает Snapshot — Apply, чтобы вставить snapshot в целевую подписку. Моментальные снимки хранятся в централизованном расположении (для каждого экземпляра Azure), поэтому их можно применять между учетными записями и регионами.
Прием snapshot является асинхронной операцией. Идентификатор операции можно получить из поля Operation-Location в заголовке ответа, который будет использоваться в OperationStatus — Get для отслеживания хода создания snapshot. Идентификатор snapshot будет включен в поле resourceLocation в OperationStatus — Получение ответа, когда операция имеет состояние "Успешно".
Время создания моментального снимка зависит от количества записей пользователей и лиц в исходном объекте. Это может быть за считанные секунды или до нескольких часов для 1 000 000 человек с несколькими лицами.
Срок действия моментальных снимков автоматически истекает и очищается через 48 часов после их создания с помощью snapshot - Take. Пользователь может удалить snapshot с помощью функции Моментальный снимок — удаление самостоятельно в любое время до истечения срока действия.
Если snapshot для определенного объекта, другие операции с объектом не блокируются. Все операции только для чтения (Get/List и Identify/FindSimilar/Verify) могут выполняться в обычном режиме. Для всех операций, доступных для записи, включая добавление, обновление и удаление исходного объекта или его лиц и обучение, они не блокируются, но не рекомендуются, так как доступные для записи обновления могут не отражаться на snapshot во время его выполнения. После завершения snapshot выполнения все операции, доступные для чтения и записи, могут работать в обычном режиме. Моментальный снимок также будет включать результаты обучения исходного объекта. Это означает, что целевая подписка, к которой применяется snapshot, не требует повторного обучения целевого объекта перед вызовом Identify/FindSimilar.

• Квота подписки бесплатного уровня: 100 операций в месяц.
• Квота на подписку уровня S0: 100 операций в день.

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

Параметры URI

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

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

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

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

Имя	Обязательно	Тип	Описание
applyScope	True	string[]	Заданный пользователем массив идентификаторов целевых подписок на распознавание лиц для snapshot. Для каждого snapshot могут применяться только подписки, включенные в applyScope of Snapshot — Take.
objectId	True	string	Пользователь указал идентификатор исходного объекта для получения snapshot.
type	True	SnapshotObjectType	Указанный пользователем тип исходного объекта, из snapshot. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup.
userData		string	Указанные пользователем данные о snapshot для любых целей. Длина не должна превышать 16 КБ.

Ответы

Имя	Тип	Описание
202 Accepted		Задача snapshot принятия успешно поставлена в очередь. Заголовки Operation-Location: string
Other Status Codes	APIError	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Take a snapshot example

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

HTTP

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


{
  "type": "FaceList",
  "objectId": "source-face-list-id",
  "applyScope": [
    "35230F59-AA9C-45E0-AB5E-C859BF1A5429",
    "64084E07-9B7F-4A98-BEA4-9986D3A1EDEB"
  ],
  "userData": "User-provided data attached to the snapshot."
}

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

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

202

Определения

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

APIError

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

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

Error

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

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

SnapshotObjectType

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

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

TakeSnapshotRequest

Текст запроса для выполнения операции snapshot.

Имя	Тип	Описание
applyScope	string[]	Заданный пользователем массив идентификаторов целевых подписок на распознавание лиц для snapshot. Для каждого snapshot могут применяться только подписки, включенные в applyScope of Snapshot — Take.
objectId	string	Пользователь указал идентификатор исходного объекта для получения snapshot.
type	SnapshotObjectType	Указанный пользователем тип исходного объекта, из snapshot. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup.
userData	string	Указанные пользователем данные о snapshot для любых целей. Длина не должна превышать 16 КБ.