Class: Vellum::SearchResultsInput

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/types/search_results_input.rb

Overview

A user input representing a search results value

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, type:, value:, additional_properties: nil) ⇒ Vellum::SearchResultsInput

Parameters:

  • name (String) —

    The variable’s name

  • type (String)
  • value (Array<Vellum::SearchResult>)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
34
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 28

def initialize(name:, type:, value:, additional_properties: nil)
  @name = name
  @type = type
  @value = value
  @additional_properties = additional_properties
  @_field_set = { "name": name, "type": type, "value": value }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



16
17
18
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 16

def additional_properties
  @additional_properties
end

#name ⇒ String (readonly)

Returns The variable’s name.

Returns:

  • (String) —

    The variable’s name



10
11
12
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 10

def name
  @name
end

#type ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 12

def type
  @type
end

#value ⇒ Array<Vellum::SearchResult> (readonly)

Returns:



14
15
16
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 14

def value
  @value
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SearchResultsInput

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 39

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  name = parsed_json["name"]
  type = parsed_json["type"]
  value = parsed_json["value"]&.map do | item |
  item = item.to_json
  Vellum::SearchResult.from_json(json_object: item)
end
  new(
    name: name,
    type: type,
    value: value,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


67
68
69
70
71
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 67

def self.validate_raw(obj:)
  obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
  obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
  obj.value.is_a?(Array) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


58
59
60
 
# File 'lib/vellum_ai/types/search_results_input.rb', line 58

def to_json
  @_field_set&.to_json
end