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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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:



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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 end user text input message in a conversation.

Returns:

  • (String) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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 groups that a user associated with the chat input belongs to.

Returns:

  • (Array<String>) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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) 


1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 1009

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