Class: Vellum::SearchWeightsRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(semantic_similarity: nil, keywords: nil, additional_properties: nil) ⇒ SearchWeightsRequest

Parameters:

  • semantic_similarity (Float) (defaults to: nil) —

    The relative weight to give to semantic similarity

  • keywords (Float) (defaults to: nil) —

    The relative weight to give to keywords

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

    Additional properties unmapped to the current class definition



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

def initialize(semantic_similarity: nil, keywords: nil, additional_properties: nil)
  # @type [Float] The relative weight to give to semantic similarity
  @semantic_similarity = semantic_similarity
  # @type [Float] The relative weight to give to keywords
  @keywords = keywords
  # @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.



7
8
9
 
# File 'lib/vellum_ai/types/search_weights_request.rb', line 7

def additional_properties
  @additional_properties
end

#keywords ⇒ Object (readonly)

Returns the value of attribute keywords.



7
8
9
 
# File 'lib/vellum_ai/types/search_weights_request.rb', line 7

def keywords
  @keywords
end

#semantic_similarity ⇒ Object (readonly)

Returns the value of attribute semantic_similarity.



7
8
9
 
# File 'lib/vellum_ai/types/search_weights_request.rb', line 7

def semantic_similarity
  @semantic_similarity
end

Class Method Details

.from_json(json_object:) ⇒ SearchWeightsRequest

Deserialize a JSON object to an instance of SearchWeightsRequest

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  semantic_similarity = struct.semantic_similarity
  keywords = struct.keywords
  new(semantic_similarity: semantic_similarity, keywords: keywords, 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
48
 
# File 'lib/vellum_ai/types/search_weights_request.rb', line 45

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SearchWeightsRequest to a JSON object

Returns:

  • (JSON) 


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

def to_json(*_args)
  { "semantic_similarity": @semantic_similarity, "keywords": @keywords }.to_json
end