CreateFacesSearchingTask - 建立相似人臉圖片檢索任務 -

介面說明

請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格。
重要非同步任務不保證時效。
對於每一個輸入的圖片，只會選取圖片中人臉框範圍最大的人臉進行人臉搜尋。
該介面為非同步介面，擷取任務開始執行後，任務資訊只儲存 7 天，超過 7 天則無法再擷取。調用 GetTask 或 ListTasks 介面擷取返回的TaskId，查看任務資訊。也可以通過設定 Notification 訊息通知參數，通過訊息通知擷取任務資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:CreateFacesSearchingTask

list

*Dataset

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/dataset/{#DatasetName}

無

請求參數

名稱	類型	必填	描述	樣本值
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}，其中`${Bucket}`為和當前專案處於同一地區(Region)的 OSS Bucket 名稱，`${Object}`為包含副檔名的檔案完整路徑。	oss://test-bucket/test-object
MaxResult	integer	否	最相似的 N 個人臉，取值範圍為 0~100，預設值為 5。	100
Notification	Notification	否	訊息通知配置，詳細內容請單擊 Notification 查看，非同步通知訊息格式請參見非同步通知訊息格式。

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	B1E79399-05F7-06D8-95FE-EBE17BA*****
TaskId	string	任務 ID。	CreateFacesSearchingTask-00bec802-073a-4b61-ba*****
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16****

樣本

正常返回樣本

JSON格式

{
  "RequestId": "B1E79399-05F7-06D8-95FE-EBE17BA*****",
  "TaskId": "CreateFacesSearchingTask-00bec802-073a-4b61-ba*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。