調用ContextualAnswer API實現AI問答 - Intelligent Media Management

介面說明

注意事項

請確保在使用該介面前，已充分瞭解Intelligent Media Management產品的收費方式和價格。
調用該介面前，請確保您已通過綁定方式（ CreateBinding ）或者主動索引（ IndexFileMeta 或者 BatchIndexFileMeta ）方式將檔案索引到資料集（Dataset）中。
返回結果僅為樣本，根據工作流程範本配置不同，擷取到的檔案中繼資料資訊的類別和包含的內容均有可能與樣本不同。如果有疑問，請使用DingTalk搜尋DingTalk群號 21714099 加入DingTalk群進行反饋。

使用限制

歷史對話長度最長限制為 100，包括使用者訊息和助手訊息。
每條訊息長度不超過 1000 個漢字。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:ContextualAnswer

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ProjectName	string	是	專案名稱，擷取方式請參見建立專案。	test-project
Messages	array	是	是對話歷史以及工具調用歷史。最新的訊息在最尾（index 為 n-1），最舊的訊息在最頭（index 為 0）。限制必須是 user-assistant 成對的形式，條數為 2*n+1 條，並且最新的提問的長度不超過 1000 個字元長度。歷史對話長度限制在 100 以內。
	ContextualMessage	否	會話訊息的列表
Files	array	否	當前問答涉及到的檔案內容，推薦使用 ContextualRetrieval 介面的返回作為入參。
	ContextualFile	否	問答涉及的檔案清單

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	當次請求的 Request ID。	22F081FB-90D7-525A-BFE4-D28DC906A28F
Answer	Answer	大模型回答的內容。
Code	string	錯誤碼。	ResourceNotFound
Message	string	錯誤訊息	The specified resource project is not found.

樣本

正常返回樣本

JSON格式

{
  "RequestId": "22F081FB-90D7-525A-BFE4-D28DC906A28F",
  "Answer": {
    "Content": "你好",
    "References": [
      {
        "ProjectName": "test-project",
        "DatasetName": "test-dataset",
        "ObjectId": "75d5de2c50754e3dadd5c35dbca5f9949369e37eb342a73821f690c94c36c7f7",
        "URI": "oss://test-bucket/test-object.jpg"
      }
    ]
  },
  "Code": "ResourceNotFound",
  "Message": "The specified resource project is not found."
}

錯誤碼

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

變更歷史

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