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