Class: OCI::GenerativeAiAgentRuntime::Models::RagToolOutput

Inherits:
ToolOutput
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb

Overview

Specifies the output format for RAG tool, including the generated answer and citations.

Constant Summary

Constants inherited from ToolOutput

ToolOutput::TOOL_OUTPUT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ToolOutput

#tool_id, #tool_name, #tool_output_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ToolOutput

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RagToolOutput

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 64

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['toolOutputType'] = 'RAG_TOOL_OUTPUT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.text = attributes[:'text'] if attributes[:'text']

  self.citations = attributes[:'citations'] if attributes[:'citations']

  self.paragraph_citations = attributes[:'paragraphCitations'] if attributes[:'paragraphCitations']

  raise 'You cannot provide both :paragraphCitations and :paragraph_citations' if attributes.key?(:'paragraphCitations') && attributes.key?(:'paragraph_citations')

  self.paragraph_citations = attributes[:'paragraph_citations'] if attributes[:'paragraph_citations']
end

Instance Attribute Details

#citations ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::Citation>

Citations to data sources used for tool's generated answer.

Returns:



19
20
21
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 19

def citations
  @citations
end

#paragraph_citations ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::ParagraphCitation>

A list of citations used to generate the paragraphs of the tool's generated answer.

Returns:



23
24
25
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 23

def paragraph_citations
  @paragraph_citations
end

#text ⇒ String

[Required] Specifies the generated answer from the RAG tool.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 15

def text
  @text
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_id': :'toolId',
    'tool_name': :'toolName',
    'tool_output_type': :'toolOutputType',
    'text': :'text',
    'citations': :'citations',
    'paragraph_citations': :'paragraphCitations'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_id': :'String',
    'tool_name': :'String',
    'tool_output_type': :'String',
    'text': :'String',
    'citations': :'Array<OCI::GenerativeAiAgentRuntime::Models::Citation>',
    'paragraph_citations': :'Array<OCI::GenerativeAiAgentRuntime::Models::ParagraphCitation>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 92

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    tool_id == other.tool_id &&
    tool_name == other.tool_name &&
    tool_output_type == other.tool_output_type &&
    text == other.text &&
    citations == other.citations &&
    paragraph_citations == other.paragraph_citations
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 127

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


107
108
109
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 116

def hash
  [tool_id, tool_name, tool_output_type, text, citations, paragraph_citations].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 160

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



154
155
156
 
# File 'lib/oci/generative_ai_agent_runtime/models/rag_tool_output.rb', line 154

def to_s
  to_hash.to_s
end