Class: RagieRubySdk::Instruction

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/models/instruction.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Instruction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 116

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  else
    self.updated_at = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  else
    self.active = true
  end

  if attributes.key?(:'scope')
    self.scope = attributes[:'scope']
  else
    self.scope = 'chunk'
  end

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

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

  if attributes.key?(:'filter')
    if (value = attributes[:'filter']).is_a?(Hash)
      self.filter = value
    end
  end

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

Instance Attribute Details

#active ⇒ Object

Whether the instruction is active. Active instructions are applied to documents when they’re created or when their file is updated.



28
29
30
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 28

def active
  @active
end

#created_at ⇒ Object

Returns the value of attribute created_at.



20
21
22
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 20

def created_at
  @created_at
end

#entity_schema ⇒ Object

Returns the value of attribute entity_schema.



36
37
38
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 36

def entity_schema
  @entity_schema
end

#filter ⇒ Object

An optional metadata filter that is matched against document metadata during update and creation. The instruction will only be applied to documents with metadata matching the filter. The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read [Metadata & Filters guide](docs.ragie.ai/docs/metadata-filters) for more details and examples.



39
40
41
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 39

def filter
  @filter
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 18

def id
  @id
end

#name ⇒ Object

The name of the instruction. Must be unique.



25
26
27
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 25

def name
  @name
end

#partition ⇒ Object

An optional partition identifier. Instructions can be scoped to a partition. An instruction that defines a partition will only be executed for documents in that partition.



42
43
44
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 42

def partition
  @partition
end

#prompt ⇒ Object

A natural language instruction which will be applied to documents as they are created and updated. The results of the ‘instruction_prompt` will be stored as an `entity` in the schema defined by the `entity_schema` parameter.



34
35
36
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 34

def prompt
  @prompt
end

#scope ⇒ Object

The scope of the instruction. Determines whether the instruction is applied to the entire document or to each chunk of the document. Options are ‘’document’‘ or `’chunk’‘. Generally `’document’‘ should be used when analyzing the full document is desired, such as when generating a summary or determining sentiment, and `’chunk’‘ should be used when a fine grained search over a document is desired.



31
32
33
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 31

def scope
  @scope
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



22
23
24
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 22

def updated_at
  @updated_at
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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 364

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 = RagieRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



83
84
85
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 83

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 88

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'active' => :'active',
    :'scope' => :'scope',
    :'prompt' => :'prompt',
    :'entity_schema' => :'entity_schema',
    :'filter' => :'filter',
    :'partition' => :'partition'
  }
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 340

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



109
110
111
112
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 109

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 93

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'active' => :'Boolean',
    :'scope' => :'String',
    :'prompt' => :'String',
    :'entity_schema' => :'Hash<String, Object>',
    :'filter' => :'Hash<String, Object>',
    :'partition' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 310

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      active == o.active &&
      scope == o.scope &&
      prompt == o.prompt &&
      entity_schema == o.entity_schema &&
      filter == o.filter &&
      partition == o.partition
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



435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 435

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


327
328
329
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



333
334
335
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 333

def hash
  [id, created_at, updated_at, name, active, scope, prompt, entity_schema, filter, partition].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



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
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 193

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

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

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

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

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

  if @entity_schema.nil?
    invalid_properties.push('invalid value for "entity_schema", entity_schema 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



411
412
413
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 411

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 417

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



405
406
407
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 405

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



225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/ragie_ruby_sdk/models/instruction.rb', line 225

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @name.nil?
  scope_validator = EnumAttributeValidator.new('String', ["document", "chunk"])
  return false unless scope_validator.valid?(@scope)
  return false if @prompt.nil?
  return false if @entity_schema.nil?
  true
end