你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

PersonGroupPersonOperations 类

  • 参考

PersonGroupPersonOperations 操作。

不应直接实例化此类，而应创建一个客户端实例，该实例将为你创建该类并将其附加为属性。

继承
builtins.object
PersonGroupPersonOperations

构造函数

PersonGroupPersonOperations(client, config, serializer, deserializer)

参数

名称 说明
client
必需

用于服务请求的客户端。
config
必需

服务客户端的配置。
serializer
必需

对象模型序列化程序。
deserializer
必需

对象模型反序列化程序。

方法

add_face_from_stream

将某个人员的人脸添加到人员组以进行人脸识别或验证。 若要处理包含多个人脸的图像，可以将输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸。 不会存储任何图像。 只有提取的人脸特征将存储在服务器上，直到调用 PersonGroup PersonFace - Delete、 PersonGroup 人员 - 删除 或 PersonGroup - Delete 。
注意 persistedFaceId 不同于 [Face 生成的 faceId

检测] (https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) 。

  • 人脸图像质量越高，识别精度就越高。 请考虑高质量的人脸：正面、清晰、人脸大小为 200x200 像素 (100 像素，眼睛) 或更大。
  • 每人参赛最多可以容纳 248 张人脸。
  • 支持 JPEG、PNG、GIF (第一帧) 和 BMP 格式。 允许的图像文件大小为 1KB 到 6MB。
  • “targetFace”矩形应包含一个面。 零张或多张人脸将被视为错误。 如果提供的“targetFace”矩形未从 人脸 - 检测返回，则不能保证成功检测和添加人脸。
  • 超过可检测的人脸大小 (36x36 - 4096x4096 像素) ，大头部姿势或大遮挡将导致故障。
  • 向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。
  • 在不超过 1920x1080 像素的图像中，最小可检测人脸大小为 36x36 像素。 尺寸大于 1920x1080 像素的图像需要按比例增大最小人脸大小。
  • 可以提供不同的“detectionModel”值。 若要使用和比较不同的检测模型，请参阅 如何指定检测模型。
add_face_from_url

将某个人员的人脸添加到人员组以进行人脸识别或验证。 若要处理包含多个人脸的图像，可以将输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸。 不会存储任何图像。 只有提取的人脸特征将存储在服务器上，直到调用 PersonGroup PersonFace - Delete、 PersonGroup 人员 - 删除 或 PersonGroup - Delete 。
注意 persistedFaceId 不同于 [Face 生成的 faceId

检测] (https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) 。

  • 人脸图像质量越高，识别精度就越高。 请考虑高质量的人脸：正面、清晰、人脸大小为 200x200 像素 (100 像素，眼睛) 或更大。
  • 每人参赛最多可以容纳 248 张人脸。
  • 支持 JPEG、PNG、GIF (第一帧) 和 BMP 格式。 允许的图像文件大小为 1KB 到 6MB。
  • “targetFace”矩形应包含一个面。 零张或多张人脸将被视为错误。 如果提供的“targetFace”矩形未从 人脸 - 检测返回，则不能保证成功检测和添加人脸。
  • 超过可检测的人脸大小 (36x36 - 4096x4096 像素) ，大头部姿势或大遮挡将导致故障。
  • 向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。
  • 在不超过 1920x1080 像素的图像中，最小可检测人脸大小为 36x36 像素。 尺寸大于 1920x1080 像素的图像需要按比例增大最小人脸大小。
  • 可以提供不同的“detectionModel”值。 若要使用和比较不同的检测模型，请参阅 如何指定检测模型。
create

在指定的人员组中创建新用户。
delete

从人员组中删除现有人员。 将删除人员条目中的 persistedFaceId、userData、人员名称和人脸功能。
delete_face

通过指定的 largePersonGroupId、personId 和 persistedFaceId，删除大型人员组中的人脸。
向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。
get

检索人员的信息，包括已注册的持久化人脸、姓名和 userData。
get_face

检索持久化人脸 (由 persistedFaceId、personId 及其所属 personGroupId) 指定的信息。
list

列出人员组中的所有人员，并检索人员信息 (包括人员) 的已注册人脸的 personId、姓名、userData 和 persistedFaceIds。
update

更新某个人员的姓名或 userData。
update_face

将某个人员的人脸添加到人员组以进行人脸识别或验证。 若要处理包含多个人脸的图像，可以将输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸。 不会存储任何图像。 只有提取的人脸特征将存储在服务器上，直到调用 PersonGroup PersonFace - Delete、 PersonGroup 人员 - 删除 或 PersonGroup - Delete 。
注意 persistedFaceId 不同于 [Face 生成的 faceId

检测] (https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) 。

  • 人脸图像质量越高，识别精度就越高。 请考虑高质量的人脸：正面、清晰、人脸大小为 200x200 像素 (100 像素，眼睛) 或更大。
  • 每人参赛最多可以容纳 248 张人脸。
  • 支持 JPEG、PNG、GIF (第一帧) 和 BMP 格式。 允许的图像文件大小为 1KB 到 6MB。
  • “targetFace”矩形应包含一个面。 零张或多张人脸将被视为错误。 如果提供的“targetFace”矩形未从 人脸 - 检测返回，则不能保证成功检测和添加人脸。
  • 超过可检测的人脸大小 (36x36 - 4096x4096 像素) ，大头部姿势或大遮挡将导致故障。
  • 向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。

add_face_from_stream

将某个人员的人脸添加到人员组以进行人脸识别或验证。 若要处理包含多个人脸的图像，可以将输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸。 不会存储任何图像。 只有提取的人脸特征将存储在服务器上，直到调用 PersonGroup PersonFace - Delete、 PersonGroup 人员 - 删除 或 PersonGroup - Delete 。
注意 persistedFaceId 不同于 [Face 生成的 faceId

检测] (https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) 。

  • 人脸图像质量越高，识别精度就越高。 请考虑高质量的人脸：正面、清晰、人脸大小为 200x200 像素 (100 像素，眼睛) 或更大。
  • 每人参赛最多可以容纳 248 张人脸。
  • 支持 JPEG、PNG、GIF (第一帧) 和 BMP 格式。 允许的图像文件大小为 1KB 到 6MB。
  • “targetFace”矩形应包含一个面。 零张或多张人脸将被视为错误。 如果提供的“targetFace”矩形未从 人脸 - 检测返回，则不能保证成功检测和添加人脸。
  • 超过可检测的人脸大小 (36x36 - 4096x4096 像素) ，大头部姿势或大遮挡将导致故障。
  • 向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。
  • 在不超过 1920x1080 像素的图像中，最小可检测人脸大小为 36x36 像素。 尺寸大于 1920x1080 像素的图像需要按比例增大最小人脸大小。
  • 可以提供不同的“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

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
image
必需
Generator

图像流。
user_data
str

用户指定用于任何用途的人脸数据。 最大长度为 1KB。

默认值: None
target_face
list[int]

一个人脸矩形，用于指定要以“targetFace=left，top，width，height”格式添加到人员的目标人脸。 例如“targetFace=10,10,100,100”。 如果图像中有多个人脸，则需要 targetFace 指定要添加的面。 没有 targetFace 意味着在整个图像中只检测到一张人脸。

默认值: None
detection_model
str 或 DetectionModel

检测模型的名称。 检测模型用于检测提交图像中的人脸。 执行人脸 - 检测或 (大型) FaceList - 添加人脸或 (大型) PersonGroup - 添加人脸时，可以提供检测模型名称。 默认值为“detection_01”，如果需要其他模型，请显式指定它。 可能的值包括：“detection_01”、“detection_02”、“detection_03”

默认值: detection_01
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
callback
Callable[<xref:Bytes>, <xref:response=None>]

指定后，将使用流式传输的每个数据块调用 。 回调应采用两个参数：当前数据区块的字节数和响应对象。 如果正在上传数据，响应将为“无”。

默认值: None
operation_config
必需

操作配置替代。

返回

类型 说明
PersistedFace,
<xref:msrest.pipeline.ClientRawResponse>

PersistedFace 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

add_face_from_url

将某个人员的人脸添加到人员组以进行人脸识别或验证。 若要处理包含多个人脸的图像，可以将输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸。 不会存储任何图像。 只有提取的人脸特征将存储在服务器上，直到调用 PersonGroup PersonFace - Delete、 PersonGroup 人员 - 删除 或 PersonGroup - Delete 。
注意 persistedFaceId 不同于 [Face 生成的 faceId

检测] (https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) 。

  • 人脸图像质量越高，识别精度就越高。 请考虑高质量的人脸：正面、清晰、人脸大小为 200x200 像素 (100 像素，眼睛) 或更大。
  • 每人参赛最多可以容纳 248 张人脸。
  • 支持 JPEG、PNG、GIF (第一帧) 和 BMP 格式。 允许的图像文件大小为 1KB 到 6MB。
  • “targetFace”矩形应包含一个面。 零张或多张人脸将被视为错误。 如果提供的“targetFace”矩形未从 人脸 - 检测返回，则不能保证成功检测和添加人脸。
  • 超过可检测的人脸大小 (36x36 - 4096x4096 像素) ，大头部姿势或大遮挡将导致故障。
  • 向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。
  • 在不超过 1920x1080 像素的图像中，最小可检测人脸大小为 36x36 像素。 尺寸大于 1920x1080 像素的图像需要按比例增大最小人脸大小。
  • 可以提供不同的“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

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
url
必需
str

图像的可公开访问 URL
user_data
str

用户指定用于任何用途的人脸数据。 最大长度为 1KB。

默认值: None
target_face
list[int]

一个人脸矩形，用于指定要以“targetFace=left，top，width，height”格式添加到人员的目标人脸。 例如“targetFace=10,10,100,100”。 如果图像中有多个人脸，则需要 targetFace 指定要添加的面。 没有 targetFace 意味着在整个图像中只检测到一张人脸。

默认值: None
detection_model
str 或 DetectionModel

检测模型的名称。 检测模型用于检测提交图像中的人脸。 执行人脸 - 检测或 (大型) FaceList - 添加人脸或 (大型) PersonGroup - 添加人脸时，可以提供检测模型名称。 默认值为“detection_01”，如果需要其他模型，请显式指定它。 可能的值包括：“detection_01”、“detection_02”、“detection_03”

默认值: detection_01
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
PersistedFace,
<xref:msrest.pipeline.ClientRawResponse>

PersistedFace 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

create

在指定的人员组中创建新用户。

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

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
name
str

用户定义的名称，最大长度为 128。

默认值: None
user_data
str

用户指定的数据。 长度不应超过 16KB。

默认值: None
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
Person,
<xref:msrest.pipeline.ClientRawResponse>

如果 raw=true，则为 Person 或 ClientRawResponse

例外

类型 说明
APIErrorException

delete

从人员组中删除现有人员。 将删除人员条目中的 persistedFaceId、userData、人员名称和人脸功能。

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

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

delete_face

通过指定的 largePersonGroupId、personId 和 persistedFaceId，删除大型人员组中的人脸。
向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。

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

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
persisted_face_id
必需
str

引用现有人脸的特定 persistedFaceId 的 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

get

检索人员的信息，包括已注册的持久化人脸、姓名和 userData。

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

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
Person,
<xref:msrest.pipeline.ClientRawResponse>

如果 raw=true，则为 Person 或 ClientRawResponse

例外

类型 说明
APIErrorException

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

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
persisted_face_id
必需
str

引用现有人脸的特定 persistedFaceId 的 ID。
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
PersistedFace,
<xref:msrest.pipeline.ClientRawResponse>

PersistedFace 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

list

列出人员组中的所有人员，并检索人员信息 (包括人员) 的已注册人脸的 personId、姓名、userData 和 persistedFaceIds。

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

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
start
str

启动人员 ID 以返回用于列出) 人员范围的 (。

默认值: None
top
int

以“start”参数指示的人员 ID 开始返回的人员数。

默认值: None
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
list[Person],
<xref:msrest.pipeline.ClientRawResponse>

list 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

update

更新某个人员的姓名或 userData。

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

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
name
str

用户定义的名称，最大长度为 128。

默认值: None
user_data
str

用户指定的数据。 长度不应超过 16KB。

默认值: None
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

update_face

将某个人员的人脸添加到人员组以进行人脸识别或验证。 若要处理包含多个人脸的图像，可以将输入人脸指定为具有 targetFace 矩形的图像。 它返回一个 persistedFaceId，表示添加的人脸。 不会存储任何图像。 只有提取的人脸特征将存储在服务器上，直到调用 PersonGroup PersonFace - Delete、 PersonGroup 人员 - 删除 或 PersonGroup - Delete 。
注意 persistedFaceId 不同于 [Face 生成的 faceId

检测] (https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) 。

  • 人脸图像质量越高，识别精度就越高。 请考虑高质量的人脸：正面、清晰、人脸大小为 200x200 像素 (100 像素，眼睛) 或更大。
  • 每人参赛最多可以容纳 248 张人脸。
  • 支持 JPEG、PNG、GIF (第一帧) 和 BMP 格式。 允许的图像文件大小为 1KB 到 6MB。
  • “targetFace”矩形应包含一个面。 零张或多张人脸将被视为错误。 如果提供的“targetFace”矩形未从 人脸 - 检测返回，则不能保证成功检测和添加人脸。
  • 超过可检测的人脸大小 (36x36 - 4096x4096 像素) ，大头部姿势或大遮挡将导致故障。
  • 向同一人员添加/删除人脸将按顺序处理。 向/从不同人员添加/删除人脸是并行处理的。
update_face(person_group_id, person_id, persisted_face_id, user_data=None, custom_headers=None, raw=False, **operation_config)

参数

名称 说明
person_group_id
必需
str

引用特定人员组的 ID。
person_id
必需
str

引用特定人员的 ID。
persisted_face_id
必需
str

引用现有人脸的特定 persistedFaceId 的 ID。
user_data
str

用户提供的数据附加到人脸。 大小限制为 1KB。

默认值: None
custom_headers
dict

将添加到请求的标头

默认值: None
raw
bool

返回直接响应以及反序列化的响应

默认值: False
operation_config
必需

操作配置替代。

返回

类型 说明
None,
<xref:msrest.pipeline.ClientRawResponse>

None 或 ClientRawResponse（如果 raw=true）

例外

类型 说明
APIErrorException

属性

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'>