Class: Vellum::DocumentIndexIndexingConfig

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(vectorizer:, chunking: OMIT, additional_properties: nil) ⇒ Vellum::DocumentIndexIndexingConfig

Parameters:



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

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



14
15
16
 
# File 'lib/vellum_ai/types/document_index_indexing_config.rb', line 14

def additional_properties
  @additional_properties
end

#chunking ⇒ Vellum::DocumentIndexChunking (readonly)

Returns:



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

def chunking
  @chunking
end

#vectorizer ⇒ Vellum::IndexingConfigVectorizer (readonly)

Returns:



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

def vectorizer
  @vectorizer
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::DocumentIndexIndexingConfig

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vellum_ai/types/document_index_indexing_config.rb', line 37

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  unless parsed_json["vectorizer"].nil?
    vectorizer = parsed_json["vectorizer"].to_json
    vectorizer = Vellum::IndexingConfigVectorizer.from_json(json_object: vectorizer)
  else
    vectorizer = nil
  end
  unless parsed_json["chunking"].nil?
    chunking = parsed_json["chunking"].to_json
    chunking = Vellum::DocumentIndexChunking.from_json(json_object: chunking)
  else
    chunking = nil
  end
  new(
    vectorizer: vectorizer,
    chunking: chunking,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


70
71
72
73
 
# File 'lib/vellum_ai/types/document_index_indexing_config.rb', line 70

def self.validate_raw(obj:)
  Vellum::IndexingConfigVectorizer.validate_raw(obj: obj.vectorizer)
  obj.chunking.nil? || Vellum::DocumentIndexChunking.validate_raw(obj: obj.chunking)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


61
62
63
 
# File 'lib/vellum_ai/types/document_index_indexing_config.rb', line 61

def to_json
  @_field_set&.to_json
end