Class: Aws::QBusiness::Types::ActionReviewEvent

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

Overview

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_id ⇒ String

The identifier of the conversation with which the action review event is associated.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

  • (Object) —

    the current value of event_type



291
292
293
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

def event_type
  @event_type
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:



291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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

#payload_field_name_separator ⇒ String

A string used to retain information about the hierarchical contexts within an action review event payload.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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

#plugin_id ⇒ String

The identifier of the plugin associated with the action review event.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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

#plugin_type ⇒ String

The type of plugin.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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

#system_message_id ⇒ String

The identifier of an Amazon Q Business AI generated associated with the action review event.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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

The identifier of the conversation with which the plugin action is associated.

Returns:

  • (String) 


291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 291

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