Class: TrieveRubyClient::GenerateChunksRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/models/generate_chunks_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateChunksRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
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
106
107
108
109
110
111
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 71

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::GenerateChunksRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::GenerateChunksRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'chunk_ids')
    if (value = attributes[:'chunk_ids']).is_a?(Array)
      self.chunk_ids = value
    end
  else
    self.chunk_ids = nil
  end

  if attributes.key?(:'model')
    self.model = attributes[:'model']
  end

  if attributes.key?(:'prev_messages')
    if (value = attributes[:'prev_messages']).is_a?(Array)
      self.prev_messages = value
    end
  else
    self.prev_messages = nil
  end

  if attributes.key?(:'prompt')
    self.prompt = attributes[:'prompt']
  end

  if attributes.key?(:'stream_response')
    self.stream_response = attributes[:'stream_response']
  end
end

Instance Attribute Details

#chunk_ids ⇒ Object

The ids of the chunks to be retrieved and injected into the context window for RAG.



19
20
21
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 19

def chunk_ids
  @chunk_ids
end

#model ⇒ Object

The model to use for the chat. This can be any model from the openrouter model list. If no model is provided, gpt-3.5-turbo will be used.



22
23
24
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 22

def model
  @model
end

#prev_messages ⇒ Object

The previous messages to be placed into the chat history. The last message in this array will be the prompt for the model to inference on. The length of this array must be at least 1.



25
26
27
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 25

def prev_messages
  @prev_messages
end

#prompt ⇒ Object

Prompt for the last message in the prev_messages array. This will be used to generate the next message in the chat. The default is ‘Respond to the instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:’. You can also specify an empty string to leave the final message alone such that your user’s final message can be used as the prompt. See docs.trieve.ai or contact us for more information.



28
29
30
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 28

def prompt
  @prompt
end

#stream_response ⇒ Object

Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true.



31
32
33
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 31

def stream_response
  @stream_response
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 189

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = TrieveRubyClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 34

def self.attribute_map
  {
    :'chunk_ids' => :'chunk_ids',
    :'model' => :'model',
    :'prev_messages' => :'prev_messages',
    :'prompt' => :'prompt',
    :'stream_response' => :'stream_response'
  }
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 165

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
65
66
67
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 61

def self.openapi_nullable
  Set.new([
    :'model',
    :'prompt',
    :'stream_response'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 50

def self.openapi_types
  {
    :'chunk_ids' => :'Array<String>',
    :'model' => :'String',
    :'prev_messages' => :'Array<ChatMessageProxy>',
    :'prompt' => :'String',
    :'stream_response' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
147
148
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      chunk_ids == o.chunk_ids &&
      model == o.model &&
      prev_messages == o.prev_messages &&
      prompt == o.prompt &&
      stream_response == o.stream_response
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 260

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


152
153
154
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 158

def hash
  [chunk_ids, model, prev_messages, prompt, stream_response].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 115

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @chunk_ids.nil?
    invalid_properties.push('invalid value for "chunk_ids", chunk_ids cannot be nil.')
  end

  if @prev_messages.nil?
    invalid_properties.push('invalid value for "prev_messages", prev_messages cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



236
237
238
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 236

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 242

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



230
231
232
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 230

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



131
132
133
134
135
136
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 131

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @chunk_ids.nil?
  return false if @prev_messages.nil?
  true
end