靈碼提供了擴充管理,支援自訂指令,滿足企業編碼情境的擴充訴求。
該功能目前僅支援 Visual Studio Code 和 JetBrains IDE 外掛程式,不適用於 Lingma IDE。
適用版本 | 企業專屬版 |
靈碼管理員、組織內全域管理員(專屬版)在靈碼控制台-擴充管理中,進行自訂指令的管理、查看自訂指令的相關資訊和資料。自訂指令可見範圍內的開發人員,在靈碼 中使用/喚起時,即可看到有許可權使用的指令。
如需使用企業級自訂指令功能,請確保將靈碼升級到 V1.4.0 及以上;
指令啟用或修改後,預計需要 5~10 分鐘生效,開發人員可在靈碼 中使用。
自訂指令管理
查看自訂指令
靈碼管理員、組織內全域管理員(專屬版)進入靈碼控制台,單擊左側擴充管理模組,即可看到已建立的自訂指令、靈碼官方指令資訊。

單擊指令卡片,即可進入指令詳情頁面,查看指令的基本資料、可見成員範圍、對話配置等資訊。同時還可以查看指令的使用資料。
建立自訂指令
擴充管理中,單擊建立指令,即進入建立自訂指令頁面:
第一步:基本資料填寫

指令名稱:指令的顯示名稱,1~64個字元,中文、英文、數字等均可;
指令名稱(英文):指令的英文名稱,1~64個字元,必須為大小寫字母、數字、底線、空格,此名稱為開發人員在靈碼 中問答視窗使用
/喚起指令時看到的名稱,請確保規範性、可讀性指令描述:200個字元以內即可,描述指令的使用情境、作用等;
指令表徵圖:指令的識別表徵圖,提供了顏色、表徵圖選擇,可自由組合;
指令可見範圍:
公開·企業內已授權開發人員:選擇後,企業內已授權使用靈碼的開發人員均可使用該指令;
私人·僅指令的可見成員可用:選擇後,可在指令建立完成後,添加可見成員;
第二步:對話配置

提示詞:5000個字元以內,可輸入系統身份提示、要求提示等,如上圖中對於做代碼命名的提示詞設計示意;
上下文組裝:目前提供了
#userInput、#selectedCode的上下文選擇,並可進行 Prompt 組裝的設計,如上圖中對上下文進行組裝的樣本;引入對話歷史:開啟後,將在觸發本指令時,引入目前的交談的上下文內容。
設定可用範圍
指令建立完成後,可在指令詳情頁中進行可見範圍的配置或修改。
當為公開·企業內已授權開發人員時,單擊查看可前往授權管理頁面中查看已授權開發人員;
當為私人·僅指令的可見成員可用,單擊後將開啟可見成員管理抽屜,可進行添加、移除可見成員,注意此處僅允許添加授權管理中已授權的開發人員。

啟用或關閉指令
記得一定要啟用指令,可用範圍內的開發人員才可以在靈碼中使用
/喚起指令;指令啟用後,預計需要 5~10 分鐘生效,開發人員可在靈碼中使用。
指令建立完成後,建議進行測試後再開啟比較大範圍的使用者,具體可參考:
修改指令的可見範圍為:私人·僅指令的可見成員可用;
添加指令的可見成員,僅添加需要參與測試的開發人員即可;
開啟開啟指令的開關;
可見範圍的開發人員在靈碼測試該指令。
當測試完成後,可根據最終需要使用該指令的開發人員範圍進行可用範圍的配置。

當你需要關閉該指令時,單擊開關關閉即可,關閉後,開發人員在靈碼中使用/喚起指令時,將不可看到該指令。
修改指令資訊和配置
在指令詳情中,單擊右上方修改按鈕,即可修改指令的資訊。
刪除指令
在指令詳情中,單擊右上方刪除按鈕,確認後即可刪除指令的資訊,刪除後不可恢複,請謹慎操作。
開發人員使用指令
在指令可見範圍內的開發人員,可在靈碼的智能問答視窗中,輸入 / 喚起即可。

情境樣本
自訂指令配置
指令名稱 | API 開發文檔自動產生 |
指令名稱(英文) | generate api docs |
指令描述 | 在分布式系統、前後端分離架構(SOA模式)中的需求開發都是面向 API 的,所以在 API 開發完成後還要提供與之配套的 API 使用文檔,讓服務接入方能快速進行開發與聯調,本指令可以協助開發人員快速進行 API 開發文檔的產生。 |
指令表徵圖 | 選擇一個即可 |
指令可見範圍 | 根據訴求選擇 |
提示詞 | 你是一個 Java 專家,有多年的 Java 開發經驗,並且是一個文檔編寫的專家,請按照指定的 Spring MVC 中 RestController 的代碼,以及代碼內可以擷取的注釋和你對介面的理解,產生 API 文檔。 請按照如下模板產生對應的 API 文檔: 標題:介面名 類型:API 的類型(如 GET or POST or PUT)以及 URl 入參:一個表格,第一列參數,第二列類型,第三列說明 出參:一個表格,第一列參數,第二列類型,第三列說明 錯誤碼:一個表格,第一列錯誤碼,第二列錯誤碼說明 |
上下文組裝 | 請為如下的代碼 |