配置和使用 Gemini Code Assist 代码自定义

本文档介绍了如何通过将 Gemini Code Assist 连接到您的私有代码库来设置 Gemini Code Assist 代码自定义。借助此功能，您可以接收代码建议，这些建议会参考贵组织的内部库、专用 API 和编码样式。

准备工作

选择要关联的私有代码库

最佳实践是，确保您关联的代码库：

  • 代码的样式或结构与您希望开发者编写的代码类似。
  • 您有要从当前代码库调用的私有库或 API。

（可选）选择要排除索引的文件

默认情况下，代码自定义会为您指定的代码库中的所有受支持的代码文件编制索引。

在许多情况下，您可能有特定的文件或子树不希望编入索引。例如：

  • 在贵组织内仅限特定人员访问的高度敏感信息
  • 旧代码或已废弃的代码
  • 自动生成的代码或临时代码

为了防止公开您不想编入索引的代码，您可以使用分支模式来控制对索引的访问权限，并使用稳定的分支（例如 main）。

或者，您也可以通过创建 .aiexclude 文件将文件从索引中排除。

创建索引

代码自定义功能依赖于索引来分析和解析您的代码库，以便更快地生成代码建议和进行查询。

如需创建索引，请在 shell 环境中使用 gemini code-repository-indexes create 命令：

gcloud gemini code-repository-indexes create INDEX_NAME \
    --project=PROJECT_ID \
    --location=REGION

替换以下内容：

  • INDEX_NAME：您的索引名称。重要提示：请记下索引名称。您需要在本文档中的多个步骤中使用此 ID。
  • PROJECT_ID：您的 Google Cloud 项目 ID。
  • REGION：您已在 Google Cloud 项目的 Developer Connect 中配置的受支持区域（如本页开始前须知部分所述）。

索引创建通常需要 30 分钟才能完成，但最长可能需要 1 小时。

Google 限制每个项目和组织的代码库索引数量为 1。

使用代码库组控制对索引的访问权限

代码库组是用于编制索引配置的容器，其中包括代码库及其分支模式。代码库组专为实现精细的 IAM 控制而设计，可让开发者访问这些组中已编入索引的数据（前提是他们拥有 cloudaicompanion.repositoryGroups.use 权限）。

代码库组包含来自同一项目和位置的 Developer Connect 代码库或关联。

管理员执行以下操作：

  • 创建代码库索引资源。
  • 在同一项目和位置中，配置新的 Developer Connect 连接。
  • 在关联中关联 Git 代码库。
  • 获取关联的资源名称，为每个关联选择要编入索引的分支模式，并将其放入一个或多个代码库组。

如需创建代码库组，请在 shell 环境中使用 gemini code-repository-indexes repository-groups create 命令：

    gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
        --project=PROJECT_ID \
        --location=REGION \
        --code-repository-index=INDEX_NAME \
        --repositories='[{"resource": "REPOSITORY_RESOURCE_NAME", "branchPattern": "BRANCH_NAMES"}]'

替换以下内容：

  • REPOSITORY_GROUP：代码库组的名称，例如 default。
  • PROJECT_ID：您的 Google Cloud 项目 ID。
  • REGION：您已在 Google Cloud 项目的 Developer Connect 中配置的受支持区域（如本页的开始前须知部分所述）。
  • INDEX_NAME：您在上一步中创建索引时创建的索引的名称。
  • REPOSITORY_RESOURCE_NAME：Developer Connect 连接中的代码库名称。如需查找代码库的名称，请前往 Google Cloud 控制台中的 Developer Connect 页面，然后在代码库标签页中，在表格的连接列下方查找连接 ID。如需复制资源名称，请点击 more_vert 菜单以查看更多选项，然后选择复制资源路径。
  • BRANCH_NAMES：要编入索引的分支的名称，例如 main|dev。

您还可以使用 JSON（或 YAML）文件中定义的代码库创建代码库组，格式如下所示：

JSON

[
  {
      "resource": "REPOSITORY_RESOURCE_NAME", "branchPattern": "main|dev"
  },
  {
      "resource": "REPOSITORY_RESOURCE_NAME", "branchPattern": "dev"
  }
]

YAML

- resource: REPOSITORY_RESOURCE_NAME
  branchPattern: main|dev

- resource: REPOSITORY_RESOURCE_NAME
  branchPattern: dev

如需根据 JSON 或 YAML 文件创建代码库组，请在 shell 环境中使用 gemini code-repository-indexes repository-groups create 命令：

JSON

gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME \
    --repositories=FILEPATH.json

YAML

gcloud gemini code-repository-indexes repository-groups create REPOSITORY_GROUP \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME \
    --repositories=FILEPATH.yaml

向项目的代码库群组授予 IAM 角色

您只会收到索引中代码库的建议。每个代码库都属于一个或多个代码库组。如需访问建议，您必须通过以下任一方式向代码库群组授予 Cloud AI Companion 代码库群组用户 IAM 角色 (roles/cloudaicompanion.repositoryGroupsUser)（其中包含所需的 cloudaicompanion.repositoryGroups.user IAM 权限）：

  • 向主账号授予访问整个索引的权限。
  • 向主账号授予对索引子集的访问权限。

向主账号授予访问整个索引的权限

  1. 如需为项目绑定 IAM 政策，请在 shell 环境中使用 projects add-iam-policy-binding 命令：

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member='PRINCIPAL' \
    --role='roles/cloudaicompanion.repositoryGroupsUser'

    替换以下内容：

    • PROJECT_ID：代码库组所在项目的 ID。
    • PRINCIPAL：需要访问权限的主账号的电子邮件地址，例如个人的电子邮件地址为 user:test-user@gmail.com，群组的电子邮件地址为 group:admins@example.com。

    如需了解详情，请参阅 gcloud projects set-iam-policy。

  2. 当系统提示您指定条件时，输入 None。

向主账号授予对索引的一部分的访问权限

您可以创建多个代码库组，并向不同的 IAM 正文分配 IAM 角色。

如需设置 IAM 政策，您必须准备 IAM 政策 JSON 或 YAML 文件，其中将包含 IAM 组和分配的角色的列表。例如：

bindings:
- members:
  - group:my-group@example.com
  - user:test-user@example.com
  role: roles/cloudaicompanion.repositoryGroupsUser

如需了解更多详情和语法，请参阅了解允许政策。

如需设置 IAM 政策，请在 shell 环境中使用 gemini code-repository-indexes repository-groups set-iam-policy 命令：

gcloud gemini code-repository-indexes repository-groups set-iam-policy GROUP_NAMEPOLICY_FILE \
    --project=PROJECT_ID \
    --location=REGION \
    --code-repository-index=INDEX_NAME

替换以下内容：

查看索引编制状态

索引编制内容最长可能需要 24 小时，具体取决于您要编制的代码库数量及其大小。对于大型代码库，编制索引可能需要更长时间。索引编制每 24 小时进行一次，会收集代码库中所做的任何更改。

  1. 搜索 indexing 日志。如需了解详情，请参阅 Logging 查询语言。

    控制台

    1. 在 Google Cloud 控制台中，前往日志浏览器。

      转到 Logs Explorer

    2. 使用日志名称过滤条件查看 indexing 日志。

    gcloud

    如需搜索索引编制日志，请在 shell 环境中使用 logging read 命令：

    gcloud logging read "logName="projects/PROJECT_ID/logs/indexing""

    将 PROJECT_ID 替换为仓库组所在的项目 ID。

    例如，如需查看 indexing 日志中的错误，请运行以下命令：

    gcloud logging read "logName="projects/PROJECT_ID/logs/indexing" AND severity>=ERROR"

  2. 查看关联的索引编入状态，例如：

    • 代码库编入索引的起始位置，例如 Indexing repository REPOSITORY_NAME. Total number of repositories: 10, succeeded: 6, failed: 0.
    • 结束单个代码库索引编制 - 例如：
      • 成功：Successfully finished indexing repository REPOSITORY_NAME. Total number of repositories: 10, succeeded: 7, failed: 0.
      • 失败：Failed to index repository REPOSITORY_NAME. Error: [<error message>]. Total number of repositories: 10, succeeded: 7, failed: 1.
    • 代码库索引编制结束，例如：
      • 成功：Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 0.
      • 失败：Finished indexing process. Repositories attempted: 10. Repositories successfully indexed: 9. Repositories unsuccessfully fetched: 1. Repositories that were not successfully fetched will be retried in the next run.

    在索引状态中，REPOSITORY_NAME 是您要查看的代码库。

  3. 查看相关的索引编制错误，例如：

    • 未能提取代码库。
    • 未能列出代码库文件。
    • 无法从索引检索到代码库信息。
    • 未能从索引检索到文件。
    • 内部错误。

使用代码自定义

设置代码自定义后，用户将开始看到代码补全和代码生成建议，这些建议可能基于您已编入索引的私有代码，以及来自完整代码库感知的结果。

关闭代码自定义

  1. 如需在 shell 环境中列出当前索引的所有代码库组，请使用 gemini code-repository-indexes repository-groups list 命令：

    gcloud gemini code-repository-indexes repository-groups list --location=REGION \
    --project=PROJECT_ID \
    --code-repository-index=INDEX_NAME --uri

    替换以下内容：

    • REGION：您已在 Google Cloud 项目的 Developer Connect 中配置的受支持区域（如本页开始前须知部分所述）。
    • PROJECT_ID：您的 Google Cloud 项目 ID。
    • INDEX_NAME：您在上一步中创建索引时创建的索引的名称。

  2. 如需从当前索引中删除代码库组，请使用 gemini code-repository-indexes repository-groups delete 命令：

    gcloud gemini code-repository-indexes repository-groups delete REPOSITORY_GROUP \
    --location=REGION \
    --project=PROJECT_ID \
    --code-repository-index=INDEX_NAME

  3. 对每个代码库组重复第 3 步，直到从索引中删除所有代码库组。

  4. 可选：如需删除该索引，请在 shell 环境中使用 gemini code-repository-indexes delete 命令：

    gcloud gemini code-repository-indexes delete INDEX_NAME \
    --location=REGION \
    --project=PROJECT_ID

后续步骤