企業程式碼程式庫產生增強_通義靈碼_智能編碼助手 - AI Coding Assistant Lingma

靈碼提供了基於企業程式碼程式庫進行行間代碼產生檢索增強能力，在開發人員使用靈碼的行間代碼產生時，可以結合企業上傳的程式碼程式庫作為上下文進行行間代碼補全，使代碼補全更加貼合企業代碼規範、業務特點。

重要

該功能目前僅支援 Visual Studio Code 和 JetBrains IDE 外掛程式，不適用於 Lingma 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功能進行行間代碼產生時，靈碼會結合該企業開發人員可見範圍內的知識庫資料進行代碼產生。

查看程式碼程式庫的資料處理進展

程式碼程式庫壓縮包上傳後，系統將對資料進行向量持久化處理，以將代碼處理成可以供檢索增強格式，並且可在程式碼程式庫列表中查看資料處理的進度。檔案處理的狀態分別為：

等待處理：系統將有序對上傳的檔案進行處理，未開始處理的進入排隊狀態；
處理中：正在對檔案進行分析和向量化處理；
已完成：該檔案已完成分析並向量持久化；
異常：檔案處理出現異常，聚焦在狀態標記上可查看原因，此時可結合不同的情況進行重新處理或刪除異常檔案；
重複檔案：檔案內容重複，不進行重複處理，可重複資料刪除檔案；

更新程式碼程式庫

如果程式碼程式庫有更新，可直接通過添加資料的操作上傳新的檔案，上傳後將進行重新處理。

刪除程式碼程式庫

處理異常、重複、或不再需要的程式碼程式庫，可單擊刪除操作進行單個程式碼程式庫的刪除。如需大量刪除，可在列表中勾選後進行大量刪除。