Class: Aws::QBusiness::Types::ChatSyncInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_execution ⇒ Types::ActionExecution

A request from an end user to perform an Amazon Q Business plugin action.

Returns:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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 knowledge

  • ‘CREATOR_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.

<note markdown=“1”> If none of the modes are selected, Amazon Q will only respond using the information from the attached files.

</note>

For more information, see [Admin controls and guardrails], [Plugins], and [Response sources].

[1]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html [2]: docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html [3]: docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (Array<String>) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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.

Returns:

  • (String) 


1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1281

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