SnapshotOperations Класс
Операции SnapshotOperations.
Не следует создавать экземпляр этого класса напрямую, а создавать экземпляр клиента, который создаст его автоматически и вложит в качестве атрибута.
- Наследование
-
builtins.objectSnapshotOperations
Конструктор
SnapshotOperations(client, config, serializer, deserializer)Параметры
| Имя | Описание |
|---|---|
|
client
Обязательно
|
Клиент для запросов на обслуживание. |
|
config
Обязательно
|
Настройка клиента службы. |
|
serializer
Обязательно
|
Сериализатор объектной модели. |
|
deserializer
Обязательно
|
Десериализатор объектной модели. |
Методы
| apply |
Отправьте операцию для применения моментального снимка к текущей подписке. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
|
| delete |
Удалите существующий моментальный снимок в соответствии с snapshotId. Все данные объектов и сведения в моментальном снимке также будут удалены. Удалить моментальный снимок может только исходная подписка, которая сделала моментальный снимок. Если пользователь не удаляет моментальный снимок с помощью этого API, моментальный снимок будет по-прежнему автоматически удален через 48 часов после создания. |
| get |
Получение сведений о моментальном снимке. Моментальный снимок доступен только для исходной подписки, которая его взяла, и целевых подписок, включенных в applyScope в snapshot — Take. |
| get_operation_status |
Получение состояния операции создания и применения моментального снимка. |
| list |
Список всех доступных моментальных снимков со связанными сведениями, включая моментальные снимки, сделанные пользователем, или моментальные снимки, которые будут применены к пользователю (идентификатор подписки был включен в applyScope в snapshot — Take). |
| take |
Отправьте операцию для создания моментального снимка списка лиц, большого списка лиц, группы пользователей или большой группы пользователей с указанным пользователем типом моментального снимка, идентификатором исходного объекта, областью применения и необязательными пользовательскими данными.
|
| update |
Обновление сведений о моментальном снимке. Только исходная подписка, которая сделала моментальный снимок, может обновить моментальный снимок. |
apply
Отправьте операцию для применения моментального снимка к текущей подписке. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take.
Интерфейсы моментальных снимков предназначены для резервного копирования и восстановления данных о лицах из одной подписки на лица в другую, в том же регионе или между регионами. Рабочий процесс состоит из двух этапов: пользователь сначала вызывает Snapshot - Take, чтобы создать копию исходного объекта и сохранить ее в виде моментального снимка, а затем вызывает Snapshot - Apply, чтобы вставить моментальный снимок в целевую подписку. Моментальные снимки хранятся в централизованном расположении (для каждого экземпляра Azure), поэтому их можно применять между учетными записями и регионами.
Применение моментального снимка является асинхронной операцией. Идентификатор операции можно получить из поля Operation-Location в заголовке ответа, который будет использоваться в OperationStatus — Get для отслеживания хода применения моментального снимка. Идентификатор целевого объекта будет включен в поле "resourceLocation" в OperationStatus — получение ответа, когда операция имеет состояние "успешно".
Время применения моментального снимка зависит от количества записей пользователя и лица в объекте моментального снимка. Это может быть за секунды или до 1 часа для 1 000 000 человек с несколькими лицами.
Срок действия моментальных снимков автоматически истекает и очищается через 48 часов после их создания с помощью snapshot - Take. Таким образом, целевая подписка требуется для применения моментального снимка через 48 часов с момента его создания.
Применение моментального снимка не блокирует другие операции с целевым объектом, однако это не рекомендуется, так как правильность не может быть гарантирована во время применения моментального снимка. После завершения применения моментального снимка все операции с целевым объектом могут работать в обычном режиме. Моментальный снимок также включает результаты обучения исходного объекта. Это означает, что целевая подписка, к которой применен моментальный снимок, не требует повторного обучения целевого объекта перед вызовом Identify/FindSimilar.
Один моментальный снимок можно применить несколько раз параллельно, в то время как в настоящее время поддерживается только СозданиеНовый режим применения, что означает, что операция применения завершится ошибкой, если целевая подписка уже содержит объект того же типа и использует тот же objectId. Пользователи могут указать objectId в тексте запроса, чтобы избежать таких конфликтов.
- Квота подписки бесплатного уровня: 100 операций в месяц.
- Квота на подписку S0 уровней: 100 операций применения в день.
apply(snapshot_id, object_id, mode='CreateNew', custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
snapshot_id
Обязательно
|
Идентификатор, ссылающийся на определенный моментальный снимок. |
|
object_id
Обязательно
|
Пользователь указал идентификатор целевого объекта, который будет создан из моментального снимка. |
|
mode
|
str или
SnapshotApplyMode
Режим применения моментального снимка. В настоящее время поддерживается только CreateNew, что означает, что операция применения завершится ошибкой, если целевая подписка уже содержит объект того же типа и использует тот же objectId. Пользователи могут указать objectId в тексте запроса, чтобы избежать таких конфликтов. Возможные значения: CreateNew значение по умолчанию: CreateNew
|
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
delete
Удалите существующий моментальный снимок в соответствии с snapshotId. Все данные объектов и сведения в моментальном снимке также будут удалены. Удалить моментальный снимок может только исходная подписка, которая сделала моментальный снимок. Если пользователь не удаляет моментальный снимок с помощью этого API, моментальный снимок будет по-прежнему автоматически удален через 48 часов после создания.
delete(snapshot_id, custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
snapshot_id
Обязательно
|
Идентификатор, ссылающийся на определенный моментальный снимок. |
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
get
Получение сведений о моментальном снимке. Моментальный снимок доступен только для исходной подписки, которая его взяла, и целевых подписок, включенных в applyScope в snapshot — Take.
get(snapshot_id, custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
snapshot_id
Обязательно
|
Идентификатор, ссылающийся на определенный моментальный снимок. |
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
Snapshot или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
get_operation_status
Получение состояния операции создания и применения моментального снимка.
get_operation_status(operation_id, custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
operation_id
Обязательно
|
Идентификатор, ссылающийся на конкретную операцию создания и применения моментального снимка. |
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
OperationStatus или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
list
Список всех доступных моментальных снимков со связанными сведениями, включая моментальные снимки, сделанные пользователем, или моментальные снимки, которые будут применены к пользователю (идентификатор подписки был включен в applyScope в snapshot — Take).
list(type=None, apply_scope=None, custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
type
|
Пользователь указал тип объекта в качестве фильтра поиска. Возможные значения: "FaceList", "LargeFaceList", "LargePersonGroup", "PersonGroup". значение по умолчанию: None
|
|
apply_scope
|
Указанный пользователем моментальный снимок применяет области в качестве фильтра поиска. ApplyScope — это массив идентификаторов целевых подписок Azure для моментального снимка, заданный пользователем, создавшим моментальный снимок, с помощью функции Snapshot — Take. значение по умолчанию: None
|
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
<xref:msrest.pipeline.ClientRawResponse>
|
list или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
take
Отправьте операцию для создания моментального снимка списка лиц, большого списка лиц, группы пользователей или большой группы пользователей с указанным пользователем типом моментального снимка, идентификатором исходного объекта, областью применения и необязательными пользовательскими данными.
Интерфейсы моментальных снимков предназначены для резервного копирования и восстановления данных о лицах из одной подписки на лица в другую, в том же регионе или между регионами. Рабочий процесс состоит из двух этапов: пользователь сначала вызывает Snapshot - Take, чтобы создать копию исходного объекта и сохранить ее в виде моментального снимка, а затем вызывает Snapshot - Apply, чтобы вставить моментальный снимок в целевую подписку. Моментальные снимки хранятся в централизованном расположении (для каждого экземпляра Azure), поэтому их можно применять между учетными записями и регионами.
Создание моментального снимка является асинхронной операцией. Идентификатор операции можно получить из поля Operation-Location в заголовке ответа, который будет использоваться в OperationStatus — Get для отслеживания хода создания моментального снимка. Идентификатор моментального снимка будет включен в поле resourceLocation в OperationStatus — получение ответа, когда операция находится в состоянии "успешно".
Время создания моментального снимка зависит от количества записей пользователей и лиц в исходном объекте. Это может быть за считанные секунды или до нескольких часов для 1 000 000 человек с несколькими лицами.
Срок действия моментальных снимков автоматически истекает и очищается через 48 часов после их создания с помощью snapshot - Take. Пользователь может удалить моментальный снимок с помощью функции Моментальный снимок — удалить самостоятельно в любое время до истечения срока действия.
Создание моментального снимка для определенного объекта не блокирует другие операции с объектом. Все операции только для чтения (Get/List и Identify/FindSimilar/Verify) могут выполняться в обычном режиме. Для всех доступных для записи операций, включая добавление, обновление и удаление исходного объекта или его лиц и обучение, они не блокируются, но не рекомендуются, так как доступные для записи обновления могут не отражаться на моментальном снимке во время его создания. После создания моментального снимка все операции, доступные для чтения и записи, могут работать в обычном режиме. Моментальный снимок также будет включать результаты обучения исходного объекта. Это означает, что целевая подписка, к которой применяется моментальный снимок, не требует повторного обучения целевого объекта перед вызовом Identify/FindSimilar.
- Квота подписки бесплатного уровня: 100 операций в месяц.
- Квота на подписку уровня S0: 100 операций в день.
take(type, object_id, apply_scope, user_data=None, custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
type
Обязательно
|
Тип, заданный пользователем для исходного объекта, из который будет выполняться создание моментального снимка. В настоящее время поддерживаются FaceList, PersonGroup, LargeFaceList и LargePersonGroup. Возможные значения: "FaceList", "LargeFaceList", "LargePersonGroup", "PersonGroup". |
|
object_id
Обязательно
|
Пользователь указал идентификатор исходного объекта для создания моментального снимка. |
|
apply_scope
Обязательно
|
Заданный пользователем массив целевых подписок на распознавание лиц для моментального снимка. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take. |
|
user_data
|
Пользователь указал данные о моментальном снимке для любой цели. Длина не должна превышать 16 КБ. значение по умолчанию: None
|
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
update
Обновление сведений о моментальном снимке. Только исходная подписка, которая сделала моментальный снимок, может обновить моментальный снимок.
update(snapshot_id, apply_scope=None, user_data=None, custom_headers=None, raw=False, **operation_config)Параметры
| Имя | Описание |
|---|---|
|
snapshot_id
Обязательно
|
Идентификатор, ссылающийся на определенный моментальный снимок. |
|
apply_scope
|
Массив идентификаторов целевой подписки распознавания лиц для моментального снимка, заданный пользователем, создавшим моментальный снимок при вызове Snapshot — Take. Для каждого моментального снимка могут применяться только подписки, включенные в applyScope of Snapshot — Take. значение по умолчанию: None
|
|
user_data
|
Пользователь указал данные о моментальном снимке для любой цели. Длина не должна превышать 16 КБ. значение по умолчанию: None
|
|
custom_headers
|
заголовки, которые будут добавлены в запрос значение по умолчанию: None
|
|
raw
|
возвращает прямой ответ вместе с десериализованным ответом. значение по умолчанию: False
|
|
operation_config
Обязательно
|
Переопределения конфигурации операций. |
Возвращаемое значение
| Тип | Описание |
|---|---|
|
None,
<xref:msrest.pipeline.ClientRawResponse>
|
None или ClientRawResponse, если raw=true |
Исключения
| Тип | Описание |
|---|---|
Атрибуты
models
models = <module 'azure.cognitiveservices.vision.face.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\vision\\face\\models\\__init__.py'>
Azure SDK for Python
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по