Class: Vellum::SearchResultMetaRequest

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source: OMIT, additional_properties: nil) ⇒ Vellum::SearchResultMetaRequest

Parameters:



22
23
24
25
26
27
28
 
# File 'lib/vellum_ai/types/search_result_meta_request.rb', line 22

def initialize(source: OMIT, additional_properties: nil)
  @source = source if source != OMIT
  @additional_properties = additional_properties
  @_field_set = { "source": source }.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_result_meta_request.rb', line 12

def additional_properties
  @additional_properties
end

#source ⇒ Vellum::COMPONENTS_SCHEMAS_PDF_SEARCH_RESULT_META_SOURCE_REQUEST (readonly)

Returns:



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

def source
  @source
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SearchResultMetaRequest

Parameters:

  • json_object (String)

Returns:



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/vellum_ai/types/search_result_meta_request.rb', line 33

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


56
57
58
 
# File 'lib/vellum_ai/types/search_result_meta_request.rb', line 56

def self.validate_raw(obj:)
  obj.source.nil? || Vellum::PdfSearchResultMetaSourceRequest.validate_raw(obj: obj.source)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


47
48
49
 
# File 'lib/vellum_ai/types/search_result_meta_request.rb', line 47

def to_json
  @_field_set&.to_json
end