Class: OCI::GenerativeAiInference::Models::CohereAssistantMessageV2

Inherits:
CohereMessageV2
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/cohere_assistant_message_v2.rb

Overview

A message that represents a single chat dialog as CHATBOT role.

Constant Summary

Constants inherited from CohereMessageV2

OCI::GenerativeAiInference::Models::CohereMessageV2::ROLE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CohereMessageV2

#content, #role

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CohereMessageV2

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CohereAssistantMessageV2

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/generative_ai_inference/models/cohere_assistant_message_v2.rb', line 61

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.tool_plan = attributes[:'toolPlan'] if attributes[:'toolPlan']

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

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

  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.citations = attributes[:'citations'] if attributes[:'citations']
end

Instance Attribute Details

#citations ⇒ Array<OCI::GenerativeAiInference::Models::CohereCitationV2>

Cohere citations

Returns:



23
24
25
 
# File 'lib/oci/generative_ai_inference/models/cohere_assistant_message_v2.rb', line 23

def citations
  @citations
end

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

A list of tool calls generated by the model.

Returns:



19
20
21
 
# File 'lib/oci/generative_ai_inference/models/cohere_assistant_message_v2.rb', line 19

def tool_calls
  @tool_calls
end

#tool_plan ⇒ String

A chain-of-thought style reflection and plan that the model generates when working with Tools.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai_inference/models/cohere_assistant_message_v2.rb', line 15

def tool_plan
  @tool_plan
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
 
# File 'lib/oci/generative_ai_inference/models/cohere_assistant_message_v2.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'role',
    'content': :'content',
    'tool_plan': :'toolPlan',
    'tool_calls': :'toolCalls',
    'citations': :'citations'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'role': :'String',
    'content': :'Array<OCI::GenerativeAiInference::Models::CohereContentV2>',
    'tool_plan': :'String',
    'tool_calls': :'Array<OCI::GenerativeAiInference::Models::CohereToolCallV2>',
    'citations': :'Array<OCI::GenerativeAiInference::Models::CohereCitationV2>'
    # 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



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

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

  self.class == other.class &&
    role == other.role &&
    content == other.content &&
    tool_plan == other.tool_plan &&
    tool_calls == other.tool_calls &&
    citations == other.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_inference/models/cohere_assistant_message_v2.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_inference/models/cohere_assistant_message_v2.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_inference/models/cohere_assistant_message_v2.rb', line 116

def hash
  [role, content, tool_plan, tool_calls, 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_inference/models/cohere_assistant_message_v2.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_inference/models/cohere_assistant_message_v2.rb', line 154

def to_s
  to_hash.to_s
end