Class: Vellum::SearchWeightsRequest

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

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

    The relative weight to give to semantic similarity

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

    The relative weight to give to keywords

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

    Additional properties unmapped to the current class definition



23
24
25
26
27
28
29
30
 
# File 'lib/vellum_ai/types/search_weights_request.rb', line 23

def initialize(semantic_similarity: OMIT, keywords: OMIT, additional_properties: nil)
  @semantic_similarity = semantic_similarity if semantic_similarity != OMIT
  @keywords = keywords if keywords != OMIT
  @additional_properties = additional_properties
  @_field_set = { "semantic_similarity": semantic_similarity, "keywords": keywords }.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



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

def additional_properties
  @additional_properties
end

#keywords ⇒ Float (readonly)

Returns The relative weight to give to keywords.

Returns:

  • (Float) —

    The relative weight to give to keywords



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

def keywords
  @keywords
end

#semantic_similarity ⇒ Float (readonly)

Returns The relative weight to give to semantic similarity.

Returns:

  • (Float) —

    The relative weight to give to semantic similarity



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

def semantic_similarity
  @semantic_similarity
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SearchWeightsRequest

Parameters:

  • json_object (String)

Returns:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/vellum_ai/types/search_weights_request.rb', line 35

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


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

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 ⇒ String

Returns:

  • (String) 


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

def to_json
  @_field_set&.to_json
end