Amazon Q Business - 支持的操作

Amazon Q Business API 参考提供了可用于与 Amazon Q Business 交互的各种操作和操作。此操作包括创建应用程序、删除应用程序、创建插件、创建检索器、上传文档等。

Q Business 支持的操作

QBusiness 支持以下操作:

• BatchDeleteDocument:用于从 Amazon Q Business 索引中删除之前使用 BatchPutDocument API 添加到索引的一个或多个文档，而不会中断其他任务。
• BatchPutDocument:用于将结构化和非结构化文档以及存储在 Amazon S3 存储桶中的文档提取到 Amazon Q Business 索引中，并向文档添加自定义属性并附加访问控制列表
• 聊天:用于启动或继续流式 Amazon Q Business 对话。
• ChatSync:用于启动或继续非流式 Amazon Q Business对话。
• CreateApplication:用于创建 Amazon Q Business 应用程序。
• CreateDataSource:用于为 Amazon Q Business 应用程序创建数据源连接器。
• CreateIndex:用于创建 Amazon Q Business 索引。
• CreatePlugin:用于创建 Amazon Q Business 插件。
• CreateRetriever:用于将检索器添加到您的 Amazon Q Business 应用程序。
• CreateUser:用于创建映射到应用程序内本地用户 ID 列表的通用唯一标识符 (UUID)。
• CreateWebExperience:用于创建 Amazon Q Business Web 体验。
• DeleteApplication:用于删除 Amazon Q Business应用程序。
• DeleteChatControlsConfiguration:用于删除为现有 Amazon Q Business 应用程序配置的聊天控件。
• DeleteConversation:用于删除 Amazon Q Business Web 体验对话。
• DeleteDataSource:用于删除 Amazon Q Business 数据源连接器。
• DeleteGroup:用于删除组并且不再使它们可用于访问资源。
• DeleteIndex:用于删除 Amazon Q Business 索引。
• DeletePlugin:用于删除 Amazon Q Business 插件。
• DeleteRetriever:用于删除 Amazon Q Business 应用程序使用的检索器。
• DeleteUser:用于通过电子邮件删除用户id。
• DeleteWebExperience:用于删除 Amazon Q Business Web 体验。
• GetApplication:用于获取有关现有 Amazon Q Business 应用程序的信息。
• GetChatControlsConfiguration:用于获取有关为现有 Amazon Q Business 应用程序配置的聊天控件的信息。
• GetDataSource:用于获取有关现有 Amazon Q Business 数据源连接器的信息。
• GetGroup:用于按组名描述组。
• GetIndex:用于获取有关现有 Amazon Q Business 索引的信息。
• GetPlugin:用于获取有关现有 Amazon Q Business 插件的信息。
• GetRetriever:用于获取有关 Amazon Q Business 应用程序使用的现有检索器的信息。
• GetUser:用于描述与数据源中的本地用户关联的通用唯一标识符 (UUID)。
• GetWebExperience:用于获取有关现有 Amazon Q Business Web 体验的信息。
• ListApplications:用于列出 Amazon Q Business 应用程序。
• ListConversations:用于列出一个或多个 Amazon Q Business对话。
• ListDataSources:用于列出您已创建的 Amazon Q Business 数据源连接器。
• ListDataSourceSyncJobs:用于获取有关 Amazon Q Business 数据源连接器同步的信息。
• ListDocuments:是附加到索引的文档列表。
• ListGroups:是映射到用户的组的列表。
• ListIndices:是您已创建的 Amazon Q Business 索引的列表。
• ListMessages:用于获取与 Amazon Q Business Web 体验相关的消息列表。
• ListPlugins:是已配置的 Amazon Q Business 插件的列表。
• ListRetrievers:是 Amazon Q Business 使用的检索器的列表应用程序。
• ListTagsForResource:用于获取与指定资源关联的标签列表。
• ListWebExperiences:用于列出一个或多个 Amazon Q Business Web 体验。
• PutFeedback:使您的最终用户能够就其 Amazon Q Business 生成的聊天响应提供反馈。
• PutGroup:用于创建、更新和映射有权访问文档的用户到组。
• StartDataSourceSyncJob:用于启动数据源连接器同步作业。
• StopDataSourceSyncJob:用于停止已在进行的 Amazon Q Business 数据源连接器同步作业。
• TagResource:用于将指定的标签添加到指定的 Amazon Q Business 应用程序或数据源资源。如果标签已经存在，则现有值将替换为新值。
• UntagResource:用于从 Amazon Q Business 应用程序或数据源中删除标签。
• UpdateApplication:用于更新现有的 Amazon Q Business 应用程序。
• UpdateChatControlsConfiguration:用于更新为现有 Amazon Q Business 应用程序配置的一组聊天控件。
• UpdateDataSource:用于更新现有的 Amazon Q Business 数据源连接器。
• UpdateIndex:用于更新 Amazon Q Business 索引。
• UpdatePlugin:用于更新 Amazon Q Business 插件。
• UpdateRetriever:用于更新用于 Amazon Q Business 应用程序的检索器。
• UpdateUser:用于更新与用户 ID。
• UpdateWebExperience:用于更新 Amazon Q Business Web 体验。

QApps 支持的操作

QApps 支持以下操作:

• AssociateLibraryItemReview:用于将图书馆项目的评级或评论与提交请求的用户关联起来
• AssociateQAppWithUser:用于在调用操作的用户身份和特定 Q App 之间创建链接。
• CreateLibraryItem:用于为 Amazon Q App 创建新的库项目
• CreateQApp:用于根据提供的定义创建新的 Amazon Q App。
• DeleteLibraryItem:用于删除 Amazon Q App 的库项目，将其从库中移除，以便其他用户无法再发现或使用。
• DeleteQApp:用于删除用户拥有的 Amazon Q App。
• DisassociateLibraryItemReview:用于删除用户之前为库项目提交的评级或评论。
• DisassociateQAppFromUser:用于取消 Q App 与用户的关联，从而删除用户运行 Q App 的权限。
• GetLibraryItem:用于检索有关Amazon Q App 的库项目，包括其元数据、类别、评级和使用情况统计信息。
• GetQApp:用于检索 Q App 的完整详细信息，包括其指定卡片和流程的定义。
• GetQAppSession:用于检索 Amazon Q App 活动会话的当前状态和结果。
• ImportDocument:用于上传文件以在 Q App 中使用，作为默认设置或在单次运行中使用。
• ListLibraryItems:用于列出已发布并可供您的 AWS 账户中的用户使用的 Amazon Q Apps 库项目。
• ListQApps:用于列出您拥有或使用过的 Q Apps。
• ListTagsForResource:用于列出与 Amazon Q Apps 关联的标签资源。
• PredictQApp:用于根据对话或问题陈述创建 Q App 定义。此定义可用于稍后创建 Q App。
• StartQAppSession:用于启动 Amazon Q App 的新会话，允许提供输入并运行应用程序。
• StopQAppSession:用于停止 Amazon Q App 的活动会话
• TagResource:用于将标签与 Amazon Q Apps 资源关联。
• UntagResource:用于取消标签与 Amazon Q Apps 资源的关联。
• UpdateLibraryItem:用于更新 Amazon Q App 的库项目。
• UpdateLibraryItemMetadata:用于更新 Amazon Q App 的库项目的验证状态。
• UpdateQApp:用于更新现有的 Amazon Q App，允许修改其标题、说明和定义。
• UpdateQAppSession:用于更新给定 Q App sessionId 的会话。