Class: Aws::QBusiness::Types::ChatSyncInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::ChatSyncInput
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#action_execution ⇒ Types::ActionExecution
A request from an end user to perform an Amazon Q Business plugin action.
-
#application_id ⇒ String
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
-
#attachments ⇒ Array<Types::AttachmentInput>
A list of files uploaded directly during chat.
-
#attribute_filter ⇒ Types::AttributeFilter
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
-
#auth_challenge_response ⇒ Types::AuthChallengeResponse
An authentication verification event response by a third party authentication server to Amazon Q Business.
-
#chat_mode ⇒ String
The
chatMode
parameter determines the chat modes available to Amazon Q Business users:. -
#chat_mode_configuration ⇒ Types::ChatModeConfiguration
The chat mode configuration for an Amazon Q Business application.
-
#client_token ⇒ String
A token that you provide to identify a chat request.
-
#conversation_id ⇒ String
The identifier of the Amazon Q Business conversation.
-
#parent_message_id ⇒ String
The identifier of the previous system message in a conversation.
-
#user_groups ⇒ Array<String>
The group names that a user associated with the chat input belongs to.
-
#user_id ⇒ String
The identifier of the user attached to the chat input.
-
#user_message ⇒ String
A end user message in a conversation.
Instance Attribute Details
#action_execution ⇒ Types::ActionExecution
A request from an end user to perform an Amazon Q Business plugin action.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#application_id ⇒ String
The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#attachments ⇒ Array<Types::AttachmentInput>
A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#attribute_filter ⇒ Types::AttributeFilter
Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#auth_challenge_response ⇒ Types::AuthChallengeResponse
An authentication verification event response by a third party authentication server to Amazon Q Business.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#chat_mode ⇒ String
The chatMode
parameter determines the chat modes available to
Amazon Q Business users:
RETRIEVAL_MODE
- If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "No Answer Found" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledgeCREATOR_MODE
- By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.PLUGIN_MODE
- By selecting this mode, users can choose to use plugins in chat to get their responses.
For more information, see Admin controls and guardrails, Plugins, and Response sources.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#chat_mode_configuration ⇒ Types::ChatModeConfiguration
The chat mode configuration for an Amazon Q Business application.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#client_token ⇒ String
A token that you provide to identify a chat request.
A suitable default value is auto-generated. You should normally not need to pass this option.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#conversation_id ⇒ String
The identifier of the Amazon Q Business conversation.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#parent_message_id ⇒ String
The identifier of the previous system message in a conversation.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#user_groups ⇒ Array<String>
The group names that a user associated with the chat input belongs to.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#user_id ⇒ String
The identifier of the user attached to the chat input.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |
#user_message ⇒ String
A end user message in a conversation.
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1348 class ChatSyncInput < Struct.new( :application_id, :user_id, :user_groups, :user_message, :attachments, :action_execution, :auth_challenge_response, :conversation_id, :parent_message_id, :attribute_filter, :chat_mode, :chat_mode_configuration, :client_token) SENSITIVE = [] include Aws::Structure end |