Amazon Q Business - API 参考
Amazon Q Business 是一款人工智能聊天助手，可帮助企业提高员工生产力。它可以回答问题、查找信息、撰写电子邮件、总结文本，甚至集思广益。
创建 Amazon Q Business 应用程序
所有 Amazon Q Business 应用程序环境操作均在控制台和使用 API 上受支持。
| API 操作 | API 描述 |
|---|---|
| CreateApplication | 创建 Amazon Q Business 应用程序 |
| DeleteApplication | 删除 Amazon Q Business 应用程序 |
| GetApplication | 获取有关现有 Amazon Q Business 应用程序的信息 |
| ListApplications | 列出现有的 Amazon Q Business 应用程序 |
| UpdateApplication | 更新现有的 Amazon Q Business 应用程序 |
创建索引
您无法直接在 AWS 管理控制台中为 Amazon Q Business 创建或管理索引。当您创建检索器时，控制台会自动创建索引。您在控制台中可以对索引执行的唯一操作是标记它们。
| API 操作 | API 说明 |
|---|---|
| CreateIndex | 创建 Amazon Q Business 索引 |
| DeleteIndex | 删除 Amazon Q Business 索引 |
| GetIndex | 获取有关现有 Amazon Q Business 索引的信息 |
| ListIndices | 列出现有 Amazon Q Business 索引 |
| UpdateIndex | 更新现有的 Amazon Q Business 索引 |
创建检索器
Amazon Q Business 支持通过控制台和 API 创建检索器。
| API 操作 | API 说明 |
|---|---|
| CreateRetriever | 创建 Amazon Q Business 或 Amazon Kendra 检索器 |
| DeleteRetriever | 删除 Amazon Q Business 或 Amazon Kendra 检索器 |
| GetRetriever | 获取有关现有 Amazon Q Business 或 Amazon Kendra 检索器的信息 |
| ListRetrievers | 列出现有 Amazon Q Business 或 Amazon Kendra 检索器 |
| UpdateRetriever | 更新现有的 Amazon Q Business 或 Amazon Kendra 检索器 |
连接数据源
Amazon Q Business 支持通过控制台和 API 配置数据源连接器。
| API 操作 | API 说明 |
|---|---|
| CreateDataSource | 创建并连接 Amazon Q Business 数据源 |
| DeleteDataSource | 删除 Amazon Q Business 数据源 |
| GetDataSource | 获取有关现有 Amazon Q Business 数据源的信息 |
| ListDataSources | 列出现有的 Amazon Q Business 数据源 |
| UpdateDataSource | 更新现有的 Amazon Q Business 数据源 |
| StartDataSourceSyncJobs | 启动 Amazon Q Business 数据源同步作业 |
| StopDataSourceSyncJobs | 停止 Amazon Q Business 数据源同步作业 |
| ListDataSourceSyncJobs | 列出数据源同步作业 |
直接上传文档
Amazon Q Business 支持直接使用控制台和 API 将文档上传到 Amazon Q Business 索引中。
| API 操作 | API 说明 |
|---|---|
| BatchPutDocument | 将一个或多个文档添加到 Amazon Q Business 索引 |
| BatchDeleteDocument | 使用 BatchPutDocument API 从 Amazon Q Business 索引异步删除一个或多个添加的文档 |
创建 Web 体验
如果您使用控制台创建 Amazon Q Business 应用程序，则会自动创建 Web 体验并将其连接到您选择的数据源。
| API 操作 | API 描述 |
|---|---|
| CreateWebExperience | 创建 Amazon Q Business Web 体验 |
| DeleteWebExperience | 删除 Amazon Q Business Web 体验 |
| GetWebExperience | 获取有关 Amazon Q Business Web 体验的信息 |
| ListWebExperiences | 列出 Amazon Q Business Web 体验 |
| UpdateWebExperience | 更新 Amazon Q Business Web 体验 |
聊天和对话管理
在 Amazon Q Business Web 体验预览和已部署的 Amazon Q Business Web 体验中聊天使用以下 API 操作。
| API 操作 | API 描述 |
|---|---|
| Chat | 开始或继续流式 Amazon Q Business 对话 |
| ChatSync | 开始或继续非流式 Amazon Q Business 对话 |
| DeleteConversation | 删除 Amazon Q Business Web 体验对话 |
| ListConversations | 列出 Amazon Q Business 中的对话web 体验 |
| ListMessages | 在 Amazon Q Business web 体验中列出消息 |
用户和组管理
Amazon Q Business 提供 API 来管理用户和组，这些 API 在设置数据源连接器连接时会自动调用。在以编程方式构建 Amazon Q Business 应用程序环境时，这些 API 还可用于创建自定义用户和组管理解决方案。
| API 操作 | API 描述 |
|---|---|
| CreateUser | 创建映射到应用程序内本地用户 ID 列表的通用唯一标识符 (UUID) |
| GetUser | 描述与数据源中的本地用户关联的通用唯一标识符 (UUID) |
| UpdateUser | 更新与用户 ID 关联的信息 |
| PutGroup | 创建或更新用户到组的映射 |
| DeleteGroup | 删除组，以便属于该组的所有用户和子组不再能够访问仅对该组可用的文档 |
| GetGroup | 按组名描述组 |
| ListGroups | 提供映射到用户的组列表 |
插件
Amazon Q Business 支持通过控制台和 API 创建插件。
| API 操作 | API 说明 |
|---|---|
| CreatePlugin | 创建 Amazon Q Business 插件 |
| DeletePlugin | 删除 Amazon Q Business 插件 |
| GetPlugin | 获取有关现有 Amazon Q Business 插件的信息 |
| UpdatePlugin | 更新 Amazon Q Business 插件 |
管理控制和防护措施
Amazon Q Business 通过控制台和 API 支持管理控制和防护措施配置。
| API 操作 | API 描述 |
|---|---|
| UpdateChatControlsConfiguration | 更新为现有 Amazon Q Business 应用程序配置的一组聊天控件 |
| DeletePlugin | 删除 Amazon Q Business 插件 |
| DeleteChatControlsConfiguration | 删除为现有 Amazon Q Business 应用程序配置的聊天控件 |
| GetChatControlsConfiguration | 获取有关为现有 Amazon Q Business 应用程序配置的聊天控件的信息。 |
用户反馈
Amazon Q Business 捕获最终用户对聊天响应的反馈，以帮助解决任何技术问题。您无法使用控制台配置此功能。
| API 操作 | API 描述 |
|---|---|
| PutFeedback | 使您的最终用户能够对其 Amazon Q Business 生成的聊天响应提供反馈。 |
