企業代碼生成增強
通義靈碼提供了基于企業代碼庫進行行間代碼生成檢索增強的能力,在開發者使用通義靈碼 IDE 插件的行間代碼生成時,可以結合企業上傳的代碼庫作為上下文進行行間代碼補全,使代碼補全更加貼合企業代碼規范、業務特點。
適用版本 | 企業標準版、企業專屬版 |
通義靈碼管理員、組織內全局管理員(專屬版)可以在通義靈碼管理控制臺的知識管理中進行代碼壓縮包的添加或刪除,開啟或關閉檢索增強功能。
企業知識庫管理
通義靈碼管理員、組織內全局管理員(專屬版)可以進行企業知識庫的管理,包括新建知識庫、編輯/刪除知識庫、添加/移除知識庫可見成員、添加或移除知識庫內代碼壓縮包等。
知識庫創建、編輯與刪除
新建知識庫
通過單擊側邊欄上的知識管理按鈕,進入知識管理頁面;
在知識管理頁面,點擊新建知識庫按鈕;
在彈出的創建知識庫表單中,輸入以下信息:
設定應用場景為行間代碼生成;
填寫知識庫名稱,建議命名清晰,便于識別;
(可選)提供一段描述以概述知識庫的內容或用途;
選擇知識庫成員的可見范圍,默認設置為私有,即僅對知識庫成員可見。
完成上述信息填寫后,點擊確定按鈕提交;
創建成功后,返回知識管理頁面,將在知識庫列表中看到新建的知識庫。
編輯知識庫
可通過以下兩種方式修改知識庫的基本信息,包括知識庫的名稱、描述與可見范圍:
從知識管理頁面編輯:在知識庫列表中選擇對應知識庫,點擊編輯圖標,即可進入知識庫編輯模式;
知識庫內頁面:進入對應知識庫內,點擊編輯按鈕,進入編輯模式。
刪除知識庫
進入對應知識庫內,點擊刪除按鈕,通過輸入知識庫名稱進行二次確認,可刪除該知識庫。
知識庫刪除后不可恢復,如有需要可重新創建知識庫并添加數據。
上傳代碼壓縮包
通義靈碼管理員、組織內全局管理員(專屬版)可以進行知識庫內知識數據的管理,上傳步驟如下:
單擊添加數據按鈕,即可進入添加數據頁面;
數據類型為代碼,單擊或拖拽文件到上傳區域(灰色區域)即可上傳代碼庫壓縮包,上傳文
件時需要注意以下要求:
一次上傳 1 個代碼庫壓縮包;
文件格式支持:zip、gz、tar.gz;
單個文件大小不超過 100MB;
文件名稱不得超過 200 個字符,文件編碼僅支持 utf-8、gbk編碼;
推薦使用有層級的結構化文檔,避免檢索信息內容的缺失。
上傳完成后,單擊確認添加即可成功添加,相關壓縮包會進入數據處理流程。
代碼知識庫不建議以業務庫作為知識庫內容,建議以常用的二方包源碼、工具庫等作為知識庫以提升行間生成補全質量。
開啟或關閉行間代碼生成檢索增強
代碼庫壓縮包完成數據處理后,即可開啟行間代碼生成檢索增強的開關。可通過以下兩種方式:
知識管理頁面:在知識庫列表中選擇對應知識庫,開啟或關閉檢索增強功能開關;
知識庫詳情頁面:進入對應知識庫內,開啟或關閉檢索增強功能開關。
開啟后,已授權的開發者在 IDE 客戶端中使用通義靈碼行間代碼智能生成的功能時,將結合上傳的代碼數據進行代碼建議生成。
場景示例
通常情況下,前端團隊會維護一套統一的編碼規范,以便團隊中前端工程師參考和遵循。例如,在使用 ReactJS 開發時,通常會有清晰的 bad case / good case 定義,確保 Props 的編寫既清晰又高效,避免潛在的不良編碼習慣。
import React from 'react'
type Props = {
children:react.reactnode;
}
// bad
const lndex = (props: Props)=> {
return <>{props.children}</>
}
// bad
const Index<Props>=({ children }) => {
return <>{children}</>
}
// good
const Index: React.FC<Props> = (props) => {
return <>{props.children}</>
}
這種情況下,可以通過通義靈碼的代碼庫生成增強達成,操作步驟如下:
通義靈碼管理員在管理后臺中,上傳符合編碼規范的代碼倉庫壓縮包,例如:Ant Design:作為 UI 設計的典范,遵循嚴格的 React 組件設計規范;
開啟行間代碼生成檢索增強;
團隊中前端工程師在 IDE 端中安裝并開啟通義靈碼插件;
前端工程師在代碼編輯器中進行編碼時,通義靈碼可以遵循上傳的代碼庫的中的編碼規范進行代碼建議生成,如下圖:
知識庫可見范圍管理
通義靈碼管理員、組織內全局管理員(專屬版)可以變更企業知識庫的可見范圍,有以下兩種方式:
通過編輯知識庫,修改知識庫的可見范圍;
進入知識庫,點擊可見成員標簽,添加或移除該知識庫可見成員。
當知識庫開啟檢索增強功能后,企業開發者在IDE端使用#teamDocs功能進行行間代碼生成時,通義靈碼會結合該企業開發者可見范圍內的知識庫數據進行代碼生成。
查看代碼庫的數據處理進展
代碼庫壓縮包上傳后,系統將對數據進行向量持久化處理,以將代碼處理成可以供檢索增強的格式,并且可在代碼庫列表中查看數據處理的進度。文件處理的狀態分別為:
等待處理:系統將有序對上傳的文件進行處理,未開始處理的進入排隊狀態;
處理中:正在對文件進行分析和向量化處理;
已完成:該文件已完成分析并向量持久化;
異常:文件處理出現異常,聚焦在狀態標記上可查看原因,此時可結合不同的情況進行重新處理或刪除異常文件;
重復文件:文件內容重復,不進行重復處理,可刪除重復文件;
更新代碼庫
如果代碼庫有更新,可直接通過添加數據的操作上傳新的文件,上傳后將進行重新處理。
刪除代碼庫
處理異常、重復、或不再需要的代碼庫,可單擊刪除操作進行單個代碼庫的刪除。如需批量刪除,可在列表中勾選后進行批量刪除。