自訂外掛程式

步驟一：建立外掛程式

1. 訪問外掛程式頁面，單擊建立外掛程式。

2. 填寫外掛程式資訊。

   插件名称：輸入具有語義的名稱，支援中英文。 樣本：寢室公約查詢工具test

   插件描述：對外掛程式功能和使用情境的簡要說明。能協助大模型判斷當前任務是否需要調用當前外掛程式，請使用自然語言進行描述。 樣本：根據輸入的數字索引查詢特定條目的寢室公約內容。

   插件URL：外掛程式的訪問地址。 樣本：https://domitorgreement-plugin-example-icohrkdjxy.cn-beijing.fcapp.run 同一個網域名稱下，不同的路徑被拆分成了不同的API（即下方建立工具中的工具路径） 同一外掛程式下的不同工具使用相同的網域名稱，每個工具的工具路徑對應一個獨立的API 例如：xx外掛程式下包含兩個API： 查詢：https://xxx.com/query 刪除：https://xxx.com/delete 在這個樣本中，https://xxx.com對應插件URL，/query和/delete對應下方建立工具中的工具路径。這表明該外掛程式下包含兩個工具。

   如需要鑒權請開啟是否鉴权開關，填寫鑒權配置資訊。

   鑒權參數說明

   Header列表（可選）	需要鑒權時，可以通過自訂Header傳遞鑒權資訊。
   是否鉴权（可選）	當阿里雲百鍊應用調用您的自訂外掛程式時是否需要鑒權。此處是否需要鑒權主要取決於API提供方的安全性原則。
   鉴权类型	鑒權包括服務級鑒權和使用者級鑒權兩種方式。 位置：支援將鑒權資訊放在Header或Query中。 Header：將鑒權資訊放在HTTP要求標頭的Authorization欄位中，這些資訊在URL中不可見。 Query：將鑒權資訊放在URL中，例如https://example.com?api_key=123456。 参数名：如果將鑒權資訊放在Query中需填寫鑒權時使用的參數，如“api_key”。如果將鑒權資訊放在Header中將預設此參數為“Authorization”。 Type： basic：不會在您提供的Token前加任何內容； bearer：會在Token前增加“Bearer”； appcode：會在Token前增加“APPCODE”。 兩種type都會放在鑒權參數欄位中。例如：選擇bearer，則調用外掛程式時會變成（“Authorization”： “Bearer <YOUR_TOKEN>”）。 Token（服務級鑒權）：從API提供方擷取的鑒權Token，如API Key。

3. 填寫完成後單擊确认创建插件 > 创建工具或單擊继续添加工具。

步驟二：建立工具

1. 填寫工具資訊、配置輸入/輸出參數以及進階配置。

   本樣本中，工具名稱填寫"寢室公約查詢工具"，工具描述填寫"根據輸入的數字索引查詢特定條目的寢室公約內容"，工具路徑填寫/article，要求方法選擇POST，提交方式選擇application/json。輸入參數：參數名稱article_index，參數描述為"索引"，類型為Number，傳入方法為Body，必填，傳參方式為大模型識別。輸出參數：參數名稱article，參數描述為"寢室公約內容"，類型為String。進階配置中，使用者輸入Query為"請根據輸入的索引值，查詢對應條目的寢室公約內容"，輸入參數article_index的Value為5。

   工具參數說明

   工具資訊

   工具名称	輸入具有語義的名稱，支援中英文。
   工具描述	對工具功能和使用情境的簡要說明。 協助大模型判斷當前任務是否需要調用該工具，請使用自然語言進行描述，盡量給出使用樣本。
   工具路径	指向插件URL的相對路徑。 欄位名必須以正斜杠（/）開頭。 此路徑將拼接到插件URL上，以構建完整的URL。
   请求方法	根據實際需求選擇GET或POST要求方法來調用API介面。
   提交方式	請求或響應的編碼類別型。 application/json：主體內容是JSON格式的資料。 application/x-www-form-urlencoded：將表單資料編碼為索引值對。 這種編碼方式用於 POST 請求，表單資料編碼為索引值對，並通過 URL 編碼傳輸。多個索引值對之間用 & 分隔，每個鍵和值之間用 = 分隔。URL 編碼會將特殊字元轉換為 % 後跟兩位十六進位數的形式。例如，空格會被編碼為 %20，& 會被編碼為 %26，= 會被編碼為 %3D 樣本：name=John Doe&age=25 被編碼為 name=John%20Doe&age=25

   配置輸入參數與輸出參數

   配置输入参数	單擊增加入参，配置參數資訊。
   	参数名称：儘可能帶有含義，協助大模型理解當前需要識別的參數資訊是什麼。例如city。
   	参数描述：對該入參的功能描述，要簡練且準確，協助大模型進一步理解取參的方式。例如，date，描述為日期的同時，可以再進一步描述date的形式，比如yyyy-MM-dd。
   	类型：指參數類型。 重要 Object類型下的子屬性不可為空。請單擊該對象行末的表徵圖新增子屬性。
   	传参方式：要設定準確。 大模型识别：表示該參數的值需要大模型從使用者輸入中提取。 业务透传：表示該參數的值從外部主動透傳，傳遞過程中不對資料進行處理或修改。 使用DashScope SDK或HTTP介面調用應用時，外掛程式中的業務透傳類型的輸入參數資訊通過 biz_params和user_defined_params傳遞給應用。具體請參見應用的參數傳遞。
   配置输出参数	單擊增加出参，配置參數資訊，所有參數均為必填項。 大模型會根據出參的定義，結合使用者的問題，對API返回的結果進行篩選、重新組合，作為最終的答案返回給使用者。 出參與入參一樣，需要儘可能精簡和準確描述，嵌套的層級也儘可能少。 重要 無論請求方式是GET還是POST，參數都支援Object類型。但Object類型下的子屬性不可為空。請單擊該對象行末的表徵圖新增子屬性。

   進階配置（可選）

   高级配置	為大模型增加調用樣本，減少漏召回和誤召回的情況。 通常用於入參比較複雜，模型構造容易出錯的情境，通過提供一些範例，提升大模型調用外掛程式的準確性。
   	Value：表示使用者輸入當前的Query時，期望大模型構造出的調用入參。樣本：使用者輸入：“查詢杭州明天的天氣”，期望構造入參為：{"city": "杭州", "date": "2025-04-25"}。

2. 配置完成後單擊保存草稿。

3. 線上調試工具API能否調通。

   單擊测试工具，輸入鑒權資訊（開啟鑒權時填寫）及入參的值，單擊开始运行。 如果運行失敗，請根據运行结果中的報錯資訊對配置進行調整，並重新進行測試，直至成功運行。 入參的值可以手動輸入，也可以通過代碼輸入。對於入參較為複雜的情況，建議採用代码模式编辑。您可以在代碼編輯器中提交完整的JSON格式的入參及其相應的值。

4. 測試通過後單擊发布。只有已发布的工具才能在應用中被調用。

擷取工具 ID

工具ID用於標識具體的工具。通過API調用工具時，需要正確傳遞工具ID，以確保請求能夠被正確識別。

1. 在插件列表中，找到工具所屬的外掛程式，單擊查看详情。

2. 將滑鼠懸浮於工具名稱旁邊的表徵圖上。

3. 單擊表徵圖，複製工具ID。