Amazon Q Business - 支持的数据类型

Amazon Q Business 包含与特定功能相关的数据类型列表。

Q Business 支持的数据类型

以下数据类型受 QBusiness 支持

• AccessConfiguration: 用于配置文档的访问权限。
• AccessControl: 一组主体列表，可以是 USER 或 GROUP，并具有允许或拒绝文档访问权限。
• ActionExecution: 用于在非流式聊天对话期间执行 Amazon Q Business 插件操作。
• ActionExecutionEvent: 来自最终用户的请求，表示在流式聊天期间执行 Amazon Q Business 插件操作的意图。
• ActionExecutionPayloadField: 是插件操作执行有效负载中的用户输入字段。
• ActionReview: 返回一个输出事件，其中包含有关所选插件操作的信息以及可能的用户信息字段列表，其中一些由 Amazon Q Business 预先填充。
• ActionReviewEvent: 当您希望在流式聊天对话期间执行插件操作时输出事件。
• ActionReviewPayloadField: 插件操作审查有效负载中的用户输入字段。
• ActionReviewPayloadFieldAllowedValue: 关于最终用户可以使用哪些字段值提供给 Amazon Q Business，以便 Amazon Q Business 执行请求的插件操作的信息。
• APISchema: 包含有关自定义插件的 OpenAPI 架构的详细信息。
• Application: Amazon Q Business 应用程序的摘要信息。
• AppliedAttachmentsConfiguration: 用于配置应用程序聊天期间文件上传功能的信息。
• AppliedCreatorModeConfiguration: 定义为 Amazon Q Business 应用程序配置的创建者模式特定管理员控制。
• AttachmentInput: 是直接上传到 Web 体验聊天的文件。
• AttachmentInputEvent: 是最终用户请求将文件上传到其 Web 体验聊天时激活的文件输入事件。
• AttachmentOutput: 是聊天期间上传的文件的详细信息。
• AttachmentsConfiguration: 是文件上传聊天功能的配置信息。
• AttributeFilter: 能够根据文档属性或元数据字段过滤响应。
• AuthChallengeRequest: 是 Amazon Q Business 向第三方身份验证服务器发出的请求，以验证自定义插件用户。
• AuthChallengeRequestEvent: 是最终用户请求使用自定义插件时激活的身份验证验证事件。
• AuthChallengeResponse: 包含从第三方身份验证服务器接收到的身份验证信息的详细信息，以响应身份验证挑战。
• AuthChallengeResponseEvent: 第三方身份验证服务器对 Amazon Q Business 的身份验证验证事件响应。
• AutoSubscriptionConfiguration: 是使用 IAM 身份联合进行用户管理的 Amazon Q Business 应用程序的订阅配置信息。
• BasicAuthConfiguration: 包含有关用于配置插件的基本身份验证凭据的信息。
• BlockedPhrasesConfiguration: 提供有关聊天控制配置阻止的短语的信息。
• BlockedPhrasesConfigurationUpdate: 用于更新 Amazon Q Business 应用程序中的阻止短语配置。
• ChatInputStream: 是 Chat API 的流式输入。
• ChatModeConfiguration: 包含 Amazon Q Business 对话模式的配置信息。
• ChatOutputStream: 是 Chat API 的流式输出。
• ConfigurationEvent: 最终用户请求选择特定聊天模式时激活的配置事件。
• ContentBlockerRule: 用于配置 Amazon Q Business 在遇到阻止主题时如何响应的规则。
• ContentRetrievalRule: 用于从连接到 Amazon Q Business 应用程序的数据源中检索特定主题控制配置内容的规则。
• Conversation: 是 Amazon Q Business 应用程序中的对话。
• CreatorModeConfiguration: 包含在 CREATOR_MODE 中调用聊天的所需配置信息。
• CustomPluginConfiguration: 包含创建自定义插件所需的配置信息。
• DataSource: 是 Amazon Q Business 应用程序中的数据源。
• DataSourceSyncJob: 提供有关 Amazon Q Business 数据源连接器同步作业的信息。
• DataSourceSyncJobMetrics: 用于将批量删除文档请求映射到特定 Amazon Q Business 数据源连接器同步作业。
• DataSourceVpcConfiguration: 提供连接到 Amazon VPC（虚拟私有云）所需的配置信息。
• DateAttributeBoostingConfiguration: 提供有关提升 DATE 类型文档属性的信息。
• DeleteDocument: 是从 Amazon Q Business 数据源连接器中删除的文档。
• Document: 是 Amazon Q Business 应用程序中的文档。
• DocumentAttribute: 是文档属性或元数据字段。
• DocumentAttributeBoostingConfiguration: 提供有关提升支持的 Amazon Q Business 文档属性类型的信息。
• DocumentAttributeCondition: 是将文档导入 Amazon Q Business 时目标文档属性或元数据字段使用的条件。
• DocumentAttributeConfiguration: 包含文档属性的配置信息。
• DocumentAttributeTarget: 是将文档导入 Amazon Q Business 时要更改的目标文档属性或元数据字段。
• DocumentAttributeValue: 是文档属性的值。您只能为文档属性提供一个值。
• DocumentContent: 是文档的内容。
• DocumentDetails: 是 Amazon Q Business 索引中文档的详细信息。
• DocumentEnrichmentConfiguration: 提供在文档导入过程中更改文档元数据和内容的配置信息。
• EligibleDataSource: 是 Amazon Q Business 将从中生成响应的数据源的标识符。
• EncryptionConfiguration: 提供用于加密 Amazon Q Business 编入索引的数据的 AWS KMS 密钥的标识符。
• EndOfInputEvent: 是 Chat API 的流式输入的结束。
• ErrorDetail: 提供有关数据源同步错误的信息。
• FailedAttachmentEvent: 是 Web 体验聊天期间文件上传失败。
• FailedDocument: 是无法从 Amazon Q Business 索引中删除的文档列表。
• GroupMembers: 是属于某个组的用户或子组列表。
• GroupStatusDetail: 提供组状态的详细信息。
• GroupSummary: 包含组的摘要信息。
• HookConfiguration: 用于配置 Lambda 函数，以便在将文档添加到 Amazon Q Business 时更改文档元数据和内容。
• IdentityProviderConfiguration: 提供有关用于对 Amazon Q Business Web 体验的最终用户进行身份验证的身份提供商 (IdP) 的信息。
• Index: 包含 Amazon Q Business 索引的摘要信息。
• IndexCapacityConfiguration: 提供有关索引容量配置的信息。
• IndexStatistics: 提供有关索引中文档数量的信息。
• InlineDocumentEnrichmentConfiguration: 提供将基本逻辑应用于在将文档导入 Amazon Q Business 时更改文档元数据和内容的配置信息。
• KendraIndexConfiguration: 用于将 Amazon Kendra 索引存储为检索器。
• MemberGroup: 是属于某个组的子组。
• MemberUser: 是属于某个组的用户。
• Message: 是 Amazon Q Business Web 体验中的消息。
• MessageUsefulnessFeedback: 是最终用户对 AI 生成的 Web 体验聊天消息有用性的反馈。
• MetadataEvent: Amazon Q Business 对话中 AI 生成的文本输出消息的元数据事件，包含生成的关联元数据。
• NativeIndexConfiguration: 包含 Amazon Q Business 索引的配置信息。
• NoAuthConfiguration: 包含有关在没有任何身份验证或授权要求的情况下调用自定义插件的信息。
• NumberAttributeBoostingConfiguration: 提供有关提升 NUMBER 类型文档属性的信息。

• OAuth2ClientCredentialConfiguration：包含用于配置插件的 OAuth 2.0 身份验证凭据/令牌信息。
• OpenIDConnectProviderConfiguration：包含有关用于对 Amazon Q Business 网络体验的最终用户进行身份验证的符合 OIDC 标准的身份提供商 (IdP) 的信息。
• PersonalizationConfiguration：包含有关聊天回复个性化的配置信息。
• Plugin：包含有关 Amazon Q Business 插件及其配置的信息。
• PluginAuthConfiguration：包含 Amazon Q Business 插件的身份验证配置信息。
• PluginConfiguration：包含在 PLUGIN_MODE 中调用聊天的必需配置信息。
• Principal：提供用于过滤文档以用于生成 Amazon Q Business 对话回复的用户和组信息。
• PrincipalGroup：提供有关与主体关联的组的信息。
• PrincipalUser：提供有关与主体关联的用户的信息。
• QAppsConfiguration：包含有关 Amazon Q Apps 的配置信息。（预览功能）
• Retriever：包含用于您的 Amazon Q Business 应用程序的检索器的摘要信息。
• RetrieverConfiguration：提供有关用于您的 Amazon Q Business 应用程序的检索器的配置信息。
• Rule：Amazon Q Business 应用程序的护栏规则。Amazon Q Business 每次仅支持一条规则。
• RuleConfiguration：提供有关规则的配置信息。
• S3：是 Amazon Q Business 在 Amazon S3 存储桶中查找特定文件所需的信息。
• SamlConfiguration：提供 Amazon Q Business 部署 Amazon Q Business 网络体验所需的符合 SAML 2.0 标准的身份提供商 (IdP) 配置信息。
• SamlProviderConfiguration：是有关用于对 Amazon Q Business 网络体验的最终用户进行身份验证的符合 SAML 2.0 标准的身份提供商 (IdP) 的信息。
• SnippetExcerpt：包含从用于在 Amazon Q Business 聊天回复中生成引用文本段落的源中提取的相关文本摘录。
• SourceAttribution：是用于生成 Amazon Q Business 网络体验回复的文档。
• StringAttributeBoostingConfiguration：提供有关提升 STRING 类型文档属性的信息。
• StringListAttributeBoostingConfiguration：提供有关提升 STRING_LIST 类型文档属性的信息。
• Tag：是用于识别索引、常见问题解答或数据源的键/值对列表。
• TextDocumentStatistics：提供有关索引中文本文档的信息。
• TextInputEvent：Amazon Q Business 网络体验中最终用户消息的输入事件。
• TextOutputEvent：Amazon Q Business 网络体验中 AI 生成的回复的输出事件。
• TextSegment：提供有关聊天回复中可以归因于源文档的文本摘录的信息。
• TopicConfiguration：为 Amazon Q Business 应用程序配置的主题特定控件。
• UserAlias：附加到 Amazon Q Business 应用程序中用户 ID 的别名。
• UsersAndGroups：提供有关与主题控制规则关联的用户和组名称的信息。
• ValidationExceptionField：输入未满足 Amazon Q Business 在指定字段中指定的约束。
• WebExperience：提供 Amazon Q Business 网络体验的信息。
• WebExperienceAuthConfiguration：提供将 Amazon Q Business 网络体验部署到最终用户所需的授权配置信息。

Q Apps 支持的数据类型

QApps 支持以下数据类型

• AppDefinition：是 Q App 的定义，指定卡片和流程。
• AppDefinitionInput：是定义 Q App 的输入。
• AttributeFilter：是基于文档属性或元数据字段对回复使用的筛选条件。
• Card：是表示 Amazon Q App 流程中的组件或步骤的卡片。
• CardInput：是定义 Amazon Q App 中输入卡片的属性。
• CardStatus：是活动 Amazon Q App 会话中卡片的当前状态和值。
• CardValue：是与 Amazon Q App 会话中卡片关联的值或结果。
• Category：是用于对 Amazon Q Apps 的库项目进行分类和筛选的类别。
• ConversationMessage：是对话中的消息，用作生成 Amazon Q App 定义的输入。
• DocumentAttribute: 是文档属性或元数据字段。
• DocumentAttributeValue：是文档属性的值。
• FileUploadCard：是 Amazon Q App 中允许用户上传文件的卡片。
• FileUploadCardInput：表示文件上传卡片。
• LibraryItemMember：是库项目，是 Amazon Q App 的快照，可以发布，以便用户在他们的 Amazon Q Apps 库中发现它、克隆它并运行它。
• PredictAppDefinition：是基于输入（例如对话或问题陈述）生成的 Amazon Q App 的定义。
• PredictQAppInputOptions：是生成 Q App 定义的输入选项。
• QPluginCard：是 Q App 中与第三方插件或服务集成的卡片。
• QPluginCardInput：是定义 Amazon Q App 中插件卡片的输入形状。
• QQueryCard：是 Amazon Q App 中基于 Amazon Q Business 服务生成回复的卡片。
• QQueryCardInput：是定义 Amazon Q App 中查询卡片的输入形状。
• TextInputCard：是 Amazon Q App 中允许用户输入文本的卡片。
• TextInputCardInput：是定义 Amazon Q App 中文本输入卡片的输入形状。
• UserAppItem：是与用户关联的 Amazon Q App，由用户拥有或收藏。