代码库索引
华为云码道(CodeArts)代码智能体支持代码库索引功能,帮助您在代码库中快速检索并获取相关信息。
代码库索引支持本地创建的个人索引和云端创建的团队索引。
约束与限制
| 限制类别 | 具体限制 |
|---|---|
| 功能 | 仅支持在JetBrains系列工具(PyCharm、IntelliJ IDEA、WebStorm及CLion)中使用。 |
| 语言 | 支持Java、ArkTS、JavaScript、TypeScript、Python。 |
| 代码文件总数 |
|
本地个人索引和云端团队索引的差异
| 对比维度 | 本地个人索引 | 云端团队索引 |
|---|---|---|
| 使用者 | 当前用户 |
|
| 仓库类型 | 不限制 | 支持Git、Repo和Github三种仓库。 |
前提条件
已启用席位,若未启用,会导致构建索引失败。
创建索引
以下介绍创建本地个人索引和创建云端团队索引具体步骤。
- 参考JetBrains中操作,登录华为云码道。
- 在聊天界面的输入框中,将模型切换为“智能问答”或“智能体”。
- 单击右上角
,进入代码库索引的配置页面。 - 通过以下方法,开启索引。
- 自动构建代码库索引:开启“自动更新”后,华为云码道将自动为文件数量≤50000的代码库创建并更新索引。
开启该功能后,华为云码道将每5分钟执行一次增量更新,以确保智能体始终基于最新代码进行分析与响应。
- 手动构建代码库索引:本地代码库中文件数量>50000个时,需要您单击“开始索引”,手动构建代码库索引。
- 自动构建代码库索引:开启“自动更新”后,华为云码道将自动为文件数量≤50000的代码库创建并更新索引。
- 索引开启成功后,页面显示进度为100%。 图1 索引成功
- 在智能问答模式下使用代码库索引时,需先打开代码库索引开关。
代码索引完成后(图标为
),在聊天窗口的输入框下方单击代码库索引搜索图标
,即可一键启用代码库索引功能。
- 进入码道代码智能体控制台。
- 在左侧导航栏选择“智能体设置 > 代码库索引”,进入“代码库索引”页面。
- 单击“新建索引”,进入新建代码库索引页面。
- 参考表3,设置代码库索引参数。 图2 新建代码库索引
表3 代码库索引参数说明 参数
说明
可见范围
定义代码库索引的可见范围。
- 个人:仅成员本人可用。
- 团队:仅本团队成员可用,由企业管理员或团队管理员创建。
- 企业:整个企业所有成员都可用,由企业管理员创建。
可用团队
“可见范围”设置为“团队”时,才会显示该配置项。
指定可使用该代码库索引的团队。
代码源
选择您想要索引的代码仓库来源。
- Repo:可能指内部自研的“代码仓库”系统。
- Git:通用Git仓库。
- Github:GitHub上的公开或授权私有仓库。
选择项目
“代码源”设置为“Repo”时,才会显示该配置项。
从已关联的代码源中,选择具体要索引的项目。
获取授权
选择一种方式来授权系统访问您的代码源。
- 通过服务授权:在下拉框中选择服务扩展点,该扩展点对应Repo、Github或Git仓库的连接信息。
若还未创建服务扩展点,单击“添加”,参考表4创建服务扩展点。
- 通过个人访问令牌:使用用户个人账户生成的访问令牌进行认证。
默认分支
“代码源”设置为“Git”时,才会显示该配置项。
输入Git仓库的分支名称,分支名称不能超过200个字符。
图3 新建服务扩展点
表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。
- 单击“验证并确定”,完成代码库索引的创建。
在代码库仓索引页面,查看新创建的代码库索引。当该代码库索引的状态由“解析中”变为“解析完成”时,表示解析代码库索引成功。
- 返回到JetBrains界面,打开Git/Repo/Github仓库项目,华为云码道自动从云端下载团队代码库索引。
团队代码库索引下载成功后,页面显示进度为100%。
- 在智能问答模式下使用代码库索引时,需先打开代码库索引开关。
代码索引完成后(图标为
),在聊天窗口的输入框下方单击代码库索引搜索图标
,即可一键启用代码库索引功能。
管理代码库索引
代码库索引除了创建外,还支持重启、删除等操作,具体参见表5。
代码库索引图标说明
| 图标 | 说明 |
|---|---|
|
| 图标为灰色,表示代码库索引尚未构建。 |
|
| 图标在灰白间交替闪烁,表示代码库索引正在构建中。 |
|
| 图标为绿色,表示代码库索引已成功构建,状态正常,可正常使用。 |
|
| 图标为黄色,表示索引文件数量等于大于50000个,处于负载预警状态。 |
|
| 图标为红色,表示索引操作失败。 |


