Class: Vellum::SentenceChunkerConfigRequest

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

Overview

Configuration for sentence chunking

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(character_limit: OMIT, min_overlap_ratio: OMIT, additional_properties: nil) ⇒ Vellum::SentenceChunkerConfigRequest

Parameters:

  • character_limit (Integer) (defaults to: OMIT)
  • min_overlap_ratio (Float) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



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

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



13
14
15
 
# File 'lib/vellum_ai/types/sentence_chunker_config_request.rb', line 13

def additional_properties
  @additional_properties
end

#character_limit ⇒ Integer (readonly)

Returns:

  • (Integer) 


9
10
11
 
# File 'lib/vellum_ai/types/sentence_chunker_config_request.rb', line 9

def character_limit
  @character_limit
end

#min_overlap_ratio ⇒ Float (readonly)

Returns:

  • (Float) 


11
12
13
 
# File 'lib/vellum_ai/types/sentence_chunker_config_request.rb', line 11

def min_overlap_ratio
  @min_overlap_ratio
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SentenceChunkerConfigRequest

Parameters:

  • json_object (String)

Returns:



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

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


59
60
61
62
 
# File 'lib/vellum_ai/types/sentence_chunker_config_request.rb', line 59

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

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


50
51
52
 
# File 'lib/vellum_ai/types/sentence_chunker_config_request.rb', line 50

def to_json
  @_field_set&.to_json
end