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

FaceFindSimilarOptionalParams interface

参考

包:: @azure/cognitiveservices-face

可选参数。

Extends: RequestOptionsBase

属性

faceIds	候选 faceIds 的数组。所有这些操作均由 Face - Detect 创建，faceId 将在检测调用后 faceIdTimeToLive 指定的时间过期。 faceId 的数量限制为 1000。不应同时提供参数 faceListId、largeFaceListId 和 faceIds。
faceListId	在人脸列表 - 创建人脸列表中创建的现有用户指定的唯一候选人脸列表。人脸列表包含一组持久化且永不过期的持久化FaceId。不应同时提供参数 faceListId、largeFaceListId 和 faceIds。
largeFaceListId	现有的用户指定的唯一候选人脸大型列表，在 LargeFaceList - Create 中创建。大型人脸列表包含一组持久化且永不过期的持久化FaceId。不应同时提供参数 faceListId、largeFaceListId 和 faceIds。
maxNumOfCandidatesReturned	返回的最相似人脸的数量。有效范围为 [1， 1000]。默认值：20。
mode	类似的人脸搜索模式。它可以是“matchPerson”或“matchFace”。可能的值包括：“matchPerson”、“matchFace”。默认值：“matchPerson”。

继承属性

abortSignal	可用于中止请求的信号。
customHeaders	用户定义的自定义请求标头，将在发送请求之前应用。
onDownloadProgress	下载进度时触发的回调。
onUploadProgress	上传进度时触发的回调。
timeout	请求在自动终止之前可以花费的毫秒数。

属性详细信息

faceIds

候选 faceIds 的数组。所有这些操作均由 Face - Detect 创建，faceId 将在检测调用后 faceIdTimeToLive 指定的时间过期。 faceId 的数量限制为 1000。不应同时提供参数 faceListId、largeFaceListId 和 faceIds。

faceIds?: string[]

属性值

string[]

faceListId

在人脸列表 - 创建人脸列表中创建的现有用户指定的唯一候选人脸列表。人脸列表包含一组持久化且永不过期的持久化FaceId。不应同时提供参数 faceListId、largeFaceListId 和 faceIds。

faceListId?: string

属性值

string

largeFaceListId

现有的用户指定的唯一候选人脸大型列表，在 LargeFaceList - Create 中创建。大型人脸列表包含一组持久化且永不过期的持久化FaceId。不应同时提供参数 faceListId、largeFaceListId 和 faceIds。

largeFaceListId?: string

属性值

string

maxNumOfCandidatesReturned

返回的最相似人脸的数量。有效范围为 [1， 1000]。默认值：20。

maxNumOfCandidatesReturned?: number

属性值

number

mode

类似的人脸搜索模式。它可以是“matchPerson”或“matchFace”。可能的值包括：“matchPerson”、“matchFace”。默认值：“matchPerson”。

mode?: FindSimilarMatchMode

属性值

FindSimilarMatchMode

继承属性详细信息

abortSignal

可用于中止请求的信号。

abortSignal?: AbortSignalLike

属性值

AbortSignalLike

继承自 msRest.RequestOptionsBase.abortSignal

customHeaders

用户定义的自定义请求标头，将在发送请求之前应用。

customHeaders?: {[key: string]: string}

属性值

{[key: string]: string}

继承自 msRest.RequestOptionsBase.customHeaders

onDownloadProgress

下载进度时触发的回调。

onDownloadProgress?: (progress: TransferProgressEvent) => void

属性值

(progress: TransferProgressEvent) => void

继承自 msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

上传进度时触发的回调。

onUploadProgress?: (progress: TransferProgressEvent) => void

属性值