代码库索引
华为云码道(CodeArts)代码智能体提供了代码库索引功能,帮助您快速检索并获取代码相关信息。该功能支持创建本地个人索引与云端共享索引,灵活适配不同场景需求。
约束与限制
| 限制类别 | 具体限制 |
|---|---|
| 语言 | 支持Java、JavaScript、TypeScript和Go。 |
| 代码文件总数 |
|
| 功能限制 | 仅码道代码智能体基础版和专业版支持创建云端团队级和企业级代码库索引。 |
本地个人索引和云端索引的差异
| 对比维度 | 本地个人索引 | 云端索引 |
|---|---|---|
| 使用者 | 当前用户 |
|
| 仓库类型 | 不限制 | 支持Git、Repo和Github三种仓库。 |
前提条件
企业管理员创建团队级代码库索引前,须先加入团队。
创建索引
以下介绍创建本地个人索引和创建云端索引的具体步骤。
- 参考快速启动操作,登录华为云码道。
- 单击华为云码道IDE右上角的设置图标
,进入华为云码道IDE全局设置页面。 - 在设置页面的左侧导航栏中,选择“代码库索引”。
- 开启索引功能。
- 自动构建索引:开启“自动更新”后,华为云码道将自动为文件数量≤50000的代码库创建并更新索引。
开启该功能后,华为云码道将每5分钟执行一次增量更新,以确保智能体始终基于最新代码进行分析与响应。
- 手动构建索引:本地代码库中文件数量>50000个时,需要您单击“开始索引”,手动构建代码库索引。
- 自动构建索引:开启“自动更新”后,华为云码道将自动为文件数量≤50000的代码库创建并更新索引。
- 查看索引构建结果。
索引构建成功后,页面会显示进度至100%。
图1 索引构建成功
- (可选)在智能问答模式下使用代码库索引。
在智能问答模式下使用代码库索引,需要先确保索引构建已完成。随后在聊天窗口的输入框下方单击代码库索引搜索图标
,当图标变为
时,说明索引功能已启用。
账号已启用席位,若席位未启用,将导致云端代码库索引创建失败。
- 进入码道代码智能体控制台。
- 在左侧导航栏选择“智能体设置 > 代码库索引”,进入代码库索引页面。
- 单击“新建索引”,进入新建代码库索引页面。
- 参考表3,设置索引基本信息,单击“下一步”。
表3 代码库索引参数说明 参数
说明
可见范围
定义代码库索引的可见范围。仅码道代码智能体基础版和专业版,支持创建云端团队和企业代码库索引。
- 个人:仅成员本人可用。
- 团队:仅本团队成员可用,由企业管理员、团队管理员或团队成员创建。
- 企业:所有企业成员都可用,由企业管理员、团队管理员、团队成员或企业成员创建。
可用团队
“可见范围”设置为“团队”时,才会显示该配置项。
在下拉列表中选择团队,仅展示当前账号所属团队。
代码源
选择您想要索引的代码仓库来源。
- Repo:代码托管(CodeArts Repo)中的仓库。
- Git:通用Git仓库。
- Github:GitHub平台仓库,支持公开仓库及经授权的私有仓库。
选择项目
“代码源”设置为“Repo”时,才会显示该配置项。
从已关联的代码源中,选择具体要索引的项目。
获取授权
选择一种方式来授权系统访问您的代码源。
- 通过服务授权:在下拉框中选择服务扩展点,该扩展点对应Repo、Github或Git仓库的连接信息。
若还未创建服务扩展点,单击“添加”,参考表4创建服务扩展点。
- 通过个人访问令牌:使用用户个人账户生成的访问令牌进行认证。
默认分支
“代码源”设置为“Git”时,才会显示该配置项。
输入Git仓库的分支名称,分支名称不能超过200个字符。
图2 新建服务扩展点
表4 服务扩展点参数说明 参数
说明
连接名称
自定义连接仓库的名称。
命名规范:由中文、英文、数字、下划线和中划线组成,不能以下划线开头。
Git仓库Url
“代码源”设置为“Repo”或“Git”时,才显示该配置项。
Repo/Git仓库的HTTPS访问地址。
用户名
“代码源”设置为“Repo”或“Git”时,才显示该配置项。
Repo/Git仓库HTTPS协议的认证用户名。
密码或Access Token
“代码源”设置为“Git”时,才显示该配置项。
Git仓库HTTPS协议的认证密码或Access Token。
Access Token
“代码源”设置为“Repo”或“Github”时,才显示该配置项。
Repo/Github仓库HTTPS协议的Access Token。
- 选择代码库和语言,单击“确定”,完成代码库索引的创建。
在代码库仓索引页面,查看新创建的代码库索引。当该代码库索引的状态由“解析中”变为“解析完成”时,表示解析代码库索引成功。
- 返回到华为云码道IDE客户端,打开Git/Repo/Github仓库项目,华为云码道自动从云端下载团队代码库索引。
团队代码库索引下载成功后,页面显示进度为100%。
如果仓库中文件数量>50000个,请单击“开始索引”,手动构建代码库索引。
- (可选)在智能问答模式下使用代码库索引。
在智能问答模式下使用代码库索引,需要先确保索引构建已完成。随后在聊天窗口的输入框下方单击代码库索引搜索图标
,当图标变为
时,说明索引功能已启用。
管理代码库索引
代码库索引构建完成后,支持对其进行全生命周期管理。
本地代码库索引除了创建外,还支持重启、删除等操作,具体参见表5。
| 操作 | 操作指导 |
|---|---|
| 暂停索引 | 在代码库索引构建过程中,如果您想停止构建,可以单击“暂停”。 |
| 重启索引 | 如果需要恢复已暂停的索引构建,可单击“重启”继续执行。 |
| 同步更新 | 执行增量索引更新,即系统会对比当前状态与上一次增量更新的结果,仅对新增或修改过的代码文件进行索引,跳过未变更文件以节省时间。 |
| 重新索引 | 如果需要从头开始重建索引,可单击“重新索引”触发完整索引流程。 |
| 删除索引 | 如果需要清除当前所有索引数据,可单击“删除索引”进行清理。 |
| 忽略当前目录中的文件 | 如果您期望忽略指定代码文件的索引,可以单击“配置”,在“.codebaseignore”中指定当前目录下希望忽略的代码文件。 |
表6展示了不同角色对删除代码库索引的操作权限差异,具体如下:
| 角色 | 企业级代码库索引 | 团队级代码库索引 | 个人级代码库索引 |
|---|---|---|---|
| 企业管理员 | 可删除所有代码库索引 | 可删除企业管理员所属团队的代码库索引 | 可删除本人创建的代码库索引 |
| 团队管理员 | 可删除本人创建的代码库索引 | 可删除本团队成员创建的代码库索引 | 可删除本人创建的代码库索引 |
| 团队成员 | 可删除本人创建的代码库索引 | 可删除本人创建的代码库索引 | 可删除本人创建的代码库索引 |
| 企业成员 | 可删除本人创建的代码库索引 | 无任何操作权限 | 可删除本人创建的代码库索引 |
| 操作 | 具体步骤 |
|---|---|
| 删除指定代码库索引 | 索引数量较少时,逐条删除操作更直观灵活,便于精准定位并清除目标索引。
|
| 批量删除代码库索引 | 手动逐条删除索引效率较低,您还可以通过以下方式批量删除索引,快速清理冗余索引。
|