Class: Vellum::SearchFiltersRequest

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(external_ids: OMIT, metadata: OMIT, additional_properties: nil) ⇒ Vellum::SearchFiltersRequest

Parameters:

  • external_ids (Array<String>) (defaults to: OMIT) —

    The document external IDs to filter by

  • metadata (Vellum::MetadataFiltersRequest) (defaults to: OMIT) —

    The metadata filters to apply to the search

  • 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/search_filters_request.rb', line 24

def initialize(external_ids: OMIT, metadata: OMIT, additional_properties: nil)
  @external_ids = external_ids if external_ids != OMIT
  @metadata = metadata if metadata != OMIT
  @additional_properties = additional_properties
  @_field_set = { "external_ids": external_ids, "metadata": metadata }.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/search_filters_request.rb', line 13

def additional_properties
  @additional_properties
end

#external_ids ⇒ Array<String> (readonly)

Returns The document external IDs to filter by.

Returns:

  • (Array<String>) —

    The document external IDs to filter by



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

def external_ids
  @external_ids
end

#metadata ⇒ Vellum::MetadataFiltersRequest (readonly)

Returns The metadata filters to apply to the search.

Returns:



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

def metadata
  @metadata
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SearchFiltersRequest

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vellum_ai/types/search_filters_request.rb', line 36

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

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


64
65
66
67
 
# File 'lib/vellum_ai/types/search_filters_request.rb', line 64

def self.validate_raw(obj:)
  obj.external_ids&.is_a?(Array) != false || raise("Passed value for field obj.external_ids is not the expected type, validation failed.")
  obj.metadata.nil? || Vellum::MetadataFiltersRequest.validate_raw(obj: obj.metadata)
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


55
56
57
 
# File 'lib/vellum_ai/types/search_filters_request.rb', line 55

def to_json
  @_field_set&.to_json
end