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

Large Person Group Person - Update

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

PATCH {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons/{personId}

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-_]+$

personId
path True
  • string
uuid

引用特定人员的 ID。

请求头

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

请求正文

Name Type Description
name
  • string

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

userData
  • string

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

响应

Name Type Description
200 OK

成功的调用返回空响应正文。

Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Update person example

Sample Request

PATCH {Endpoint}/face/v1.0/largepersongroups/abc/persons/25985303-c537-4467-b41d-bdb45cd95ca1


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

Sample Response

定义

APIError

API 返回的错误信息

Error

错误正文。

NameAndUserDataContract

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

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。