PersonGroupPersonOperations Класс

Операции PersonGroupPersonOperations.

Не следует создавать экземпляр этого класса напрямую, а создать экземпляр Client, который создаст его для вас и прикрепит его к атрибуту.

Наследование
builtins.object
PersonGroupPersonOperations

Конструктор

PersonGroupPersonOperations(client, config, serializer, deserializer)

Параметры

Имя Описание
client
Обязательно

Клиент для запросов на обслуживание.

config
Обязательно

Настройка клиента службы.

serializer
Обязательно

Сериализатор объектной модели.

deserializer
Обязательно

Десериализатор объектной модели.

Методы

add_face_from_stream

Добавление лица к человеку в группу пользователей для идентификации или проверки лица. Чтобы иметь дело с изображением, содержащим несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает значение persistedFaceId, представляющее добавленное лицо. Образ не будет сохранен. Только извлеченная функция распознавания лиц будет храниться на сервере до тех пор, пока не будет вызван метод PersonGroup PersonFace — Delete, PersonGroup Person — Delete или PersonGroup — Delete .
Примечание. PersistedFaceId отличается от faceId, созданного [Face

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).

  • Более высокое качество изображения лица означает лучшую точность распознавания. Пожалуйста, рассмотрите высококачественные лица: фронтальные, четкие и размер лица 200 x 200 пикселей (100 пикселей между глазами) или больше.
  • Каждая запись может содержать до 248 лиц.
  • Поддерживаются JPEG, PNG, GIF (первый кадр) и формат BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одну грань. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из face — Detect, нет никакой гарантии для успешного обнаружения и добавления лица.
  • Если определить размер лица (36x36–4096 x 4096 пикселей), большой размер головы или большие окклюзии вызовут сбои.
  • Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.
  • Минимальный размер обнаруживаемого лица составляет 36 x 36 пикселей на изображении, не превышающем 1920 x 1080 пикселей. Изображениям с размерами выше 1920 x 1080 пикселей потребуется пропорционально больший минимальный размер лица.
  • Можно указать различные значения detectionModel. Сведения об использовании и сравнении различных моделей обнаружения см. в статье Определение модели обнаружения.
add_face_from_url

Добавление лица к человеку в группу пользователей для идентификации или проверки лица. Чтобы иметь дело с изображением, содержащим несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает значение persistedFaceId, представляющее добавленное лицо. Образ не будет сохранен. Только извлеченная функция распознавания лиц будет храниться на сервере до тех пор, пока не будет вызван метод PersonGroup PersonFace — Delete, PersonGroup Person — Delete или PersonGroup — Delete .
Примечание. PersistedFaceId отличается от faceId, созданного [Face

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).

  • Более высокое качество изображения лица означает лучшую точность распознавания. Пожалуйста, рассмотрите высококачественные лица: фронтальные, четкие и размер лица 200 x 200 пикселей (100 пикселей между глазами) или больше.
  • Каждая запись может содержать до 248 лиц.
  • Поддерживаются JPEG, PNG, GIF (первый кадр) и формат BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одну грань. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из face — Detect, нет никакой гарантии для успешного обнаружения и добавления лица.
  • Если определить размер лица (36x36–4096 x 4096 пикселей), большой размер головы или большие окклюзии вызовут сбои.
  • Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.
  • Минимальный размер обнаруживаемого лица составляет 36 x 36 пикселей на изображении, не превышающем 1920 x 1080 пикселей. Изображениям с размерами выше 1920 x 1080 пикселей потребуется пропорционально больший минимальный размер лица.
  • Можно указать различные значения detectionModel. Сведения об использовании и сравнении различных моделей обнаружения см. в статье Определение модели обнаружения.
create

Создание нового пользователя в указанной группе пользователей.

delete

Удаление существующего пользователя из группы пользователей. Функции persistedFaceId, userData, person name и face в записи person будут удалены.

delete_face

Удаление лица из группы пользователей с помощью указанных personGroupId, personId и persistedFaceId.
Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.

get

Получение сведений о человеке, включая зарегистрированные сохраненные лица, имя и userData.

get_face

Получение сведений о сохраняемом лице (определяется параметром persistedFaceId, personId и принадлежащим ей personGroupId).

list

Вывод списка всех пользователей в группе пользователей и получение сведений о пользователях (включая personId, name, userData и persistedFaceIds зарегистрированных лиц пользователя).

update

Обновление имени или userData пользователя.

update_face

Добавление лица к человеку в группу пользователей для идентификации или проверки лица. Чтобы иметь дело с изображением, содержащим несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает значение persistedFaceId, представляющее добавленное лицо. Образ не будет сохранен. Только извлеченная функция распознавания лиц будет храниться на сервере до тех пор, пока не будет вызван метод PersonGroup PersonFace — Delete, PersonGroup Person — Delete или PersonGroup — Delete .
Примечание. PersistedFaceId отличается от faceId, созданного [Face

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).

  • Более высокое качество изображения лица означает лучшую точность распознавания. Пожалуйста, рассмотрите высококачественные лица: фронтальные, четкие и размер лица 200 x 200 пикселей (100 пикселей между глазами) или больше.
  • Каждая запись может содержать до 248 лиц.
  • Поддерживаются JPEG, PNG, GIF (первый кадр) и формат BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одну грань. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из face — Detect, нет никакой гарантии для успешного обнаружения и добавления лица.
  • Если определить размер лица (36x36–4096 x 4096 пикселей), большой размер головы или большие окклюзии вызовут сбои.
  • Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.

add_face_from_stream

Добавление лица к человеку в группу пользователей для идентификации или проверки лица. Чтобы иметь дело с изображением, содержащим несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает значение persistedFaceId, представляющее добавленное лицо. Образ не будет сохранен. Только извлеченная функция распознавания лиц будет храниться на сервере до тех пор, пока не будет вызван метод PersonGroup PersonFace — Delete, PersonGroup Person — Delete или PersonGroup — Delete .
Примечание. PersistedFaceId отличается от faceId, созданного [Face

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).

  • Более высокое качество изображения лица означает лучшую точность распознавания. Пожалуйста, рассмотрите высококачественные лица: фронтальные, четкие и размер лица 200 x 200 пикселей (100 пикселей между глазами) или больше.
  • Каждая запись может содержать до 248 лиц.
  • Поддерживаются JPEG, PNG, GIF (первый кадр) и формат BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одну грань. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из face — Detect, нет никакой гарантии для успешного обнаружения и добавления лица.
  • Если определить размер лица (36x36–4096 x 4096 пикселей), большой размер головы или большие окклюзии вызовут сбои.
  • Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.
  • Минимальный размер обнаруживаемого лица составляет 36 x 36 пикселей на изображении, не превышающем 1920 x 1080 пикселей. Изображениям с размерами выше 1920 x 1080 пикселей потребуется пропорционально больший минимальный размер лица.
  • Можно указать различные значения detectionModel. Сведения об использовании и сравнении различных моделей обнаружения см. в статье Определение модели обнаружения.
add_face_from_stream(person_group_id, person_id, image, user_data=None, target_face=None, detection_model='detection_01', custom_headers=None, raw=False, callback=None, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

image
Обязательно

Поток изображения.

user_data
str

Пользовательские данные о лице для любых целей. Максимальная длина составляет 1 КБ.

значение по умолчанию: None
target_face

Прямоугольник лица, указывающий целевое лицо, добавляемое к человеку в формате "targetFace=left,top,width,height". Например, "targetFace=10,10,100,100". Если на изображении несколько лиц, необходимо указать, какое лицо следует добавить, требуется targetFace. Нет targetFace означает, что во всем изображении обнаружено только одно лицо.

значение по умолчанию: None
detection_model

Имя модели обнаружения. Модель обнаружения используется для обнаружения лиц на отправленном изображении. Имя модели обнаружения можно указать при выполнении функции Распознавание лиц — обнаружение или (большой)Список лиц — добавление лица или (большой)PersonGroup — добавление лица. Значение по умолчанию — "detection_01". Если требуется другая модель, укажите ее явным образом. Возможные значения: "detection_01", "detection_02", "detection_03".

значение по умолчанию: detection_01
custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
callback
Callable[<xref:Bytes>, <xref:response=None>]

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

значение по умолчанию: None
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
<xref:msrest.pipeline.ClientRawResponse>

PersistedFace или ClientRawResponse, если raw=true

Исключения

Тип Описание

add_face_from_url

Добавление лица к человеку в группу пользователей для идентификации или проверки лица. Чтобы иметь дело с изображением, содержащим несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает значение persistedFaceId, представляющее добавленное лицо. Образ не будет сохранен. Только извлеченная функция распознавания лиц будет храниться на сервере до тех пор, пока не будет вызван метод PersonGroup PersonFace — Delete, PersonGroup Person — Delete или PersonGroup — Delete .
Примечание. PersistedFaceId отличается от faceId, созданного [Face

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).

  • Более высокое качество изображения лица означает лучшую точность распознавания. Пожалуйста, рассмотрите высококачественные лица: фронтальные, четкие и размер лица 200 x 200 пикселей (100 пикселей между глазами) или больше.
  • Каждая запись может содержать до 248 лиц.
  • Поддерживаются JPEG, PNG, GIF (первый кадр) и формат BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одну грань. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из face — Detect, нет никакой гарантии для успешного обнаружения и добавления лица.
  • Если определить размер лица (36x36–4096 x 4096 пикселей), большой размер головы или большие окклюзии вызовут сбои.
  • Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.
  • Минимальный размер обнаруживаемого лица составляет 36 x 36 пикселей на изображении, не превышающем 1920 x 1080 пикселей. Изображениям с размерами выше 1920 x 1080 пикселей потребуется пропорционально больший минимальный размер лица.
  • Можно указать различные значения detectionModel. Сведения об использовании и сравнении различных моделей обнаружения см. в статье Определение модели обнаружения.
add_face_from_url(person_group_id, person_id, url, user_data=None, target_face=None, detection_model='detection_01', custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

url
Обязательно
str

Общедоступный URL-адрес изображения

user_data
str

Пользовательские данные о лице для любых целей. Максимальная длина составляет 1 КБ.

значение по умолчанию: None
target_face

Прямоугольник лица, указывающий целевое лицо, добавляемое к человеку в формате "targetFace=left,top,width,height". Например, "targetFace=10,10,100,100". Если на изображении несколько лиц, необходимо указать, какое лицо следует добавить, требуется targetFace. Нет targetFace означает, что во всем изображении обнаружено только одно лицо.

значение по умолчанию: None
detection_model

Имя модели обнаружения. Модель обнаружения используется для обнаружения лиц на отправленном изображении. Имя модели обнаружения можно указать при выполнении функции Распознавание лиц — обнаружение или (большой)Список лиц — добавление лица или (большой)PersonGroup — добавление лица. Значение по умолчанию — "detection_01". Если требуется другая модель, укажите ее явным образом. Возможные значения: "detection_01", "detection_02", "detection_03".

значение по умолчанию: detection_01
custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
<xref:msrest.pipeline.ClientRawResponse>

PersistedFace или ClientRawResponse, если raw=true

Исключения

Тип Описание

create

Создание нового пользователя в указанной группе пользователей.

create(person_group_id, name=None, user_data=None, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

name
str

Определяемое пользователем имя, максимальная длина составляет 128.

значение по умолчанию: None
user_data
str

Данные, указанные пользователем. Длина не должна превышать 16 КБ.

значение по умолчанию: None
custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
<xref:msrest.pipeline.ClientRawResponse>

Person или ClientRawResponse, если raw=true

Исключения

Тип Описание

delete

Удаление существующего пользователя из группы пользователей. Функции persistedFaceId, userData, person name и face в записи person будут удалены.

delete(person_group_id, person_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание

delete_face

Удаление лица из группы пользователей с помощью указанных personGroupId, personId и persistedFaceId.
Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.

delete_face(person_group_id, person_id, persisted_face_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

persisted_face_id
Обязательно
str

Идентификатор, ссылающийся на конкретный persistedFaceId существующего лица.

custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание

get

Получение сведений о человеке, включая зарегистрированные сохраненные лица, имя и userData.

get(person_group_id, person_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
<xref:msrest.pipeline.ClientRawResponse>

Person или ClientRawResponse, если raw=true

Исключения

Тип Описание

get_face

Получение сведений о сохраняемом лице (определяется параметром persistedFaceId, personId и принадлежащим ей personGroupId).

get_face(person_group_id, person_id, persisted_face_id, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

persisted_face_id
Обязательно
str

Идентификатор, ссылающийся на конкретный persistedFaceId существующего лица.

custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
<xref:msrest.pipeline.ClientRawResponse>

PersistedFace или ClientRawResponse, если raw=true

Исключения

Тип Описание

list

Вывод списка всех пользователей в группе пользователей и получение сведений о пользователях (включая personId, name, userData и persistedFaceIds зарегистрированных лиц пользователя).

list(person_group_id, start=None, top=None, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

start
str

Начальный идентификатор возвращаемого пользователя (используется для перечисления диапазона пользователей).

значение по умолчанию: None
top
int

Число возвращаемых пользователей, начиная с идентификатора пользователя, указанного параметром start.

значение по умолчанию: None
custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
<xref:msrest.pipeline.ClientRawResponse>

list или ClientRawResponse, если raw=true

Исключения

Тип Описание

update

Обновление имени или userData пользователя.

update(person_group_id, person_id, name=None, user_data=None, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

name
str

Определяемое пользователем имя, максимальная длина составляет 128.

значение по умолчанию: None
user_data
str

Данные, указанные пользователем. Длина не должна превышать 16 КБ.

значение по умолчанию: None
custom_headers

заголовки, которые будут добавлены в запрос

значение по умолчанию: None
raw

возвращает прямой ответ вместе с десериализованным ответом

значение по умолчанию: False
operation_config
Обязательно

Переопределения конфигурации операций.

Возвращаемое значение

Тип Описание
None,
<xref:msrest.pipeline.ClientRawResponse>

None или ClientRawResponse, если raw=true

Исключения

Тип Описание

update_face

Добавление лица к человеку в группу пользователей для идентификации или проверки лица. Чтобы иметь дело с изображением, содержащим несколько лиц, входное лицо можно указать как изображение с прямоугольником targetFace. Он возвращает значение persistedFaceId, представляющее добавленное лицо. Образ не будет сохранен. Только извлеченная функция распознавания лиц будет храниться на сервере до тех пор, пока не будет вызван метод PersonGroup PersonFace — Delete, PersonGroup Person — Delete или PersonGroup — Delete .
Примечание. PersistedFaceId отличается от faceId, созданного [Face

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl).

  • Более высокое качество изображения лица означает лучшую точность распознавания. Пожалуйста, рассмотрите высококачественные лица: фронтальные, четкие и размер лица 200 x 200 пикселей (100 пикселей между глазами) или больше.
  • Каждая запись может содержать до 248 лиц.
  • Поддерживаются JPEG, PNG, GIF (первый кадр) и формат BMP. Допустимый размер файла изображения составляет от 1 КБ до 6 МБ.
  • Прямоугольник targetFace должен содержать одну грань. Ноль или несколько лиц будут рассматриваться как ошибка. Если предоставленный прямоугольник targetFace не возвращается из face — Detect, нет никакой гарантии для успешного обнаружения и добавления лица.
  • Если определить размер лица (36x36–4096 x 4096 пикселей), большой размер головы или большие окклюзии вызовут сбои.
  • Добавление и удаление лиц для одного и того же человека будет обрабатываться последовательно. Добавление и удаление лиц для разных пользователей и их удаления обрабатываются параллельно.
update_face(person_group_id, person_id, persisted_face_id, user_data=None, custom_headers=None, raw=False, **operation_config)

Параметры

Имя Описание
person_group_id
Обязательно
str

Идентификатор, ссылающийся на определенную группу пользователей.

person_id
Обязательно
str

Идентификатор, ссылающийся на определенного человека.

persisted_face_id
Обязательно
str

Идентификатор, ссылающийся на конкретный persistedFaceId существующего лица.

user_data
str

Предоставленные пользователем данные, прикрепленные к лицу. Ограничение на размер составляет 1 КБ.

значение по умолчанию: 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'>