通義靈碼靈碼提供了擴展管理,支持自定義指令,滿足企業(yè)編碼場景的擴展訴求。
適用版本 |
企業(yè)標準版、企業(yè)專屬版 |
---|
通義靈碼靈碼管理員、組織內(nèi)全局管理員(專屬版)在通義靈碼靈碼控制臺-擴展管理中,進行自定義指令的管理、查看自定義指令的相關(guān)信息和數(shù)據(jù)。自定義指令可見范圍內(nèi)的開發(fā)者,在通義靈碼靈碼 IDE 插件中使用/喚起時,即可看到有權(quán)限使用的指令。
重要
如需使用企業(yè)級自定義指令功能,請確保將通義靈碼靈碼IDE 插件升級到 V1.4.0 及以上;
指令啟用或修改后,預(yù)計需要 5~10 分鐘生效,開發(fā)者可在通義靈碼靈碼 IDE 插件中使用。
自定義指令管理
查看自定義指令
通義靈碼靈碼管理員、組織內(nèi)全局管理員(專屬版)進入通義靈碼靈碼控制臺,單擊左側(cè)擴展管理模塊,即可看到已創(chuàng)建的自定義指令、通義靈碼靈碼官方指令信息。
單擊指令卡片,即可進入指令詳情頁面,查看指令的基本信息、可見成員范圍、對話配置等信息。同時還可以查看指令的使用數(shù)據(jù)。
創(chuàng)建自定義指令
擴展管理中,單擊新建指令,即進入新建自定義指令頁面:
第一步:基本信息填寫
指令名稱:指令的顯示名稱,1~64個字符,中文、英文、數(shù)字等均可;
指令名稱(英文):指令的英文名稱,1~64個字符,必須為大小寫字母、數(shù)字、下劃線、空格,此名稱為開發(fā)者在通義靈碼靈碼 IDE 插件中問答窗口使用/喚起指令時看到的名稱,請確保規(guī)范性、可讀性
指令描述:200個字符以內(nèi)即可,描述指令的使用場景、作用等;
指令圖標:指令的識別圖標,提供了顏色、圖標選擇,可自由組合;
指令可見范圍:
公開·企業(yè)內(nèi)已授權(quán)開發(fā)者:選擇后,企業(yè)內(nèi)已授權(quán)使用通義靈碼靈碼 IDE 插件的開發(fā)者均可使用該指令;
私有·僅指令的可見成員可用:選擇后,可在指令新建完成后,添加可見成員;
第二步:對話配置
提示詞:5000個字符以內(nèi),可輸入系統(tǒng)身份提示、要求提示等,如上圖中對于做代碼命名的提示詞設(shè)計示意;
上下文組裝:目前提供了#userInput、#selectedCode的上下文選擇,并可進行 Prompt 組裝的設(shè)計,如上圖中對上下文進行組裝的示例;
引入對話歷史:開啟后,將在觸發(fā)本指令時,引入當(dāng)前對話的上下文內(nèi)容。
設(shè)置可用范圍
指令新建完成后,可在指令詳情頁中進行可見范圍的配置或修改。
當(dāng)為公開·企業(yè)內(nèi)已授權(quán)開發(fā)者時,單擊查看可前往授權(quán)管理頁面中查看已授權(quán)開發(fā)者;
當(dāng)為私有·僅指令的可見成員可用,單擊后將打開可見成員管理抽屜,可進行添加、移除可見成員,注意此處僅允許添加授權(quán)管理中已授權(quán)的開發(fā)者。
啟用或關(guān)閉指令
重要
記得一定要啟用指令,可用范圍內(nèi)的開發(fā)者才可以在通義靈碼靈碼 IDE 插件中使用/喚起指令;
指令啟用后,預(yù)計需要 5~10 分鐘生效,開發(fā)者可在通義靈碼靈碼 IDE 插件中使用。
指令新建完成后,建議進行測試后再開啟比較大范圍的使用者,具體可參考:
修改指令的可見范圍為:私有·僅指令的可見成員可用;
添加指令的可見成員,僅添加需要參與測試的開發(fā)者即可;
打開開啟指令的開關(guān);
可見范圍的開發(fā)者在通義靈碼靈碼 IDE 插件端測試該指令。
當(dāng)測試完成后,可根據(jù)最終需要使用該指令的開發(fā)者范圍進行可用范圍的配置。
當(dāng)你需要關(guān)閉該指令時,單擊開關(guān)關(guān)閉即可,關(guān)閉后,開發(fā)者在通義靈碼靈碼 IDE 插件中使用/喚起指令時,將不可看到該指令。
修改指令信息和配置
在指令詳情中,單擊右上角修改按鈕,即可修改指令的信息。
刪除指令
在指令詳情中,單擊右上角刪除按鈕,確認后即可刪除指令的信息,刪除后不可恢復(fù),請謹慎操作。
開發(fā)者使用指令
在指令可見范圍內(nèi)的開發(fā)者,可在通義靈碼靈碼 IDE 插件的智能問答窗口中,輸入 / 喚起即可。
場景示例
自定義指令配置
指令名稱 |
API 開發(fā)文檔自動生成 |
---|---|
指令名稱(英文) |
generate api docs |
指令描述 |
在分布式系統(tǒng)、前后端分離架構(gòu)(SOA模式)中的需求開發(fā)都是面向 API 的,所以在 API 開發(fā)完成后還要提供與之配套的 API 使用文檔,讓服務(wù)接入方能快速進行開發(fā)與聯(lián)調(diào),本指令可以幫助開發(fā)者快速進行 API 開發(fā)文檔的生成。 |
指令圖標 |
選擇一個即可 |
指令可見范圍 |
根據(jù)訴求選擇 |
提示詞 |
你是一個 Java 專家,有多年的 Java 開發(fā)經(jīng)驗,并且是一個文檔編寫的專家,請按照指定的 Spring MVC 中 RestController 的代碼,以及代碼內(nèi)可以獲取的注釋和你對接口的理解,生成 API 文檔。 請按照如下模板生成對應(yīng)的 API 文檔: 標題:接口名 類型:API 的類型(如 GET or POST or PUT)以及 URl 入?yún)ⅲ阂粋€表格,第一列參數(shù),第二列類型,第三列說明 出參:一個表格,第一列參數(shù),第二列類型,第三列說明 錯誤碼:一個表格,第一列錯誤碼,第二列錯誤碼說明 |
上下文組裝 |
請為如下的代碼#selectedCode 生成 API 接口文檔,輸出格式為 markdown。 |
使用效果示意
更多建議: