Large Face List - Create

服务:

Azure AI Services

API 版本:

1.0-preview

使用用户指定的 largeFaceListId、名称、可选 userData 和 recognitionModel 创建空的大型人脸列表。
大型人脸列表是人脸列表，最多 1,000,000 张人脸，由 人脸 - 查找类似的。
创建后，用户应使用 LargeFaceList 人脸 - 添加 以导入人脸和 LargeFaceList - 训练 使其准备好 人脸 - 查找类似的。 不会存储任何图像。 只有提取的人脸功能存储在服务器上，直到调用 LargeFaceList - Delete。
“查找相似”用于查找名人般的人脸、类似的人脸筛选或作为人脸识别的浅色方式。 但是，如果实际用途是识别人员，请使用 PersonGroup / LargePersonGroup 和 人脸 - 识别。
应指定“recognitionModel”以与此大型人脸列表相关联。 “recognitionModel”的默认值为“recognition_01”，如果需要最新的模型，请显式指定此参数中所需的模型。 添加到现有大型人脸列表的新人脸将使用已与集合关联的识别模型。 无法将大型人脸列表中的现有人脸特征更新为另一版本的识别模型提取的功能。 请参阅 指定识别模型。

大型人脸列表配额：

• 免费层订阅配额：64 个大人脸列表。
• S0 层订阅配额：1,000,000 个大人脸列表。

PUT {Endpoint}/face/v1.0-preview/largefacelists/{largeFaceListId}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（协议和主机名，例如：https://westus.api.cognitive.microsoft.com）。
largeFaceListId	path	True	string maxLength: 64 pattern: ^[a-z0-9-_]+$	引用特定大型人脸列表的 ID。

请求头

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

请求正文

名称	必需	类型	说明
name	True	string minLength: 1 maxLength: 128	用户定义的名称，最大长度为 128。
recognitionModel		RecognitionModel	识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。
userData		string maxLength: 16384	用户指定的数据。 长度不应超过 16KB。

响应

名称	类型	说明
200 OK		成功的调用返回空响应正文。
Other Status Codes	APIError	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Create new large face list example

示例请求

HTTP

PUT {Endpoint}/face/v1.0-preview/largefacelists/sample_face_list


{
  "name": "large-face-list-name",
  "userData": "User-provided data attached to the large face list.",
  "recognitionModel": "recognition_01"
}

示例响应

状态代码:

200

定义

名称	说明
APIError	API 返回的错误信息
Error	错误正文。
MetaDataContract	用于 largePersonGroup/personGroup 和 largeFaceList/faceList 的用户定义名称和用户指定的数据和识别模型名称的组合。
RecognitionModel	识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。

APIError

Object

API 返回的错误信息

名称	类型	说明
error	Error	错误正文。

Error

Object

错误正文。

名称	类型	说明
code	string
message	string

MetaDataContract

Object

用于 largePersonGroup/personGroup 和 largeFaceList/faceList 的用户定义名称和用户指定的数据和识别模型名称的组合。

名称	类型	默认值	说明
name	string minLength: 1 maxLength: 128		用户定义的名称，最大长度为 128。
recognitionModel	RecognitionModel	recognition_01	识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。
userData	string maxLength: 16384		用户指定的数据。 长度不应超过 16KB。

RecognitionModel

枚举

识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。

值	说明
recognition_01
recognition_02
recognition_03
recognition_04