Class: Aws::QBusiness::Types::TextOutputEvent

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

Overview

An output event for an AI-generated response in an Amazon Q Business web experience.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_id ⇒ String

The identifier of the conversation with which the text output event is associated.

Returns:

  • (String) 


7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7949

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :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



7949
7950
7951
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7949

def event_type
  @event_type
end

#system_message ⇒ String

An AI-generated message in a TextOutputEvent.

Returns:

  • (String) 


7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7949

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_id ⇒ String

The identifier of an AI-generated message in a TextOutputEvent.

Returns:

  • (String) 


7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7949

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_type ⇒ String

The type of AI-generated message in a TextOutputEvent. Amazon Q Business currently supports two types of messages:

  • RESPONSE - The Amazon Q Business system response.

  • GROUNDED_RESPONSE - The corrected, hallucination-reduced, response returned by Amazon Q Business. Available only if hallucination reduction is supported and configured for the application and detected in the end user chat query by Amazon Q Business.

Returns:

  • (String) 


7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7949

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_message_id ⇒ String

The identifier of an end user message in a TextOutputEvent.

Returns:

  • (String) 


7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 7949

class TextOutputEvent < Struct.new(
  :system_message_type,
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :system_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end