Class: Aws::QBusiness::Types::ConfigurationEvent

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

Overview

A configuration event activated by an end user request to select a specific chat mode.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_filter ⇒ Types::AttributeFilter

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

Returns:



1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1398

class ConfigurationEvent < Struct.new(
  :chat_mode,
  :chat_mode_configuration,
  :attribute_filter,
  :event_type)
  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].

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


1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1398

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].

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

Returns:



1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1398

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

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

  • (Object) —

    the current value of event_type



1398
1399
1400
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 1398

def event_type
  @event_type
end