Class: Vellum::SearchResultMergingRequest

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled: OMIT, additional_properties: nil) ⇒ Vellum::SearchResultMergingRequest

Parameters:

  • enabled (Boolean) (defaults to: OMIT) —

    Whether to enable merging results

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

    Additional properties unmapped to the current class definition



20
21
22
23
24
25
26
 
# File 'lib/vellum_ai/types/search_result_merging_request.rb', line 20

def initialize(enabled: OMIT, additional_properties: nil)
  @enabled = enabled if enabled != OMIT
  @additional_properties = additional_properties
  @_field_set = { "enabled": enabled }.reject do | _k, v |
  v == OMIT
end
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



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

def additional_properties
  @additional_properties
end

#enabled ⇒ Boolean (readonly)

Returns Whether to enable merging results.

Returns:

  • (Boolean) —

    Whether to enable merging results



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

def enabled
  @enabled
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SearchResultMergingRequest

Parameters:

  • json_object (String)

Returns:



31
32
33
34
35
36
 
# File 'lib/vellum_ai/types/search_result_merging_request.rb', line 31

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  enabled = parsed_json["enabled"]
  new(enabled: enabled, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


49
50
51
 
# File 'lib/vellum_ai/types/search_result_merging_request.rb', line 49

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


40
41
42
 
# File 'lib/vellum_ai/types/search_result_merging_request.rb', line 40

def to_json
  @_field_set&.to_json
end