PersonGroupOperations Класс

  • Ссылка

Операции PersonGroupOperations.

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

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

Конструктор

PersonGroupOperations(client, config, serializer, deserializer)

Параметры

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

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

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

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

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

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

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

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

Методы

create

Создайте группу пользователей с указанными personGroupId, именем, предоставленным пользователем userData и recognitionModel.
Группа пользователей — это контейнер отправленных данных о пользователях, включая функции распознавания лиц.
После создания используйте PersonGroup Person - Create , чтобы добавить пользователей в группу, а затем вызовите PersonGroup - Train , чтобы подготовить эту группу к распознаванию лиц - идентификации.
Образ не будет сохранен. На сервере будут храниться только извлеченные признаки лица и userData, пока не будет вызван метод PersonGroup Person — Delete или PersonGroup — Delete .
Для связи с этой группой пользователей следует указать "recognitionModel". Значение по умолчанию для "recognitionModel" — "recognition_01". Если требуется последняя модель, укажите необходимую модель в этом параметре. Новые лица, добавленные в существующую группу пользователей, будут использовать модель распознавания, уже связанную с коллекцией. Существующие функции распознавания лиц в группе пользователей нельзя обновить до функций, извлеченных другой версией модели распознавания. Квота группы пользователей:

  • Квота подписки уровня "Бесплатный": 1000 групп пользователей. Каждый из них содержит до 1000 человек.
  • Квота на подписку уровня S0: 1 000 000 групп пользователей. В каждом из них содержится до 10 000 человек.
  • Чтобы решить проблему с идентификацией лиц в большом масштабе, рассмотрите возможность использования LargePersonGroup.
delete

Удаление существующей группы пользователей. Сохраненные признаки лиц всех пользователей в группе пользователей также будут удалены.
get

Получение имени группы пользователей, userData и recognitionModel. Чтобы получить сведения о пользователе в этой группе personGroup, используйте PersonGroup Person — List.
get_training_status

Получение состояния обучения группы пользователей (завершенных или текущих).
list

Перечисление personGroupId, name, userData и recognitionModel для групп пользователей.

  • Группы пользователей хранятся в алфавитном порядке personGroupId.
  • Параметр start (string, необязательный) — это предоставленное пользователем значение personGroupId, возвращаемое записями с большими идентификаторами по сравнению со строками. Для параметра "start" задано пустое значение, указывающее на возврат из первого элемента.
  • Параметр top (int, необязательный) указывает количество возвращаемых записей. В одном вызове можно вернуть не более 1000 записей. Чтобы получить дополнительные сведения, можно указать "start" с идентификатором последнего возвращенного элемента текущего вызова.
    Например, всего 5 групп пользователей: "group1", ..., "group5".
    "start=&top=" возвращает все 5 групп.
    "start=&top=2" возвращает "group1", "group2".
    "start=group2&top=3" возвращает "group3", "group4", "group5". .
train

Постановка задачи обучения группы пользователей в очередь. Задача обучения может быть запущена не сразу.
update

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

create

Создайте группу пользователей с указанными personGroupId, именем, предоставленным пользователем userData и recognitionModel.
Группа пользователей — это контейнер отправленных данных о пользователях, включая функции распознавания лиц.
После создания используйте PersonGroup Person - Create , чтобы добавить пользователей в группу, а затем вызовите PersonGroup - Train , чтобы подготовить эту группу к распознаванию лиц - идентификации.
Образ не будет сохранен. На сервере будут храниться только извлеченные признаки лица и userData, пока не будет вызван метод PersonGroup Person — Delete или PersonGroup — Delete .
Для связи с этой группой пользователей следует указать "recognitionModel". Значение по умолчанию для "recognitionModel" — "recognition_01". Если требуется последняя модель, укажите необходимую модель в этом параметре. Новые лица, добавленные в существующую группу пользователей, будут использовать модель распознавания, уже связанную с коллекцией. Существующие функции распознавания лиц в группе пользователей нельзя обновить до функций, извлеченных другой версией модели распознавания. Квота группы пользователей:

  • Квота подписки уровня "Бесплатный": 1000 групп пользователей. Каждый из них содержит до 1000 человек.
  • Квота на подписку уровня S0: 1 000 000 групп пользователей. В каждом из них содержится до 10 000 человек.
  • Чтобы решить проблему с идентификацией лиц в большом масштабе, рассмотрите возможность использования LargePersonGroup.
create(person_group_id, name, user_data=None, recognition_model='recognition_01', custom_headers=None, raw=False, **operation_config)

Параметры

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

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

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

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

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

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

recognition_model
str или RecognitionModel
значение по умолчанию: recognition_01

Возможные значения: "recognition_01", "recognition_02", "recognition_03", "recognition_04".

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

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

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

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

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

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

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

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

Возвращаемый тип

None,
ClientRawResponse

Исключения

APIErrorException

delete

Удаление существующей группы пользователей. Сохраненные признаки лиц всех пользователей в группе пользователей также будут удалены.

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

Параметры

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

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

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

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

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

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

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

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

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

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

Возвращаемый тип

None,
ClientRawResponse

Исключения

APIErrorException

get

Получение имени группы пользователей, userData и recognitionModel. Чтобы получить сведения о пользователе в этой группе personGroup, используйте PersonGroup Person — List.

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

Параметры

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

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

return_recognition_model
bool
значение по умолчанию: False

Значение , указывающее, должна ли операция возвращать в ответ "recognitionModel".

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

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

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

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

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

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

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

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

Возвращаемый тип

PersonGroup,
ClientRawResponse

Исключения

APIErrorException

get_training_status

Получение состояния обучения группы пользователей (завершенных или текущих).

get_training_status(person_group_id, custom_headers=None, raw=False, **operation_config)

Параметры

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

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

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

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

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

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

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

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

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

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

Возвращаемый тип

TrainingStatus,
ClientRawResponse

Исключения

APIErrorException

list

Перечисление personGroupId, name, userData и recognitionModel для групп пользователей.

  • Группы пользователей хранятся в алфавитном порядке personGroupId.
  • Параметр start (string, необязательный) — это предоставленное пользователем значение personGroupId, возвращаемое записями с большими идентификаторами по сравнению со строками. Для параметра "start" задано пустое значение, указывающее на возврат из первого элемента.
  • Параметр top (int, необязательный) указывает количество возвращаемых записей. В одном вызове можно вернуть не более 1000 записей. Чтобы получить дополнительные сведения, можно указать "start" с идентификатором последнего возвращенного элемента текущего вызова.
    Например, всего 5 групп пользователей: "group1", ..., "group5".
    "start=&top=" возвращает все 5 групп.
    "start=&top=2" возвращает "group1", "group2".
    "start=group2&top=3" возвращает "group3", "group4", "group5". .
list(start=None, top=1000, return_recognition_model=False, custom_headers=None, raw=False, **operation_config)

Параметры

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

Вывод списка групп пользователей из наименьшего значения personGroupId, превышающего значение start.

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

Количество групп пользователей для перечисления.

return_recognition_model
bool
значение по умолчанию: False

Значение , указывающее, должна ли операция возвращать в ответ "recognitionModel".

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

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

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

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

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

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

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

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

Возвращаемый тип

list[PersonGroup],
ClientRawResponse

Исключения

APIErrorException

train

Постановка задачи обучения группы пользователей в очередь. Задача обучения может быть запущена не сразу.

train(person_group_id, custom_headers=None, raw=False, **operation_config)

Параметры

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

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

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

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

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

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

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

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

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

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

Возвращаемый тип

None,
ClientRawResponse

Исключения

APIErrorException

update

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Возвращаемый тип

None,
ClientRawResponse

Исключения

APIErrorException

Атрибуты

models 

models = <module 'azure.cognitiveservices.vision.face.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\vision\\face\\models\\__init__.py'>