你当前正在访问 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 参数

名称 必需 类型 说明
Endpoint
path True

string

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

largePersonGroupId
path True

string

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

正则表达式模式: ^[a-z0-9-_]+$

personId
path True

string

uuid

引用特定人员的 ID。

请求头

名称 必需 类型 说明
Ocp-Apim-Subscription-Key True

string

请求正文

名称 类型 说明
name

string

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

userData

string

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

响应

名称 类型 说明
200 OK

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

Other Status Codes

APIError

错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Update person example

示例请求

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


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

示例响应

定义

名称 说明
APIError

API 返回的错误信息

Error

错误正文。

NameAndUserDataContract

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

APIError

API 返回的错误信息

名称 类型 说明
error

Error

错误正文。

Error

错误正文。

名称 类型 说明
code

string

message

string

NameAndUserDataContract

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

名称 类型 说明
name

string

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

userData

string

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