Class: Vellum::SearchResultDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, label:, external_id: nil, metadata: nil, additional_properties: nil) ⇒ SearchResultDocument

Parameters:

  • id (String) —

    The ID of the document.

  • label (String) —

    The human-readable name for the document.

  • external_id (String) (defaults to: nil) —

    The unique ID of the document as represented in an external system and specified when it was originally uploaded.

  • metadata (Hash{String => String}) (defaults to: nil) —

    A previously supplied JSON object containing metadata that can be filtered on when searching.

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

    Additional properties unmapped to the current class definition



15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 15

def initialize(id:, label:, external_id: nil, metadata: nil, additional_properties: nil)
  # @type [String] The ID of the document.
  @id = id
  # @type [String] The human-readable name for the document.
  @label = label
  # @type [String] The unique ID of the document as represented in an external system and specified when it was originally uploaded.
  @external_id = external_id
  # @type [Hash{String => String}] A previously supplied JSON object containing metadata that can be filtered on when searching.
  @metadata = metadata
  # @type [OpenStruct] Additional properties unmapped to the current class definition
  @additional_properties = additional_properties
end

Instance Attribute Details

#additional_properties ⇒ Object (readonly)

Returns the value of attribute additional_properties.



7
8
9
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 7

def additional_properties
  @additional_properties
end

#external_id ⇒ Object (readonly)

Returns the value of attribute external_id.



7
8
9
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 7

def external_id
  @external_id
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



7
8
9
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 7

def id
  @id
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



7
8
9
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 7

def label
  @label
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



7
8
9
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 7

def metadata
  @metadata
end

Class Method Details

.from_json(json_object:) ⇒ SearchResultDocument

Deserialize a JSON object to an instance of SearchResultDocument

Parameters:

  • json_object (JSON)

Returns:



32
33
34
35
36
37
38
39
40
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 32

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  id = struct.id
  label = struct.label
  external_id = struct.external_id
  metadata = struct.metadata
  new(id: id, label: label, external_id: external_id, metadata: metadata, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object’s property definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


53
54
55
56
57
58
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 53

def self.validate_raw(obj:)
  obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.label.is_a?(String) != false || raise("Passed value for field obj.label is not the expected type, validation failed.")
  obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
  obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of SearchResultDocument to a JSON object

Returns:

  • (JSON) 


45
46
47
 
# File 'lib/vellum_ai/types/search_result_document.rb', line 45

def to_json(*_args)
  { "id": @id, "label": @label, "external_id": @external_id, "metadata": @metadata }.to_json
end