Class: Vellum::SearchResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(results:, additional_properties: nil) ⇒ SearchResponse

Parameters:

  • results (Array<SearchResult>) —

    The results of the search. Each result represents a chunk that matches the search query.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



13
14
15
16
17
18
 
# File 'lib/vellum_ai/types/search_response.rb', line 13

def initialize(results:, additional_properties: nil)
  # @type [Array<SearchResult>] The results of the search. Each result represents a chunk that matches the search query.
  @results = results
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



8
9
10
 
# File 'lib/vellum_ai/types/search_response.rb', line 8

def additional_properties
  @additional_properties
end

#results ⇒ Object (readonly)

Returns the value of attribute results.



8
9
10
 
# File 'lib/vellum_ai/types/search_response.rb', line 8

def results
  @results
end

Class Method Details

.from_json(json_object:) ⇒ SearchResponse

Deserialize a JSON object to an instance of SearchResponse

Parameters:

  • json_object (JSON)

Returns:



24
25
26
27
28
29
30
31
32
 
# File 'lib/vellum_ai/types/search_response.rb', line 24

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  results = parsed_json["results"].map do |v|
    v = v.to_json
    SearchResult.from_json(json_object: v)
  end
  new(results: results, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


45
46
47
 
# File 'lib/vellum_ai/types/search_response.rb', line 45

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SearchResponse to a JSON object

Returns:

  • (JSON) 


37
38
39
 
# File 'lib/vellum_ai/types/search_response.rb', line 37

def to_json(*_args)
  { "results": @results }.to_json
end