從媒體集中搜索與指定圖片或人臉ID最相似的前N張圖片，并返回相應人臉ID及邊界框，返回結果按照相似度降序排列。
接口說明
- 請確保在使用該接口前，已充分了解智能媒體管理產品的收費方式和價格。
- 對于每一個輸入的圖片，只會選取圖片中人臉框范圍最大的人臉進行人臉搜索。人臉框檢測結果與 DetectImageFaces 一致。
- 該接口為異步接口，獲取任務開始執行后，任務信息只保存 7 天，超過 7 天則無法再獲取。調用 GetTask 或 ListTasks 接口獲取返回的
TaskId，查看任務信息。也可以通過設置 Notification 消息通知參數，通過消息通知獲取任務信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| imm:CreateFacesSearchingTask | list |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ProjectName | string | 是 | 項目名稱，獲取方式請參見創建項目。 | test-project |
| DatasetName | string | 是 | 數據集名稱, 獲取方式請參見創建數據集。 | test-dataset |
| UserData | string | 否 | 用戶自定義信息，在異步消息通知中會為您返回，用于方便您系統內對消息通知進行關聯處理。最大長度為 2048 字節。 | {"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"} |
| Sources | array<object> | 否 | 圖片列表。 | |
| object | 否 | 圖片對象。 | ||
| URI | string | 否 | 圖片的 OSS 地址。 OSS 地址規則為 oss://${Bucket}/${Object}，其中 | oss://test-bucket/test-object |
| MaxResult | long | 否 | 最相似的 N 個人臉，取值范圍為 0~100，默認值為 5。 | 100 |
| Notification | Notification | 否 | 消息通知配置，詳細內容請單擊 Notification 查看，異步通知消息格式請參見異步通知消息格式。 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "B1E79399-05F7-06D8-95FE-EBE17BA*****",
"TaskId": "CreateFacesSearchingTask-00bec802-073a-4b61-ba*****",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-21 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-04-03 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2023-03-09 | OpenAPI 入參發生變更 | 查看變更詳情 |