将 Amazon Q 业务生成 AI 编码助手连接到您的 GitHub 仓库，使用 Amazon Q

---

使用 Amazon Q GitHub 连接器将 Amazon Q Business 生成式 AI 编码助手连接到您的 GitHub 仓库

关键要点

使用 Amazon Q Business 生成式 AI 助手可以提高开发效率。本文将介绍如何将 GitHub (Cloud) 与 Amazon Q Business 连接，快速获取开发环境中的信息。需要拥有 AWS 账号、GitHub 账号以及必要的访问权限。

在开发生命周期中引入生成式人工智能AI能够带来多重好处。例如，使用基于 AI 的编码助手如Amazon Q Developer可以提高开发生产力，多达 30。此外，减少频繁与多种开发工具之间切换的上下文转换也能进一步提高开发效率。在本篇文章中，我们将介绍开发团队如何利用生成式 AI 快速获取分布在开发环境中的知识。

GitHub (Cloud) 是一个流行的开发平台，帮助团队构建、扩展和交付软件，被全球超过 1 亿开发者和 400 万组织使用。GitHub 帮助开发者托管和管理Git 仓库，进行代码协作，跟踪问题，并通过拉取请求、代码审查以及持续集成和部署CI/CD管道等功能实现工作流程自动化。

Amazon Q Business 是一个完全托管的生成式 AI 助手，旨在提升企业运营效率。您可以通过连接公司数据、信息和系统，定制适合特定业务需求的功能，Amazon Q Business 提供了超过40 个内置连接器。

您可以使用现成的连接器将 GitHub (Cloud) 实例连接至 Amazon Q Business，以提供自然语言接口，帮助您的团队分析 GitHub (Cloud) 组织中包含的仓库、提交、问题和拉取请求。在建立连接并同步数据后，您的团队可以使用 Amazon Q Business 对受支持的 GitHub (Cloud) 数据实体执行自然语言查询，从而简化信息访问。

解决方案概述

要创建 Amazon Q Business 应用以连接到 GitHub 仓库，并利用AWS IAM 身份中心与AWS Secrets Manager的服务，按照以下高层步骤操作：

创建 Amazon Q Business 应用执行数据同步运行示例查询以测试解决方案

下图展示了解决方案架构。

在这篇文章中，我们将展示开发者和其他相关用户如何利用Amazon Q Business 网页体验对索引信息进行基于自然语言的问答。在本次演示中，我们设置了一个专用的 GitHub (Cloud) 组织，包含四个仓库和两个团队审查与开发。两个仓库为私有，仅可供审查团队成员访问，而剩下的两个仓库为公开的，所有成员与团队均可访问。

先决条件

在执行解决方案前，请确保满足以下先决条件：

拥有具有管理员权限的 AWS 账号以管理 Amazon Q Business有权访问提供 Amazon Q Business 服务的 AWS 区域支持的区域启用 IAM 身份中心并添加用户启用 IAM 身份中心指南， 添加用户指南拥有带有组织和仓库的 GitHub 账户创建组织指南拥有 GitHub access token classic创建访问令牌指南， 权限需求

创建、同步和测试一个使用 IAM 身份中心的 Amazon Q Business 应用

要创建 Amazon Q Business 应用，您需要选择检索器，连接数据源，并添加组和用户。

创建应用

在AWS 管理控制台中，搜索Amazon Q Business并选择 Amazon Q Business。

在 Amazon Q Business 登陆页面，选择 开始。

在 Amazon Q Business 应用程序屏幕左下角，选择 创建应用程序。

在 创建应用中提供所需的值。例如，在 应用名称 处输入 anycompanygitapplication。对于 服务访问，选择 创建并使用新服务关联角色 (SLR)。在 与 IAM 身份中心关联的应用 下，记下与 IAM 身份中心实例关联的 ARN。然后选择 创建。

选择检索器

在 选择检索器 下，在 检索器 中选择 使用本地检索器。在 索引容量 中，输入 “1”。

Amazon Q Business 定价基于所选文档索引容量。您可以根据所需容量选择最高 50 单位。每单位最多可以包含 20000 个文档或 200 MB，以先到为准。根据您的用例，可以按需调整此数字。

选择屏幕底部的 下一步。

连接数据源

在 连接数据源 下的搜索栏中，输入 “GitHub” ，点击 GitHub 旁边的加号以选择。选择 下一步 以配置数据源。

您可以使用以下示例创建默认配置，排除常见图像和样式文件。

在 数据源名称 和 描述 中输入 anycompanygitdatasource。

在 GitHub 组织名称 字段中，输入您的 GitHub 组织名称。在 身份验证 下，提供新的访问令牌或选择一个存储在 AWS Secrets Manager 中的现有访问令牌。

在 IAM 角色 下，选择 创建新服务角色，并在 角色名称 下输入数据源名称。

定义 同步范围，选择要同步的仓库和内容类型。

完成 附加配置 和 同步模式。

此可选部分可以通过使用正则表达式模式指定文件名、类型或文件路径来定义同步范围。此外，还可以在数据源内容发生更改时，设置 同步模式 以定义要同步的内容更改类型。

在本篇文章中，在 同步运行计划 下，选择 按需运行，以便您可以手动启动同步过程。也支持其他的自动定期同步运行选项。在 字段映射 部分，保持默认设置。完成检索器创建后，您可以修改字段映射并添加自定义字段属性。您可以通过编辑数据源访问字段映射。

添加组和用户

在测试时，我们将使用两个用户：一个在 GitHub (Cloud) 组织上具有所有仓库的完全权限，另一用户仅在一个特定仓库上具有权限。

选择 添加组和用户。

选择 分配现有用户和组。这将给您显示选择 IAM 身份中心中的用户并将其添加到此 Amazon Q Business 应用的选项。选择 下一步。

在列表中搜索用户的用户名或姓名并选择该用户。重复操作以选择所有您希望测试的用户。

分配所需的订阅给加入的用户。

对于 Web 体验服务访问，使用默认值 创建并使用新服务角色。选择 创建应用程序，并等待应用程序创建过程完成。

安易共存版加速器

执行同步

要将新创建的 Amazon Q Business 应用与所需的数据源同步，请按照以下步骤操作：

在 数据源 下选择新创建的数据源，然后选择 现在同步。

根据源 GitHub (Cloud) 组织中支持的数据实体数量，完成同步过程可能需耗费几分钟。

一旦同步完成，单击数据源名称以显示同步历史记录，包括扫描的对象、添加的对象、删除的对象、已修改的对象和失败的对象数量。此外，您还可以访问相关的Amazon CloudWatch 日志，从中检查同步过程和失败的对象。

访问 Amazon Q Business 应用，在 Web 体验设置 处选择 已部署的 URL。新标签将打开并询问您的登录详细信息。提供您之前创建的用户的详细信息并选择 登录。

运行示例查询以测试解决方案

您现在应该看到 Amazon Q Business 的主屏幕，包括相关的网页体验。现在可以使用自然语言提问，Amazon Q Business 将根据您 GitHub (Cloud) 组织中索引的信息提供答案。

首先，在 输入提示 处输入一个自然语言问题。

您可以询问有关已同步的 GitHub (Cloud) 数据实体的信息。例如，可以输入：“告诉我如何从头开始创建一个新的无服务器应用？” Amazon Q Business 将根据关联的 READMEmd 文件的信息进行回复。

因为您以第一个用户的身份登录，并且映射到属于审查团队的 GitHub (Cloud) 用户，您还可以询问关于该团队成员可以访问的私有仓库的内容。

如下面的屏幕截图所示，您可以询问关于名为 awss3objectmanagement 的私有仓库的问题，并根据该仓库中的 READMEmd 进行响应。

![Amazon Q Business 响应](https//d2908q01vomqb2cloudfrontnet/f1f836cb4ea6efb2a0b1b99f41ad8b103eff4b59/2024/08/16/ML16589image022s

• • 2026-01-27 14:02:20
  • 7