Class: Vellum::UploadDocumentResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_id:, additional_properties: nil) ⇒ UploadDocumentResponse

Parameters:

  • document_id (String) —

    The ID of the newly created document.

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

    Additional properties unmapped to the current class definition



12
13
14
15
16
17
 
# File 'lib/vellum_ai/types/upload_document_response.rb', line 12

def initialize(document_id:, additional_properties: nil)
  # @type [String] The ID of the newly created document.
  @document_id = document_id
  # @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/upload_document_response.rb', line 7

def additional_properties
  @additional_properties
end

#document_id ⇒ Object (readonly)

Returns the value of attribute document_id.



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

def document_id
  @document_id
end

Class Method Details

.from_json(json_object:) ⇒ UploadDocumentResponse

Deserialize a JSON object to an instance of UploadDocumentResponse

Parameters:

  • json_object (JSON)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  JSON.parse(json_object)
  document_id = struct.document_id
  new(document_id: document_id, 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) 


41
42
43
 
# File 'lib/vellum_ai/types/upload_document_response.rb', line 41

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

Instance Method Details

#to_json(*_args) ⇒ JSON

Serialize an instance of UploadDocumentResponse to a JSON object

Returns:

  • (JSON) 


33
34
35
 
# File 'lib/vellum_ai/types/upload_document_response.rb', line 33

def to_json(*_args)
  { "document_id": @document_id }.to_json
end