Class: OCI::GenerativeAiInference::Models::AssistantMessage

Inherits:
Message
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/assistant_message.rb

Overview

Represents a single instance of assistant message.

Note: When responding to a tool call, set content to null (not \"\"). This ensures the model correctly processes tool call messages in multi-step interactions.

Constant Summary

Constants inherited from Message

Message::ROLE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Message

#content, #role

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Message

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AssistantMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 78

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

  attributes['role'] = 'ASSISTANT'

  super(attributes)

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

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

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

  self.tool_calls = attributes[:'toolCalls'] if attributes[:'toolCalls']

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

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

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

  self.reasoning_content = attributes[:'reasoningContent'] if attributes[:'reasoningContent']

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

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

Instance Attribute Details

#annotations ⇒ Array<OCI::GenerativeAiInference::Models::Annotation>

List of annotations generated by the model, including inline citations from web search results.

Returns:



30
31
32
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 30

def annotations
  @annotations
end

#name ⇒ String

An optional name for the participant. Provides the model information to differentiate between participants of the same role.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 18

def name
  @name
end

#reasoning_content ⇒ String

Internal reasoning trace generated during response computation.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 34

def reasoning_content
  @reasoning_content
end

#refusal ⇒ String

The refusal message by the assistant.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 22

def refusal
  @refusal
end

#tool_calls ⇒ Array<OCI::GenerativeAiInference::Models::ToolCall>

The tool calls generated by the model, such as function calls.

Returns:



26
27
28
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 26

def tool_calls
  @tool_calls
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'role',
    'content': :'content',
    'name': :'name',
    'refusal': :'refusal',
    'tool_calls': :'toolCalls',
    'annotations': :'annotations',
    'reasoning_content': :'reasoningContent'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'String',
    'content': :'Array<OCI::GenerativeAiInference::Models::ChatContent>',
    'name': :'String',
    'refusal': :'String',
    'tool_calls': :'Array<OCI::GenerativeAiInference::Models::ToolCall>',
    'annotations': :'Array<OCI::GenerativeAiInference::Models::Annotation>',
    'reasoning_content': :'String'
    # 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



114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 114

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

  self.class == other.class &&
    role == other.role &&
    content == other.content &&
    name == other.name &&
    refusal == other.refusal &&
    tool_calls == other.tool_calls &&
    annotations == other.annotations &&
    reasoning_content == other.reasoning_content
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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 150

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


130
131
132
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 130

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 139

def hash
  [role, content, name, refusal, tool_calls, annotations, reasoning_content].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 183

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



177
178
179
 
# File 'lib/oci/generative_ai_inference/models/assistant_message.rb', line 177

def to_s
  to_hash.to_s
end