Class: OCI::GenerativeAiInference::Models::ChatDetails

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

Overview

Details of the conversation for the model to respond.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 53

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.serving_mode = attributes[:'servingMode'] if attributes[:'servingMode']

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

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

  self.chat_request = attributes[:'chatRequest'] if attributes[:'chatRequest']

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

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

Instance Attribute Details

#chat_request ⇒ OCI::GenerativeAiInference::Models::BaseChatRequest

Returns:



20
21
22
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 20

def chat_request
  @chat_request
end

#compartment_id ⇒ String

[Required] The OCID of compartment that the user is authorized to use to call into the Generative AI service.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 13

def compartment_id
  @compartment_id
end

#serving_mode ⇒ OCI::GenerativeAiInference::Models::ServingMode

This attribute is required.

Returns:



17
18
19
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 17

def serving_mode
  @serving_mode
end

Class Method Details

.attribute_map ⇒ Object

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



23
24
25
26
27
28
29
30
31
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 23

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'serving_mode': :'servingMode',
    'chat_request': :'chatRequest'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 34

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'serving_mode': :'OCI::GenerativeAiInference::Models::ServingMode',
    'chat_request': :'OCI::GenerativeAiInference::Models::BaseChatRequest'
    # 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



85
86
87
88
89
90
91
92
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 85

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    serving_mode == other.serving_mode &&
    chat_request == other.chat_request
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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 117

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


97
98
99
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



106
107
108
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 106

def hash
  [compartment_id, serving_mode, chat_request].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 150

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



144
145
146
 
# File 'lib/oci/generative_ai_inference/models/chat_details.rb', line 144

def to_s
  to_hash.to_s
end