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

Large Person Group Person - Create

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

POST {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点 (协议和主机名,例如: https://westus.api.cognitive.microsoft.com) 。

largePersonGroupId
path True
  • string

引用特定大型人员组的 ID。

Regex pattern: ^[a-z0-9-_]+$

请求头

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

请求正文

Name Type Description
name
  • string

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

userData
  • string

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

响应

Name Type Description
200 OK

成功的呼叫返回一个新的 personId。

Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Create new person for large person group example

Sample Request

POST {Endpoint}/face/v1.0/largepersongroups/abc/persons


{
  "name": "mike",
  "userData": "{additional data associated with mike}"
}

Sample Response

{
  "personId": "4caa25ee-3bc6-4e88-adf8-12455ce7aab0"
}

定义

APIError

API 返回的错误信息

Error

错误正文。

NameAndUserDataContract

用户定义名称和用户指定数据的组合,用于人员、largePersonGroup/personGroup 和 largeFaceList/faceList。

Person

Person 对象。

APIError

API 返回的错误信息

Name Type Description
error

错误正文。

Error

错误正文。

Name Type Description
code
  • string
message
  • string

NameAndUserDataContract

用户定义名称和用户指定数据的组合,用于人员、largePersonGroup/personGroup 和 largeFaceList/faceList。

Name Type Description
name
  • string

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

userData
  • string

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

Person

Person 对象。

Name Type Description
name
  • string

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

persistedFaceIds
  • string[]

人员中已注册人脸的 PersistedFaceId。 这些 persistedFaceId 从 Person - 添加人员人脸返回,并且不会过期。

personId
  • string

目标人脸列表的 PersonId。

userData
  • string

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