Module: Aws::QBusiness::Types

Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Defined Under Namespace

Classes: APISchema, AccessConfiguration, AccessControl, AccessDeniedException, ActionConfiguration, ActionExecution, ActionExecutionEvent, ActionExecutionPayloadField, ActionFilterConfiguration, ActionReview, ActionReviewEvent, ActionReviewPayloadField, ActionReviewPayloadFieldAllowedValue, ActionSummary, Application, AppliedAttachmentsConfiguration, AppliedCreatorModeConfiguration, AppliedOrchestrationConfiguration, AssociatePermissionRequest, AssociatePermissionResponse, AssociatedGroup, AssociatedUser, Attachment, AttachmentInput, AttachmentInputEvent, AttachmentOutput, AttachmentsConfiguration, AttributeFilter, AudioExtractionConfiguration, AudioSourceDetails, AuthChallengeRequest, AuthChallengeRequestEvent, AuthChallengeResponse, AuthChallengeResponseEvent, AutoSubscriptionConfiguration, BasicAuthConfiguration, BatchDeleteDocumentRequest, BatchDeleteDocumentResponse, BatchPutDocumentRequest, BatchPutDocumentResponse, BlockedPhrasesConfiguration, BlockedPhrasesConfigurationUpdate, BrowserExtensionConfiguration, CancelSubscriptionRequest, CancelSubscriptionResponse, ChatInput, ChatInputStream, ChatModeConfiguration, ChatOutput, ChatOutputStream, ChatResponseConfiguration, ChatResponseConfigurationDetail, ChatSyncInput, ChatSyncOutput, CheckDocumentAccessRequest, CheckDocumentAccessResponse, ConfigurationEvent, ConflictException, ContentBlockerRule, ContentRetrievalRule, ContentSource, Conversation, ConversationSource, CopyFromSource, CreateAnonymousWebExperienceUrlRequest, CreateAnonymousWebExperienceUrlResponse, CreateApplicationRequest, CreateApplicationResponse, CreateChatResponseConfigurationRequest, CreateChatResponseConfigurationResponse, CreateDataAccessorRequest, CreateDataAccessorResponse, CreateDataSourceRequest, CreateDataSourceResponse, CreateIndexRequest, CreateIndexResponse, CreatePluginRequest, CreatePluginResponse, CreateRetrieverRequest, CreateRetrieverResponse, CreateSubscriptionRequest, CreateSubscriptionResponse, CreateUserRequest, CreateUserResponse, CreateWebExperienceRequest, CreateWebExperienceResponse, CreatorModeConfiguration, CustomPluginConfiguration, CustomizationConfiguration, DataAccessor, DataAccessorAuthenticationConfiguration, DataAccessorAuthenticationDetail, DataAccessorIdcTrustedTokenIssuerConfiguration, DataSource, DataSourceSyncJob, DataSourceSyncJobMetrics, DataSourceVpcConfiguration, DateAttributeBoostingConfiguration, DeleteApplicationRequest, DeleteApplicationResponse, DeleteAttachmentRequest, DeleteAttachmentResponse, DeleteChatControlsConfigurationRequest, DeleteChatControlsConfigurationResponse, DeleteChatResponseConfigurationRequest, DeleteChatResponseConfigurationResponse, DeleteConversationRequest, DeleteConversationResponse, DeleteDataAccessorRequest, DeleteDataAccessorResponse, DeleteDataSourceRequest, DeleteDataSourceResponse, DeleteDocument, DeleteGroupRequest, DeleteGroupResponse, DeleteIndexRequest, DeleteIndexResponse, DeletePluginRequest, DeletePluginResponse, DeleteRetrieverRequest, DeleteRetrieverResponse, DeleteUserRequest, DeleteUserResponse, DeleteWebExperienceRequest, DeleteWebExperienceResponse, DisassociatePermissionRequest, DisassociatePermissionResponse, Document, DocumentAcl, DocumentAclCondition, DocumentAclGroup, DocumentAclMembership, DocumentAclUser, DocumentAttribute, DocumentAttributeBoostingConfiguration, DocumentAttributeCondition, DocumentAttributeConfiguration, DocumentAttributeTarget, DocumentAttributeValue, DocumentContent, DocumentDetails, DocumentEnrichmentConfiguration, EligibleDataSource, EncryptionConfiguration, ErrorDetail, ExternalResourceException, FailedAttachmentEvent, FailedDocument, GetApplicationRequest, GetApplicationResponse, GetChatControlsConfigurationRequest, GetChatControlsConfigurationResponse, GetChatResponseConfigurationRequest, GetChatResponseConfigurationResponse, GetDataAccessorRequest, GetDataAccessorResponse, GetDataSourceRequest, GetDataSourceResponse, GetDocumentContentRequest, GetDocumentContentResponse, GetGroupRequest, GetGroupResponse, GetIndexRequest, GetIndexResponse, GetMediaRequest, GetMediaResponse, GetPluginRequest, GetPluginResponse, GetPolicyRequest, GetPolicyResponse, GetRetrieverRequest, GetRetrieverResponse, GetUserRequest, GetUserResponse, GetWebExperienceRequest, GetWebExperienceResponse, GroupMembers, GroupStatusDetail, GroupSummary, HallucinationReductionConfiguration, HookConfiguration, IdcAuthConfiguration, IdentityProviderConfiguration, ImageExtractionConfiguration, ImageSourceDetails, Index, IndexCapacityConfiguration, IndexStatistics, InlineDocumentEnrichmentConfiguration, InstructionCollection, InternalServerException, KendraIndexConfiguration, LicenseNotFoundException, ListApplicationsRequest, ListApplicationsResponse, ListAttachmentsRequest, ListAttachmentsResponse, ListChatResponseConfigurationsRequest, ListChatResponseConfigurationsResponse, ListConversationsRequest, ListConversationsResponse, ListDataAccessorsRequest, ListDataAccessorsResponse, ListDataSourceSyncJobsRequest, ListDataSourceSyncJobsResponse, ListDataSourcesRequest, ListDataSourcesResponse, ListDocumentsRequest, ListDocumentsResponse, ListGroupsRequest, ListGroupsResponse, ListIndicesRequest, ListIndicesResponse, ListMessagesRequest, ListMessagesResponse, ListPluginActionsRequest, ListPluginActionsResponse, ListPluginTypeActionsRequest, ListPluginTypeActionsResponse, ListPluginTypeMetadataRequest, ListPluginTypeMetadataResponse, ListPluginsRequest, ListPluginsResponse, ListRetrieversRequest, ListRetrieversResponse, ListSubscriptionsRequest, ListSubscriptionsResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ListWebExperiencesRequest, ListWebExperiencesResponse, MediaExtractionConfiguration, MediaTooLargeException, MemberGroup, MemberUser, Message, MessageUsefulnessFeedback, MetadataEvent, NativeIndexConfiguration, NumberAttributeBoostingConfiguration, OAuth2ClientCredentialConfiguration, OpenIDConnectProviderConfiguration, OrchestrationConfiguration, PermissionCondition, PersonalizationConfiguration, Plugin, PluginAuthConfiguration, PluginConfiguration, PluginTypeMetadataSummary, Principal, PrincipalGroup, PrincipalUser, PutFeedbackRequest, PutGroupRequest, PutGroupResponse, QAppsConfiguration, QuickSightConfiguration, RelevantContent, ResourceNotFoundException, ResponseConfiguration, Retriever, RetrieverConfiguration, RetrieverContentSource, Rule, RuleConfiguration, S3, SamlConfiguration, SamlProviderConfiguration, ScoreAttributes, SearchRelevantContentRequest, SearchRelevantContentResponse, ServiceQuotaExceededException, SnippetExcerpt, SourceAttribution, SourceDetails, StartDataSourceSyncJobRequest, StartDataSourceSyncJobResponse, StopDataSourceSyncJobRequest, StopDataSourceSyncJobResponse, StringAttributeBoostingConfiguration, StringListAttributeBoostingConfiguration, Subscription, SubscriptionDetails, SubscriptionPrincipal, Tag, TagResourceRequest, TagResourceResponse, TextDocumentStatistics, TextInputEvent, TextOutputEvent, TextSegment, ThrottlingException, TopicConfiguration, UntagResourceRequest, UntagResourceResponse, UpdateApplicationRequest, UpdateApplicationResponse, UpdateChatControlsConfigurationRequest, UpdateChatControlsConfigurationResponse, UpdateChatResponseConfigurationRequest, UpdateChatResponseConfigurationResponse, UpdateDataAccessorRequest, UpdateDataAccessorResponse, UpdateDataSourceRequest, UpdateDataSourceResponse, UpdateIndexRequest, UpdateIndexResponse, UpdatePluginRequest, UpdatePluginResponse, UpdateRetrieverRequest, UpdateRetrieverResponse, UpdateSubscriptionRequest, UpdateSubscriptionResponse, UpdateUserRequest, UpdateUserResponse, UpdateWebExperienceRequest, UpdateWebExperienceResponse, UserAlias, UsersAndGroups, ValidationException, ValidationExceptionField, VideoExtractionConfiguration, VideoSourceDetails, WebExperience, WebExperienceAuthConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#attachment ⇒ Types::AttachmentOutput

The details of a file uploaded during chat.

Returns:



729
730
731
732
733
734
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 729

class AttachmentInputEvent < Struct.new(
  :attachment,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_filter ⇒ Types::AttributeFilter

Enables filtering of responses based on document attributes or metadata fields.

Returns:



1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1753

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#audio_source_details ⇒ Types::AudioSourceDetails

Details specific to audio content within the source.

Returns:



8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8166

class SourceDetails < Struct.new(
  :image_source_details,
  :audio_source_details,
  :video_source_details,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ImageSourceDetails < SourceDetails; end
  class AudioSourceDetails < SourceDetails; end
  class VideoSourceDetails < SourceDetails; end
  class Unknown < SourceDetails; end
end

#authorization_url ⇒ String

The URL sent by Amazon Q Business to a third party authentication server in response to an authentication verification event activated by an end user request to use a custom plugin.

Returns:

  • (String) 


967
968
969
970
971
972
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 967

class AuthChallengeRequestEvent < Struct.new(
  :authorization_url,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#basic_auth_configuration ⇒ Types::BasicAuthConfiguration

Information about the basic authentication credentials used to configure a plugin.

Returns:



7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7380

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#blob ⇒ String

The contents of the document. Documents passed to the blob parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the Amazon Q Business endpoint directly using REST, you must base64 encode the contents before sending.

Returns:

  • (String) 


4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4069

class DocumentContent < Struct.new(
  :blob,
  :s3,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Blob < DocumentContent; end
  class S3 < DocumentContent; end
  class Unknown < DocumentContent; end
end

#chat_mode ⇒ String

The chat modes available to an Amazon Q Business end user.

  • RETRIEVAL_MODE - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.

  • CREATOR_MODE - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.

  • PLUGIN_MODE - By selecting this mode, users can choose to use plugins in chat.

For more information, see Admin controls and guardrails, Plugins, and Conversation settings.

Returns:

  • (String) 


1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1753

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#chat_mode_configuration ⇒ Types::ChatModeConfiguration

Configuration information for Amazon Q Business conversation modes.

For more information, see Admin controls and guardrails and Conversation settings.

Returns:



1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1753

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#content_blocker_rule ⇒ Types::ContentBlockerRule

A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.

Returns:



7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7879

class RuleConfiguration < Struct.new(
  :content_blocker_rule,
  :content_retrieval_rule,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ContentBlockerRule < RuleConfiguration; end
  class ContentRetrievalRule < RuleConfiguration; end
  class Unknown < RuleConfiguration; end
end

#content_retrieval_rule ⇒ Types::ContentRetrievalRule

Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.

Returns:



7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7879

class RuleConfiguration < Struct.new(
  :content_blocker_rule,
  :content_retrieval_rule,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ContentBlockerRule < RuleConfiguration; end
  class ContentRetrievalRule < RuleConfiguration; end
  class Unknown < RuleConfiguration; end
end

#conversation ⇒ Types::ConversationSource

A reference to an attachment in an existing conversation.

Returns:



1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1899

class CopyFromSource < Struct.new(
  :conversation,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Conversation < CopyFromSource; end
  class Unknown < CopyFromSource; end
end

#conversation_id ⇒ String

The identifier of the conversation with which the text output event is associated.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#date_configuration ⇒ Types::DateAttributeBoostingConfiguration

Provides information on boosting DATE type document attributes.

Version 2 assigns priority tiers to DATE attributes, establishing clear hierarchical relationships with other boosted attributes.

Returns:



3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3833

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#date_value ⇒ Time

A date expressed as an ISO 8601 string.

It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

Returns:

  • (Time) 


4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4022

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#final_text_message ⇒ String

The final text output message generated by the system.

Returns:

  • (String) 


7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7063

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#group ⇒ String

The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.

Returns:

  • (String) 


7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7460

class Principal < Struct.new(
  :user,
  :group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class User < Principal; end
  class Group < Principal; end
  class Unknown < Principal; end
end

#idc_auth_configuration ⇒ Types::IdcAuthConfiguration

Information about the IAM Identity Center Application used to configure authentication for a plugin.

Returns:



7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7380

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#idc_trusted_token_issuer_configuration ⇒ Types::DataAccessorIdcTrustedTokenIssuerConfiguration

Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is AWS_IAM_IDC_TTI.

Returns:



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2956

class DataAccessorAuthenticationConfiguration < Struct.new(
  :idc_trusted_token_issuer_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class IdcTrustedTokenIssuerConfiguration < DataAccessorAuthenticationConfiguration; end
  class Unknown < DataAccessorAuthenticationConfiguration; end
end

#image_source_details ⇒ Types::ImageSourceDetails

Details specific to image content within the source.

Returns:



8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8166

class SourceDetails < Struct.new(
  :image_source_details,
  :audio_source_details,
  :video_source_details,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ImageSourceDetails < SourceDetails; end
  class AudioSourceDetails < SourceDetails; end
  class VideoSourceDetails < SourceDetails; end
  class Unknown < SourceDetails; end
end

#kendra_index_configuration ⇒ Types::KendraIndexConfiguration

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

Returns:



7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7804

class RetrieverConfiguration < Struct.new(
  :native_index_configuration,
  :kendra_index_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NativeIndexConfiguration < RetrieverConfiguration; end
  class KendraIndexConfiguration < RetrieverConfiguration; end
  class Unknown < RetrieverConfiguration; end
end

#long_value ⇒ Integer

A long integer value.

Returns:

  • (Integer) 


4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4022

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#native_index_configuration ⇒ Types::NativeIndexConfiguration

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

Returns:



7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7804

class RetrieverConfiguration < Struct.new(
  :native_index_configuration,
  :kendra_index_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NativeIndexConfiguration < RetrieverConfiguration; end
  class KendraIndexConfiguration < RetrieverConfiguration; end
  class Unknown < RetrieverConfiguration; end
end

#no_auth_configuration ⇒ Types::NoAuthConfiguration

Information about invoking a custom plugin without any authentication.

Returns:

  • (Types::NoAuthConfiguration) 


7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7380

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#number_configuration ⇒ Types::NumberAttributeBoostingConfiguration

Provides information on boosting NUMBER type document attributes.

NUMBER attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.

Returns:



3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3833

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#o_auth_2_client_credential_configuration ⇒ Types::OAuth2ClientCredentialConfiguration

Information about the OAuth 2.0 authentication credential/token used to configure a plugin.

Returns:



7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7380

class PluginAuthConfiguration < Struct.new(
  :basic_auth_configuration,
  :o_auth_2_client_credential_configuration,
  :no_auth_configuration,
  :idc_auth_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class IdcAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; end
end

#open_id_connect_configuration ⇒ Types::OpenIDConnectProviderConfiguration

Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Returns:



5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5636

class IdentityProviderConfiguration < Struct.new(
  :saml_configuration,
  :open_id_connect_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SamlConfiguration < IdentityProviderConfiguration; end
  class OpenIdConnectConfiguration < IdentityProviderConfiguration; end
  class Unknown < IdentityProviderConfiguration; end
end

#payload ⇒ Hash<String,Types::ActionReviewPayloadField>

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 40

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#payload_field_name_separator ⇒ String

A string used to retain information about the hierarchical contexts within an action review event payload.

Returns:

  • (String) 


177
178
179
180
181
182
183
184
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 177

class ActionExecutionEvent < Struct.new(
  :plugin_id,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_configuration ⇒ Types::PluginConfiguration

Configuration information required to invoke chat in PLUGIN_MODE.

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1339

class ChatModeConfiguration < Struct.new(
  :plugin_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class PluginConfiguration < ChatModeConfiguration; end
  class Unknown < ChatModeConfiguration; end
end

#plugin_id ⇒ String

The identifier of the plugin associated with the action review event.

Returns:

  • (String) 


177
178
179
180
181
182
183
184
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 177

class ActionExecutionEvent < Struct.new(
  :plugin_id,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#plugin_type ⇒ String

The type of plugin.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#response_map ⇒ Hash<String,String>

The mapping of key-value pairs in an authentication challenge response.

Returns:

  • (Hash<String,String>) 


1001
1002
1003
1004
1005
1006
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1001

class AuthChallengeResponseEvent < Struct.new(
  :response_map,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#retriever ⇒ Types::RetrieverContentSource

The retriever to use as the content source.

Returns:



1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1832

class ContentSource < Struct.new(
  :retriever,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Retriever < ContentSource; end
  class Unknown < ContentSource; end
end

#s3 ⇒ Types::S3

The path to the document in an Amazon S3 bucket.

Returns:



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 40

class APISchema < Struct.new(
  :payload,
  :s3,
  :unknown)
  SENSITIVE = [:payload]
  include Aws::Structure
  include Aws::Structure::Union

  class Payload < APISchema; end
  class S3 < APISchema; end
  class Unknown < APISchema; end
end

#saml_configuration ⇒ Types::SamlConfiguration

Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.

Returns:



5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5636

class IdentityProviderConfiguration < Struct.new(
  :saml_configuration,
  :open_id_connect_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class SamlConfiguration < IdentityProviderConfiguration; end
  class OpenIdConnectConfiguration < IdentityProviderConfiguration; end
  class Unknown < IdentityProviderConfiguration; end
end

#source_attributions ⇒ Array<Types::SourceAttribution>

The source documents used to generate the conversation response.

Returns:



7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7063

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#string_configuration ⇒ Types::StringAttributeBoostingConfiguration

Provides information on boosting STRING type document attributes.

Version 2 assigns priority tiers to STRING attributes, establishing clear hierarchical relationships with other boosted attributes.

Returns:



3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3833

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#string_list_configuration ⇒ Types::StringListAttributeBoostingConfiguration

Provides information on boosting STRING_LIST type document attributes.

STRING_LIST attributes are not supported when using NativeIndexConfiguration version 2, which focuses on DATE attributes for recency and STRING attributes for source prioritization.

Returns:



3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3833

class DocumentAttributeBoostingConfiguration < Struct.new(
  :number_configuration,
  :string_configuration,
  :date_configuration,
  :string_list_configuration,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringConfiguration < DocumentAttributeBoostingConfiguration; end
  class DateConfiguration < DocumentAttributeBoostingConfiguration; end
  class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
  class Unknown < DocumentAttributeBoostingConfiguration; end
end

#string_list_value ⇒ Array<String>

A list of strings.

Returns:

  • (Array<String>) 


4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4022

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#string_value ⇒ String

A string.

Returns:

  • (String) 


4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4022

class DocumentAttributeValue < Struct.new(
  :string_value,
  :string_list_value,
  :long_value,
  :date_value,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class StringValue < DocumentAttributeValue; end
  class StringListValue < DocumentAttributeValue; end
  class LongValue < DocumentAttributeValue; end
  class DateValue < DocumentAttributeValue; end
  class Unknown < DocumentAttributeValue; end
end

#system_message ⇒ String

An AI-generated message in a TextOutputEvent.

Returns:

  • (String) 


8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8547

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_id ⇒ String

The identifier of an AI-generated message in a TextOutputEvent.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_type ⇒ String

The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

  • RESPONSE - The Amazon Q Business system response.

  • GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

Returns:

  • (String) 


8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8547

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#user ⇒ String

The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.

Returns:

  • (String) 


7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7460

class Principal < Struct.new(
  :user,
  :group,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class User < Principal; end
  class Group < Principal; end
  class Unknown < Principal; end
end

#user_message ⇒ String

A user message in a text message input event.

Returns:

  • (String) 


8505
8506
8507
8508
8509
8510
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8505

class TextInputEvent < Struct.new(
  :user_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_message_id ⇒ String

The identifier of an end user message in a TextOutputEvent.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 291

class ActionReviewEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :plugin_id,
  :plugin_type,
  :payload,
  :payload_field_name_separator,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#video_source_details ⇒ Types::VideoSourceDetails

Details specific to video content within the source.

Returns:



8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8166

class SourceDetails < Struct.new(
  :image_source_details,
  :audio_source_details,
  :video_source_details,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class ImageSourceDetails < SourceDetails; end
  class AudioSourceDetails < SourceDetails; end
  class VideoSourceDetails < SourceDetails; end
  class Unknown < SourceDetails; end
end