Qoder CN 提供了基于企业代码库进行行间代码生成检索增强的能力,在开发者使用 Qoder CN 的行间代码生成时,可以结合企业上传的代码库作为上下文进行行间代码补全,使代码补全更加贴合企业代码规范、业务特点。
Qoder CN 管理员、组织内全局管理员(专属版)可以在 Qoder CN管理控制台的知识管理中进行代码压缩包的添加或删除,开启或关闭检索增强功能。
Qoder CN 管理员、组织内全局管理员(专属版)可以进行企业知识库的管理,包括新建知识库、编辑/删除知识库、添加/移除知识库可见成员、添加或移除知识库内代码压缩包等。
新建知识库
Qoder CN 管理员、组织内全局管理员(专属版)可以进行知识库内知识数据的管理,上传步骤如下:
代码库压缩包完成数据处理后,即可开启行间代码生成检索增强的开关。可通过以下两种方式:
通常情况下,前端团队会维护一套统一的编码规范,以便团队中前端工程师参考和遵循。例如,在使用 ReactJS 开发时,通常会有清晰的 bad case / good case 定义,确保 Props 的编写既清晰又高效,避免潜在的不良编码习惯。
这种情况下,可以通过 Qoder CN 的代码库生成增强达成,操作步骤如下:
Qoder CN 管理员、组织内全局管理员(专属版)可以变更企业知识库的可见范围,有以下两种方式:
代码库压缩包上传后,系统将对数据进行向量持久化处理,以将代码处理成可以供检索增强的格式,并且可在代码库列表中查看数据处理的进度。文件处理的状态分别为:
如果代码库有更新,可直接通过添加数据的操作上传新的文件,上传后将进行重新处理。
处理异常、重复、或不再需要的代码库,可单击删除操作进行单个代码库的删除。如需批量删除,可在列表中勾选后进行批量删除。
适用版本:企业标准版、企业专属版
企业知识库管理
Qoder CN 管理员、组织内全局管理员(专属版)可以进行企业知识库的管理,包括新建知识库、编辑/删除知识库、添加/移除知识库可见成员、添加或移除知识库内代码压缩包等。
知识库创建、编辑与删除
新建知识库
- 通过单击侧边栏上的知识管理按钮,进入知识管理页面;
- 在知识管理页面,点击新建知识库按钮;
- 在弹出的创建知识库表单中,输入以下信息:
- 设定应用场景为行间代码生成;
- 填写知识库名称,建议命名清晰,便于识别;
- (可选)提供一段描述以概述知识库的内容或用途;
- 选择知识库成员的可见范围,默认设置为私有,即仅对知识库成员可见。
- 完成上述信息填写后,点击确定按钮提交;
- 创建成功后,返回知识管理页面,将在知识库列表中看到新建的知识库。
- 从知识管理页面编辑:在知识库列表中选择对应知识库,点击编辑图标,即可进入知识库编辑模式;
- 知识库内页面:进入对应知识库内,点击编辑按钮,进入编辑模式。
上传代码压缩包
Qoder CN 管理员、组织内全局管理员(专属版)可以进行知识库内知识数据的管理,上传步骤如下:
- 单击添加数据按钮,即可进入添加数据页面;
- 数据类型为代码,单击或拖拽文件到上传区域(灰色区域)即可上传代码库压缩包,上传文件时需要注意以下要求:
- 上传完成后,单击确认添加即可成功添加,相关压缩包会进入数据处理流程。
代码知识库不建议以业务库作为知识库内容,建议以常用的二方包源码、工具库等作为知识库以提升行间生成补全质量。
开启或关闭行间代码生成检索增强
代码库压缩包完成数据处理后,即可开启行间代码生成检索增强的开关。可通过以下两种方式:
- 知识管理页面:在知识库列表中选择对应知识库,开启或关闭检索增强功能开关;
- 知识库详情页面:进入对应知识库内,开启或关闭检索增强功能开关。
场景示例
通常情况下,前端团队会维护一套统一的编码规范,以便团队中前端工程师参考和遵循。例如,在使用 ReactJS 开发时,通常会有清晰的 bad case / good case 定义,确保 Props 的编写既清晰又高效,避免潜在的不良编码习惯。
- Qoder CN 管理员在管理后台中,上传符合编码规范的代码仓库压缩包,例如:Ant Design:作为 UI 设计的典范,遵循严格的 React 组件设计规范;
- 开启行间代码生成检索增强;
- 团队中前端工程师在 IDE 端中安装并开启 Qoder CN;
- 前端工程师在代码编辑器中进行编码时,Qoder CN 可以遵循上传的代码库的中的编码规范进行代码建议生成。
知识库可见范围管理
Qoder CN 管理员、组织内全局管理员(专属版)可以变更企业知识库的可见范围,有以下两种方式:
- 通过编辑知识库,修改知识库的可见范围;
- 进入知识库,点击可见成员标签,添加或移除该知识库可见成员。
当知识库开启检索增强功能后,企业开发者在IDE端使用#teamDocs功能进行行间代码生成时,Qoder CN 会结合该企业开发者可见范围内的知识库数据进行代码生成。
查看代码库的数据处理进展
代码库压缩包上传后,系统将对数据进行向量持久化处理,以将代码处理成可以供检索增强的格式,并且可在代码库列表中查看数据处理的进度。文件处理的状态分别为:
- 等待处理:系统将有序对上传的文件进行处理,未开始处理的进入排队状态;
- 处理中:正在对文件进行分析和向量化处理;
- 已完成:该文件已完成分析并向量持久化;
- 异常:文件处理出现异常,聚焦在状态标记上可查看原因,此时可结合不同的情况进行重新处理或删除异常文件;
- 重复文件:文件内容重复,不进行重复处理,可删除重复文件;