Class: Aws::QBusiness::Types::MetadataEvent

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

Overview

A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_id ⇒ String

The identifier of the conversation with which the generated metadata is associated.

Returns:

  • (String) 


4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_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



4615
4616
4617
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

def event_type
  @event_type
end

#final_text_message ⇒ String

The final text output message generated by the system.

Returns:

  • (String) 


4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_attributions ⇒ Array<Types::SourceAttribution>

The source documents used to generate the conversation response.

Returns:



4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#system_message_id ⇒ String

The identifier of an Amazon Q Business AI generated message within the conversation.

Returns:

  • (String) 


4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_message_id ⇒ String

The identifier of an Amazon Q Business end user text input message within the conversation.

Returns:

  • (String) 


4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 4615

class MetadataEvent < Struct.new(
  :conversation_id,
  :user_message_id,
  :system_message_id,
  :source_attributions,
  :final_text_message,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end