Amazon Q 商业版 - API 参考

Amazon Q 商业版是一款基于人工智能的聊天助手，可帮助企业提高员工工作效率。它可以回答问题、查找信息、撰写电子邮件、总结文本，甚至集思广益。

创建 Amazon Q 商业版应用程序

所有 Amazon Q 商业版应用程序环境操作都同时支持控制台和 API。

您无法在 Amazon Q 商业版的 AWS 管理控制台中直接创建或管理索引。当您创建检索器时，控制台会自动创建一个索引。您在控制台中唯一可以对索引执行的操作是为其添加标签。

Amazon Q 商业版支持通过控制台和 API 创建检索器。

API 操作	API 描述
CreateRetriever	创建 Amazon Q 商业版或 Amazon Kendra 检索器
DeleteRetriever	删除 Amazon Q 商业版或 Amazon Kendra 检索器
GetRetriever	获取有关现有 Amazon Q 商业版或 Amazon Kendra 检索器的信息
ListRetrievers	列出现有的 Amazon Q 商业版或 Amazon Kendra 检索器
UpdateRetriever	更新现有的 Amazon Q 商业版或 Amazon Kendra 检索器

Amazon Q 商业版支持通过控制台和 API 配置数据源连接器。

Amazon Q 商业版支持使用控制台和 API 将文档直接上传到 Amazon Q 商业版索引中。

API 操作	API 描述
BatchPutDocument	将一个或多个文档添加到 Amazon Q 商业版索引中
BatchDeleteDocument	异步删除使用 BatchPutDocument API 添加到 Amazon Q 商业版索引中的一个或多个文档

如果您使用控制台创建 Amazon Q 商业版应用程序，则会自动创建一个 Web 体验并将其连接到您选择的数据源。

在 Amazon Q 商业版 Web 体验预览和已部署的 Amazon Q 商业版 Web 体验中聊天使用以下 API 操作。

Amazon Q 商业版提供用于管理用户和组的 API，这些 API 在设置数据源连接器连接时会自动调用。在以编程方式构建 Amazon Q 商业版应用程序环境时，这些 API 也可用于创建自定义用户和组管理解决方案。

API 操作	API 描述
CreateUser	创建与应用程序内本地用户 ID 列表映射的通用唯一标识符 (UUID)
GetUser	描述与数据源中本地用户关联的通用唯一标识符 (UUID)
UpdateUser	更新与用户 ID 关联的信息
PutGroup	创建或更新用户与组的映射
DeleteGroup	删除组，以便所有属于该组的用户和子组都无法再访问仅供该组访问的文档
GetGroup	按组名称描述组
ListGroups	提供映射到用户的组列表

Amazon Q 商业版支持通过控制台和 API 创建插件。

Amazon Q 商业版支持通过控制台和 API 配置管理员控制和护栏。

API 操作	API 描述
UpdateChatControlsConfiguration	更新为现有 Amazon Q 商业版应用程序配置的一组聊天控制
DeletePlugin	删除 Amazon Q 商业版插件
DeleteChatControlsConfiguration	删除为现有 Amazon Q 商业版应用程序配置的聊天控制
GetChatControlsConfiguration	获取有关为现有 Amazon Q 商业版应用程序配置的聊天控制的信息。

Amazon Q 商业版捕获最终用户对聊天回复的反馈，以帮助解决任何技术问题。您无法使用控制台配置此功能。

API 操作	API 描述
PutFeedback	使您的最终用户能够提供其 Amazon Q 商业版生成的聊天回复的反馈。

打印页面