Class: Vellum::SlimDocumentDocumentToDocumentIndex

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

Overview

member of.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, environment_document_index_id:, document_index_id: OMIT, indexing_state: OMIT, additional_properties: nil) ⇒ Vellum::SlimDocumentDocumentToDocumentIndex

Parameters:

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

    Additional properties unmapped to the current class definition



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 48

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



27
28
29
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 27

def additional_properties
  @additional_properties
end

#document_index_id ⇒ Object (readonly)

in.



17
18
19
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 17

def document_index_id
  @document_index_id
end

#environment_document_index_id ⇒ Object (readonly)

is included in.



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

def environment_document_index_id
  @environment_document_index_id
end

#id ⇒ String (readonly)

Returns Vellum-generated ID that uniquely identifies this link.

Returns:

  • (String) —

    Vellum-generated ID that uniquely identifies this link.



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

def id
  @id
end

#indexing_state ⇒ Object (readonly)

  • ‘FAILED` - Failed



25
26
27
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 25

def indexing_state
  @indexing_state
end

Class Method Details

.from_json(json_object:) ⇒ Vellum::SlimDocumentDocumentToDocumentIndex

Parameters:

  • json_object (String)

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 62

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  environment_document_index_id = parsed_json["environment_document_index_id"]
  document_index_id = parsed_json["document_index_id"]
  indexing_state = parsed_json["indexing_state"]
  new(
    id: id,
    environment_document_index_id: environment_document_index_id,
    document_index_id: document_index_id,
    indexing_state: indexing_state,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


89
90
91
92
93
94
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 89

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.environment_document_index_id.is_a?(String) != false || raise("Passed value for field obj.environment_document_index_id is not the expected type, validation failed.")
  obj.document_index_id&.is_a?(String) != false || raise("Passed value for field obj.document_index_id is not the expected type, validation failed.")
  obj.indexing_state&.is_a?(Vellum::IndexingStateEnum) != false || raise("Passed value for field obj.indexing_state is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


80
81
82
 
# File 'lib/vellum_ai/types/slim_document_document_to_document_index.rb', line 80

def to_json
  @_field_set&.to_json
end