魔筆平臺提供了強大的百煉應用集成功能,允許用戶通過簡單的配置,實現對百煉應用的無縫連接和數據交互。本文檔將指導您如何創建和使用百煉應用集成。
功能介紹
魔筆平臺的百煉應用集成功能支持以下特點:
流式傳輸支持:在配置面板中開啟「SSE」后即可支持流式數據傳輸。
自定義觸發方式:集成操作可以設置為手動觸發或自動運行,滿足不同的業務場景需求。
回調和數據轉換:支持在查詢成功或失敗時執行特定的集成操作事件,以及對返回的數據進行自定義處理。
高級設置:提供防抖和禁止執行條件的高級配置,以優化集成操作的執行。
事件相關內容可參考:集成操作事件
使用百煉應用集成
步驟 1:創建百煉應用集成
登錄魔筆平臺,進入管控臺。
導航至“資源”->“集成”,點擊“創建集成”。
選擇“百煉智能體應用”,并填寫集成名稱及描述。
配置不同環境的百煉應用連接信息,包括
API-KEY
、工作空間
等。點擊“確定”以創建百煉應用集成。
關于如何創建百煉智能體應用,可以參考 0代碼構建私有知識問答應用
步驟 2:在應用內部創建集成操作
打開“代碼”面板,點擊對應作用域的“+”后選中“集成操作”。
選擇之前創建的百煉智能體應用集成作為資源,輸入百煉應用 ID 和輸入提示詞后,根據需求,選擇集成操作的觸發方式和更加細節的配置內容。
點擊“運行”預覽查詢效果。
配置面板詳解
通用配置
參數:定義查詢所需的參數,包括類型、默認值和描述。在查詢語句中,可通過
{{ varName }}
的方式引用參數。sse:定義了每輪對話是否使用流式數據傳輸。
應用 ID:定義了預期調用的百煉智能體應用 ID。
提示詞:定義了每輪對話中的輸入提示詞內容。
session_id:定義了對話歷史會話唯一標識,傳入 session_id 后,將在云端進行對話歷史記錄,調用大模型將自動攜帶存儲的對話歷史。
has_thoughts:定義了是否輸出檢索召回處理過程信息。開啟后,將返回文檔檢索召回和模型推理的過程信息。
觸發方式:選擇手動觸發或自動運行。手動觸發僅在觸發集成操作事件或通過 API 調用
action.trigger
方法時執行。自動運行則在初次加載和依賴項變更時自動執行,例如當集成配置中引用了頁面輸入框組件 input1 的數據時,當{{input1.value}}
改變時,集成將自動觸發執行并更新數據。超時時間:配置操作的最大執行時間。
描述:為集成操作提供詳細描述。
回調配置
數據轉化:對接口返回的數據進行處理,默認為
return data
,即不進行處理。流式接收回調:配置流式調用接口 chunk 數據獲取時觸發的事件。
成功回調:配置接口調用成功時觸發的事件。
失敗回調:配置接口調用失敗時觸發的事件。
高級配置
防抖:設置防抖表達式,避免接口的頻繁調用。
禁止執行條件:根據條件表達式確定是否執行此集成操作。
手動觸發集成
事件觸發
在需要觸發集成操作的組件中,配置事件處理器。
將動作類型設置為集成操作,并選擇相應的集成。
以對象形式填寫已配置的參數。
API 觸發
若此集成操作的名稱為action1
,則在任何可以執行腳本的地方,可以使用action.trigger()
方法觸發集成操作,若集成操作配置了參數,則需要以對象形式填寫已配置的參數。