API 概覽

API標準及多語言預置SDK

本產品（imm/2020-09-30）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

中繼資料管理

API	標題	API概述
中繼資料索引	中繼資料索引
IndexFileMeta	檔案元資訊建立索引	對輸入的檔案進行資料處理如標籤識別、臉部偵測、地點檢測等。將提取的檔案元資訊建立索引，支援使用者在一個資料集內多樣化的資料檢索。
BatchIndexFileMeta	批量檔案元資訊建立索引	批量索引檔案元資訊。對輸入的檔案進行資料處理如標籤識別、臉部偵測、地點檢測等，並將檔案元資訊索引到資料集內，支援多樣化的資料檢索。
UpdateFileMeta	更新檔案中繼資料	更新資料集內已索引的檔案的部分中繼資料。
BatchUpdateFileMeta	批次更新檔案元資訊	更新批量資料集內已索引的檔案的部分中繼資料。
GetFileMeta	擷取檔案中繼資料	擷取資料集內已完成索引的檔案的中繼資料。
BatchGetFileMeta	批量擷取檔案中繼資料	批量擷取資料集內已完成索引的檔案的中繼資料。
DeleteFileMeta	刪除檔案元資訊	從資料集內刪除檔案的元資訊。
BatchDeleteFileMeta	大量刪除檔案元資訊	批量從資料集內刪除檔案的元資訊。
查詢與統計	查詢與統計
SimpleQuery	簡單查詢	查詢和統計資料集內檔案，支援邏輯關係表達方式。
SemanticQuery	自然語言查詢	通過輸入自然語言，對資料集內的中繼資料進行基於語義的查詢搜尋。
FuzzyQuery	模糊查詢	查詢已提取的檔案中繼資料（包含檔案名稱、標籤、路徑、自訂標籤等欄位），只要檔案中繼資料中有一個欄位的值匹配指定字串，該檔案的中繼資料就會被返回。
智慧管理	智慧管理
人臉聚類	人臉聚類
CreateFigureClusteringTask	建立人物人臉聚類任務	建立一個人物人臉聚類任務，通過智能演算法，可以在您已索引到資料集的圖片中，將屬於不同人物的人臉進行聚類分組。
CreateFigureClustersMergingTask	合并人物聚類	將兩個或兩個以上人物聚類分組合并為一個人物聚類分組
GetFigureCluster	擷取人物人臉的聚類資訊	擷取人臉分組的基本資料，包括建立時間、照片數量、分組封面等資訊。
QueryFigureClusters	查詢人物聚類	根據條件查詢人物聚類及其資訊。
BatchGetFigureCluster	批量擷取人臉聚類	批量擷取人物聚類及其資訊。
UpdateFigureCluster	更新人物聚類	更新一個人臉聚類分組的資訊，可以更新分組的名稱、標籤等資訊。
SearchImageFigureCluster	查詢圖片人臉所屬聚類	查詢指定圖片中所有人臉所在的人物聚類列表，每個人物聚類中包含人臉框，相似性等資訊。
CreateFacesSearchingTask	建立相似人臉圖片檢索任務	從媒體集中搜尋與指定圖片或人臉ID最相似的前N張圖片，並返回相應人臉ID及邊界框。返回結果按照相似性降序排列。
時空聚類	時空聚類
CreateLocationDateClusteringTask	建立時空聚類任務	時空聚類功能。可以將您已索引到資料集內的圖片、視頻等攜帶了拍攝時間、拍攝地點資訊等檔案，按照時間、地理位置進行分類。這些分類可以理解為使用者的一次旅行所拍攝的內容（它們時間接近、地點接近），也可以理解為使用者在不同生活、工作地的拍攝內容。通過擷取、分析這些分類所在地點、所經歷的時間範圍，可以為使用者提供媒體檔案歸類、精選、產生照片視頻故事等能力。
QueryLocationDateClusters	查詢時空聚類	查詢時空聚類列表資訊，支援多種條件，詳情請參考請求參數。
UpdateLocationDateCluster	更新時空聚類	更新一個時空聚類的資訊。
DeleteLocationDateCluster	刪除時空聚類分組	刪除一個時空聚類。
故事	故事
QueryStories	查詢故事	根據條件查詢故事及其資訊。
圖片聚類	圖片聚類
CreateSimilarImageClusteringTask	建立相似圖片聚類任務	相似圖片聚類功能，可以將您已索引到資料集內的圖片按照相似性產生聚類，用於圖片去重、選優等情境。例如可以通過該功能篩選相簿中連拍的圖片。
QuerySimilarImageClusters	查詢相似圖片聚類	查詢相似圖片聚類列表資訊。
資料綁定	資料綁定
CreateBinding	建立綁定任務	建立資料集（Dataset）和Object Storage ServiceBucket的綁定關係，自動同步全量和增量檔案並為其索引。
GetBinding	查詢繫結關係資訊	查詢指定的資料集和Object Storage ServiceBucket綁定關係詳情。
ListBindings	查詢繫結關係列表	查詢資料集和物件儲存（OSS）Bucket 繫結關係列表。
DeleteBinding	刪除綁定任務	刪除資料集和Object Storage ServiceBucket綁定任務。
AttachOSSBucket	綁定Object Storage Service桶	將OSS Bucket與IMM Project綁定，可以通過OSS x-oss-process方式使用IMM的資料處理能力。
DetachOSSBucket	解除綁定Object Storage Service桶	解除專案與OSS Bucket的綁定關係。
GetOSSBucketAttachment	取得物件儲存桶繫結資訊	取得同一地域下與指定 OSS Bucket 繫結的專案的專案名稱。

圖片處理

API	標題	API概述
EncodeBlindWatermark	添加圖片盲浮水印	將特定的文本資訊嵌入到圖片中，而這些資訊在視覺觀察下是不可見的。由於這些浮水印在視覺上是隱形，它們不會影響圖片的美觀性或原始資訊的傳遞，但可以通過 CreateDecodeBlindWatermarkTask 介面提取出來。
CreateDecodeBlindWatermarkTask	建立解析盲浮水印任務	提取盲浮水印
GetDecodeBlindWatermarkResult	擷取解析盲浮水印任務結果	擷取解析圖片盲浮水印任務的結果。
DetectImageLabels	檢測圖片中的標籤資訊	檢測圖片中的情境、物體和事件標籤資訊。情境資訊包括：自然景觀、生活情境、災難情境等大類；事件資訊包括：才藝、辦公、表演、生產等大類；物體資訊包括：餐具、電子產品、傢具、交通工具等大類。圖片標籤檢測目前支援的標籤種類包含三十多個分類、數千個標籤。
DetectImageScore	擷取圖片分數	以主觀美學為準評估圖片的視覺品質，同時考慮構圖、亮度、對比、色彩、清晰度等多方面因素的影響。該功能返回一個範圍為0-1的圖片品質得分，得分越高則表示圖片的視覺品質越高。
DetectImageCodes	圖片二維碼檢測	識別指定映像中的條碼和二維碼。
DetectImageFaces	通過AI模型能力檢測圖片中的人臉以及人臉資訊	檢測指定映像中的人臉邊界資訊、屬性資訊、品質資訊。邊界資訊（Boundary）包括：頂點Y座標距離頂端距離（Top）、頂點X座標距離左端距離（Left）、高度（Height）、寬度（Width）；屬性資訊包括：年齡（Age）、年齡標準差（AgeSD）、性別（Gender）、心情（Emotion）、是否張口（Mouth）、是否有鬍子（Beard）、是否有帽子（Hat）、是否帶口罩（Mask）、是否戴眼鏡（Glasses）、頭部朝向（HeadPose）、人臉吸引力（Attractive）及上述各屬性的信賴度；品質資訊包括：人臉品質分（FaceQuality）、人臉清晰度（Sharpness）。
DetectImageCropping	透過 AI 模型能力在給定的目標圖片比例下檢測出視覺效果較好的裁剪框區域	透過 AI 模型能力在給定的目標圖片比例下檢測出視覺效果較好的裁剪框區域。
AddImageMosaic	添加圖片馬賽克	在一張圖片的一個或多個特定地區內添加多種形狀的馬賽克、高斯模糊或純色塊，並將填充後的圖片儲存到指定的OSS檔案對象地址。該功能主要用於隱私保護。
CreateImageToPDFTask	建立圖片轉PDF任務	將多張圖片轉換為單個PDF檔案，並儲存到指定的OSS檔案對象地址
CreateImageSplicingTask	建立圖片拼接任務	將多張圖片按設定的規則拼接成一張圖片，並儲存到指定的OSS檔案對象地址
CompareImageFaces	圖片人臉相似性比對	比較兩張圖片中最大的人臉的相似性。最大的人臉指的是圖片經臉部偵測後，所有人臉框中面積最大的。
DetectImageBodies	檢測圖片中的人體	檢測圖片中的人體資訊，包含信賴度，人體邊框等資訊。
DetectImageCars	檢測圖片中的車輛資訊	檢測指定映像中的車輛邊界資訊、車輛屬性資訊、車牌資訊。車輛屬性資訊包括：車輛顏色（CarColor）、車輛類型（CarType）；車牌資訊包括：車牌識別內容（Content）、車牌框資訊（Boundary）。
DetectImageTexts	圖片文本識別	圖片文本識別，將圖片上的文字內容智能識別成為可編輯的文本。

媒體處理

API	標題	API概述
CreateMediaConvertTask	建立媒體轉碼任務	建立一個非同步媒體轉碼任務。提供媒體轉碼、媒體拼接、視頻截幀、視頻轉動圖等相關音視頻媒體檔案處理能力。
DetectMediaMeta	擷取媒體檔案元資訊	擷取媒體檔案元資訊，包括媒體格式資訊和媒體流資訊。
CreateVideoLabelClassificationTask	建立視頻標籤檢測任務	檢測視頻內容的情境、物體和事件標籤資訊。情境資訊包括：自然景觀、生活情境、災難情境等大類；事件資訊包括：才藝、辦公、表演、生產等大類；物體資訊包括：餐具、電子產品、傢具、交通工具等大類；視頻標籤檢測目前支援的標籤種類包含三十多個分類、數千個標籤。
GetVideoLabelClassificationResult	取得影片標籤檢測任務	取得影片標籤檢測任務的結果。
GenerateVideoPlaylist	產生邊轉邊播播放清單	建立邊轉邊播播放清單能夠將視頻檔案產生m3u8檔案，產生播放清單後即時播放，並根據播放進度實施按需轉碼，相比離線轉碼能極大減少了轉碼等待時間並大幅度降低了轉碼和儲存開銷。
CreateHighlightTask	建立影片高光剪輯任務	建立高光任務，邀測中。

文件處理

API	標題	API概述
GenerateWebofficeToken	取得 Weboffice 憑證	取得文件預覽編輯憑證。
RefreshWebofficeToken	重新整理 Weboffice 憑證	重新整理 Weboffice 存取憑證。Weboffice 存取憑證有效期是 30 分鐘，過期會失效，無法繼續存取 Weboffice。如果要繼續存取 Weboffice，可以使用這個介面重新整理 Weboffice 存取憑證，即取得一個新的憑證，新的憑證過期時間也是 30 分鐘。
CreateOfficeConversionTask	建立文檔轉換任務	建立文檔轉換任務，支援文檔格式轉換，將儲存在Object Storage Service中的文檔（Word、PPT、Excel、PDF）轉成圖片，文本，或者PDF。
ExtractDocumentText	文檔本文提取	提取文檔檔案本文中的文本。

檔案處理

API	標題	API概述
壓縮解壓縮	壓縮解壓縮
CreateFileCompressionTask	建立檔案壓縮任務	打包下載API
CreateArchiveFileInspectionTask	建立壓縮包預覽解析任務	建立壓縮包預覽解析任務支援擷取壓縮包內的檔案清單資訊，該功能無需解壓壓縮包，就可以擷取壓縮包內的檔案清單資訊。
CreateFileUncompressionTask	建立解壓縮任務	建立解壓縮任務可以將您壓縮包內的指定檔案解壓縮到特定位置，也可以將壓縮包完整解壓，目前支援的壓縮格式包括Zip、RAR和7z。
點雲壓縮	點雲壓縮
CreateCompressPointCloudTask	建立點雲壓縮任務	點雲壓縮功能可以將OSS中的點雲資料進行壓縮處理。減少網路資料轉送。

內容安全

API	標題	API概述
DetectTextAnomaly	文本合規檢測	檢測指定常值內容中是否包含色情、廣告、灌水、涉政、辱罵等違規資訊。
CreateImageModerationTask	建立圖片合規檢測任務	檢測圖片內容是否合規，包括與性相關的情況、暴恐涉政、不良情境、logo、圖文違規這幾種檢測情境。
CreateVideoModerationTask	建立視頻合規檢測任務	檢測視頻中的風險或違規內容。具體包括以下情境：視頻智能鑒黃、視頻暴恐涉政、視頻圖文違規、視頻不良情境、視頻logo。
GetImageModerationResult	取得圖片合規檢測任務	取得圖片合規檢測任務。
GetVideoModerationResult	取得影片合規檢測任務	取得影片合規檢測任務。

任務管理

API	標題	API概述
觸發器	觸發器
SuspendTrigger	暫停觸發器	將一個 Running（正在執行）狀態的觸發器暫停。
ResumeTrigger	恢複觸發器	將一個Suspended（暫停）或Failed（失敗）狀態的觸發器恢複。
UpdateTrigger	更新觸發器	更新觸發器資訊，如輸入的資料來源配置、資料處理的配置、觸發器標籤等資訊。
GetTrigger	擷取觸發器資訊	擷取觸發器資訊。
ListTriggers	查詢觸發器列表	查詢觸發器工作清單，支援排序，支援按照任務標籤，任務狀態等條件查詢。
批次處理	批次處理
CreateBatch	建立批處理任務	建立一個批處理任務。指定儲存內已存在的若干檔案，對其批量執行指定操作，如轉碼、格式轉換等。
SuspendBatch	暫停批處理任務	將一個 Running（正在執行）的批處理任務暫停。
ResumeBatch	恢複批處理任務	將一個Suspend（暫停）或Failed（失敗）的批處理任務恢複。
UpdateBatch	更新批處理任務	更新批處理任務資訊。如輸入的資料來源配置、資料處理的配置、批處理任務標籤等資訊。
ListBatches	查詢批處理工作清單	查詢批處理工作清單，支援排序，支援按照任務標籤，任務狀態等條件查詢。
GetBatch	擷取批處理任務資訊	擷取批處理任務資訊。
DeleteBatch	刪除批處理任務	刪除指定的一個批處理任務。

其他

API	標題	API概述
ContextualAnswer	AI 助手中的問答API	AI助手的問答API，用於產生對話中的問答內容，能夠根據上下文提供相關的回答。
ContextualRetrieval	AI助手中的檢索API	檢索API專為多輪對話情境設計，能夠處理包含對話歷史的訊息輸入，精準檢索語義相近文檔。通過深度解析上下文資訊，該介面確保檢索結果與目前的交談內容高度相關，適用於複雜互動環境，為多輪對話提供一致且高效的資訊檢索服務。
ListAttachedOSSBuckets	列舉OSS Bucket綁定關係	查詢專案（Project）所綁定的所有OSS Bucket資訊。

Others

API	標題	API概述
AddStoryFiles	添加故事檔案	向故事中添加檔案。
CreateCustomizedStory	建立自訂故事	使用選擇的圖片和視頻建立一個故事。
CreateDataset	建立資料集。	建立一個資料集（Dataset）。
CreateProject	建立專案。	建立一個專案（Project）。
CreateStory	建立故事	建立一個故事
CreateTrigger	建立觸發器	建立觸發器任務，可通過OSS等事件來源觸發IMM資料處理，支援選擇多種資料處理模板，對圖片、視頻、文檔等媒體檔案執行相應的處理。
DeleteDataset	刪除資料集	刪除一個資料集（Dataset）。
DeleteProject	刪除專案	刪除指定專案（Project）。
DeleteStory	刪除故事	刪除故事。
DeleteTrigger	刪除觸發器	刪除指定的觸發器。
GetDataset	查詢資料集資訊	查詢一個資料集的資訊。
GetProject	查詢專案資訊。	查詢指定專案（Project）的資訊，包含基礎資訊，資料集（Dataset）和檔案相關的統計資訊等。
GetStory	擷取故事資訊	擷取一個故事的資訊。
GetTask	取得任務資訊	該介面用於主動查詢指定的非同步任務資訊。IMM 支援多種非同步資料處理能力，每種能力有各自建立任務的介面，例如建立人物人臉聚類任務 CreateFigureClusteringTask、建立檔案壓縮任務 CreateFileCompressionTask 等。本介面為通用介面，可以透過任務 ID 和類型來查詢非同步任務的詳細資訊。
ListDatasets	列出資料集	擷取資料集列表，支援通過資料集名稱首碼查詢列表。
ListProjects	查詢所有專案資訊。	查詢所有專案（Project）的資訊，包含基礎資訊，資料集（Dataset）和檔案相關的統計資訊等。
ListRegions	查詢支援IMM服務的Region列表	查詢支援IMM服務的Region列表資訊，包括Region和對應語言的描述資訊。
ListTasks	查詢工作清單	該介面提供通過多種條件查詢工作清單的功能。通過該介面可以查詢指定時間範圍內的任務、或者通過建立任務時指定的Tag搜尋任務等。
RemoveStoryFiles	從故事中刪除檔案	從故事中刪除檔案。
UpdateDataset	更新資料集。	更新一個資料集（Dataset）的資訊。
UpdateProject	更新專案。	更新一個已建立專案（Project）的資訊。
UpdateStory	更新故事	更新故事資訊，例如重新命名，修改封面等。