調用SemanticQuery實現自然語言語義搜尋-Intelligent Media Management-阿里雲 - Intelligent Media Management

通過輸入自然語言，對資料集內的中繼資料進行基於語義的查詢搜尋。

介面說明

注意事項

請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格。該介面每次請求，會產生語義理解費用和查詢費用兩種計費項目各一次。
調用該介面前，請確保您已通過綁定方式（ CreateBinding ）或者主動索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式將檔案索引到資料集（Dataset）中。
返回結果僅為樣本，根據工作流程範本配置不同，擷取到的檔案中繼資料資訊的類別和包含的內容均有可能與樣本不同。如果有疑問，請加入DingTalk群進行反饋，DingTalk群號請參見聯絡我們。

使用限制

每次查詢最多返回 100 個檔案資訊。
不支援翻頁查詢。
自然語言理解不保證完全準確。
該功能在美國（矽谷），美國（維吉尼亞）地區下不支援。

使用方式

使用自然語言關鍵詞對資料集內的檔案進行搜尋查詢。目前支援理解的關鍵資訊包括標籤（Labels.LabelName）、時間（ProduceTime）和地點（Address.AddressLine）等。例如，以2023 年杭州的風景為條件進行查詢，會被智能拆分為如下三個條件，並尋找出同時滿足這些條件的檔案：

ProduceTime：2023 年 1 月 1 日零點起到 2023 年 12 月 31 日結束止
Address.AddressLine：包含杭州關鍵詞
Labels.LabelName：包含風景標籤

配合工作流程範本配置，當模板中包含ImageEmbeddingExtraction運算元時，該搜尋請求會提供基於圖片內容的搜尋，即您輸入的Query內容會同時被理解為圖片內包含的內容，從而實現對圖片的智能檢索。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:SemanticQuery

list

*Dataset

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

無

請求參數

名稱	類型	必填	描述	樣本值
NextToken	string	否	目前不再提供該參數。	預留，暫不支援
MaxResults	integer	否	本次讀取的最巨量資料記錄數量。範圍(0,100]。	20
ProjectName	string	是	專案名稱。	test-project
DatasetName	string	是	資料集名稱。	test-dataset
Query	string	否	重要該參數與 SourceURI 參數必須有一個為非空值。需要進行語義搜尋的內容。	2021年4月杭州的風景
WithFields	array	否	僅返回特定欄位的值，而不是全部已有的元資訊欄位。可用於降低返回的結構體大小。不填或留空則返回所有欄位。
	string	否	僅返回特定欄位的值，而不是全部已有的元資訊欄位。可用於降低返回的結構體大小。不填或留空則返回所有欄位。	["URI", "Filename"]
MediaTypes	array	否	搜尋的媒體類型。如留空則預設值為： ["image"]
	string	否	枚舉值，當前僅支援： image	["image"]
SourceURI	string	否	重要該參數與 Query 參數必須有一個為非空值。該參數目前僅在指定搜尋類型為圖片且資料集配置了以圖搜圖相關工作流程範本時有效。用於檢索的來源資料的儲存地址，儲存地址支援 OSS 的 URI 地址。 OSS 地址規則為 oss://${Bucket}/${Object}，其中${Bucket}為和當前專案處於同一地區(Region)的 OSS Bucket 名稱，${Object}為包含副檔名的檔案完整路徑。如您需要配置對應工作流程範本，歡迎聯絡我們。	oss://test-bucket/test-object

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	當次請求的 Request ID。	2C5C1E0F-D8B8-4DA0-8127-EC32C771****
Files	array	檔案清單。
	File	檔案資訊。

錯誤碼

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

變更歷史

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