Module: Aws::QBusiness::Types

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

Defined Under Namespace

Classes: APISchema, AccessConfiguration, AccessControl, AccessDeniedException, ActionExecution, ActionExecutionEvent, ActionExecutionPayloadField, ActionReview, ActionReviewEvent, ActionReviewPayloadField, ActionReviewPayloadFieldAllowedValue, Application, AppliedAttachmentsConfiguration, AppliedCreatorModeConfiguration, AttachmentInput, AttachmentInputEvent, AttachmentOutput, AttachmentsConfiguration, AttributeFilter, AuthChallengeRequest, AuthChallengeRequestEvent, AuthChallengeResponse, AuthChallengeResponseEvent, BasicAuthConfiguration, BatchDeleteDocumentRequest, BatchDeleteDocumentResponse, BatchPutDocumentRequest, BatchPutDocumentResponse, BlockedPhrasesConfiguration, BlockedPhrasesConfigurationUpdate, ChatInput, ChatInputStream, ChatModeConfiguration, ChatOutput, ChatOutputStream, ChatSyncInput, ChatSyncOutput, ConfigurationEvent, ConflictException, ContentBlockerRule, ContentRetrievalRule, Conversation, CreateApplicationRequest, CreateApplicationResponse, CreateDataSourceRequest, CreateDataSourceResponse, CreateIndexRequest, CreateIndexResponse, CreatePluginRequest, CreatePluginResponse, CreateRetrieverRequest, CreateRetrieverResponse, CreateUserRequest, CreateUserResponse, CreateWebExperienceRequest, CreateWebExperienceResponse, CreatorModeConfiguration, CustomPluginConfiguration, DataSource, DataSourceSyncJob, DataSourceSyncJobMetrics, DataSourceVpcConfiguration, DateAttributeBoostingConfiguration, DeleteApplicationRequest, DeleteApplicationResponse, DeleteChatControlsConfigurationRequest, DeleteChatControlsConfigurationResponse, DeleteConversationRequest, DeleteConversationResponse, DeleteDataSourceRequest, DeleteDataSourceResponse, DeleteDocument, DeleteGroupRequest, DeleteGroupResponse, DeleteIndexRequest, DeleteIndexResponse, DeletePluginRequest, DeletePluginResponse, DeleteRetrieverRequest, DeleteRetrieverResponse, DeleteUserRequest, DeleteUserResponse, DeleteWebExperienceRequest, DeleteWebExperienceResponse, Document, DocumentAttribute, DocumentAttributeBoostingConfiguration, DocumentAttributeCondition, DocumentAttributeConfiguration, DocumentAttributeTarget, DocumentAttributeValue, DocumentContent, DocumentDetails, DocumentEnrichmentConfiguration, EligibleDataSource, EncryptionConfiguration, ErrorDetail, FailedAttachmentEvent, FailedDocument, GetApplicationRequest, GetApplicationResponse, GetChatControlsConfigurationRequest, GetChatControlsConfigurationResponse, GetDataSourceRequest, GetDataSourceResponse, GetGroupRequest, GetGroupResponse, GetIndexRequest, GetIndexResponse, GetPluginRequest, GetPluginResponse, GetRetrieverRequest, GetRetrieverResponse, GetUserRequest, GetUserResponse, GetWebExperienceRequest, GetWebExperienceResponse, GroupMembers, GroupStatusDetail, GroupSummary, HookConfiguration, Index, IndexCapacityConfiguration, IndexStatistics, InlineDocumentEnrichmentConfiguration, InternalServerException, KendraIndexConfiguration, LicenseNotFoundException, ListApplicationsRequest, ListApplicationsResponse, ListConversationsRequest, ListConversationsResponse, ListDataSourceSyncJobsRequest, ListDataSourceSyncJobsResponse, ListDataSourcesRequest, ListDataSourcesResponse, ListDocumentsRequest, ListDocumentsResponse, ListGroupsRequest, ListGroupsResponse, ListIndicesRequest, ListIndicesResponse, ListMessagesRequest, ListMessagesResponse, ListPluginsRequest, ListPluginsResponse, ListRetrieversRequest, ListRetrieversResponse, ListTagsForResourceRequest, ListTagsForResourceResponse, ListWebExperiencesRequest, ListWebExperiencesResponse, MemberGroup, MemberUser, Message, MessageUsefulnessFeedback, MetadataEvent, NativeIndexConfiguration, NumberAttributeBoostingConfiguration, OAuth2ClientCredentialConfiguration, Plugin, PluginAuthConfiguration, PluginConfiguration, Principal, PrincipalGroup, PrincipalUser, PutFeedbackRequest, PutGroupRequest, PutGroupResponse, ResourceNotFoundException, Retriever, RetrieverConfiguration, Rule, RuleConfiguration, S3, SamlConfiguration, ServiceQuotaExceededException, SnippetExcerpt, SourceAttribution, StartDataSourceSyncJobRequest, StartDataSourceSyncJobResponse, StopDataSourceSyncJobRequest, StopDataSourceSyncJobResponse, StringAttributeBoostingConfiguration, StringListAttributeBoostingConfiguration, Tag, TagResourceRequest, TagResourceResponse, TextDocumentStatistics, TextInputEvent, TextOutputEvent, TextSegment, ThrottlingException, TopicConfiguration, UntagResourceRequest, UntagResourceResponse, UpdateApplicationRequest, UpdateApplicationResponse, UpdateChatControlsConfigurationRequest, UpdateChatControlsConfigurationResponse, UpdateDataSourceRequest, UpdateDataSourceResponse, UpdateIndexRequest, UpdateIndexResponse, UpdatePluginRequest, UpdatePluginResponse, UpdateRetrieverRequest, UpdateRetrieverResponse, UpdateUserRequest, UpdateUserResponse, UpdateWebExperienceRequest, UpdateWebExperienceResponse, UserAlias, UsersAndGroups, ValidationException, ValidationExceptionField, WebExperience, WebExperienceAuthConfiguration

Instance Attribute Summary collapse

Instance Attribute Details

#attachment ⇒ Types::AttachmentOutput

The details of a file uploaded during chat.

Returns:



453
454
455
456
457
458
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 453

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:



1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1126

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
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) 


631
632
633
634
635
636
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 631

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:



4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4777

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

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < 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) 


2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2577

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) 


1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1126

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:



1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1126

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:



5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5133

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:



5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5133

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_id ⇒ String

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

Returns:

  • (String) 


257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 257

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.

Returns:



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352

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) 


2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2541

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) 


4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

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 ⇒ Types::PrincipalGroup

The group associated with the principal.

Returns:



4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4830

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

#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:



5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5072

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) 


2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2541

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:



5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5072

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) 


4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4777

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

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

#number_configuration ⇒ Types::NumberAttributeBoostingConfiguration

Provides information on boosting NUMBER type document attributes.

Returns:



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352

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:



4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4777

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

  class BasicAuthConfiguration < PluginAuthConfiguration; end
  class OAuth2ClientCredentialConfiguration < PluginAuthConfiguration; end
  class NoAuthConfiguration < PluginAuthConfiguration; end
  class Unknown < PluginAuthConfiguration; 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) 


158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 158

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:



902
903
904
905
906
907
908
909
910
911
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 902

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) 


158
159
160
161
162
163
164
165
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 158

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) 


257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 257

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>) 


665
666
667
668
669
670
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 665

class AuthChallengeResponseEvent < Struct.new(
  :response_map,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
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:



6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 6190

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

  class SamlConfiguration < WebExperienceAuthConfiguration; end
  class Unknown < WebExperienceAuthConfiguration; end
end

#source_attributions ⇒ Array<Types::SourceAttribution>

The source documents used to generate the conversation response.

Returns:



4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

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.

Returns:



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352

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.

Returns:



2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2352

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>) 


2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2541

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) 


2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2541

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) 


5525
5526
5527
5528
5529
5530
5531
5532
5533
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5525

class TextOutputEvent < Struct.new(
  :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) 


257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 257

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

#user ⇒ Types::PrincipalUser

The user associated with the principal.

Returns:



4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4830

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) 


5496
5497
5498
5499
5500
5501
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5496

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) 


257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 257

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