Class: Dataleon::Models::Individuals::GenericDocument

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dataleon::Models::Individuals::GenericDocument

Defined in:

lib/dataleon/models/individuals/generic_document.rb

Overview

See Also:

• Resources::Individuals::Documents#upload

Defined Under Namespace

Classes: Table, Value

Instance Attribute Summary

• #checks ⇒ Array<Dataleon::Models::Check>^?

  List of verification checks performed on the document.

• #created_at ⇒ Time^?

  Timestamp when the document was created or uploaded.

• #document_type ⇒ String^?

  Type/category of the document.

• #id ⇒ String^?

  Unique identifier of the document.

• #name ⇒ String^?

  Name or label for the document.

• #signed_url ⇒ String^?

  Signed URL for accessing the document file.

• #state ⇒ String^?

  Current processing state of the document (e.g., WAITING, PROCESSED).

• #status ⇒ String^?

  Status of the document reception or approval.

• #tables ⇒ Array<Dataleon::Models::Individuals::GenericDocument::Table>^?

  List of tables extracted from the document, each containing operations.

• #values ⇒ Array<Dataleon::Models::Individuals::GenericDocument::Value>^?

  Extracted key-value pairs from the document, including confidence scores.

Instance Method Summary

• #initialize(operation: nil) ⇒ Object constructor

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(operation: nil) ⇒ Object

Parameters:

• operation (Array<Object>) (defaults to: nil) —

  List of operations or actions associated with the table.

# File 'lib/dataleon/models/individuals/generic_document.rb', line 99

Instance Attribute Details

#checks ⇒ Array<Dataleon::Models::Check>^?

List of verification checks performed on the document.

Returns:

• (Array<Dataleon::Models::Check>, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 18

optional :checks, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Check] }

#created_at ⇒ Time^?

Timestamp when the document was created or uploaded.

Returns:

• (Time, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 24

optional :created_at, Time

#document_type ⇒ String^?

Type/category of the document.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 30

optional :document_type, String

#id ⇒ String^?

Unique identifier of the document.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 12

optional :id, String

#name ⇒ String^?

Name or label for the document.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 36

optional :name, String

#signed_url ⇒ String^?

Signed URL for accessing the document file.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 42

optional :signed_url, String

#state ⇒ String^?

Current processing state of the document (e.g., WAITING, PROCESSED).

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 48

optional :state, String

#status ⇒ String^?

Status of the document reception or approval.

Returns:

• (String, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 54

optional :status, String

#tables ⇒ Array<Dataleon::Models::Individuals::GenericDocument::Table>^?

List of tables extracted from the document, each containing operations.

Returns:

• (Array<Dataleon::Models::Individuals::GenericDocument::Table>, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 60

optional :tables, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::GenericDocument::Table] }

#values ⇒ Array<Dataleon::Models::Individuals::GenericDocument::Value>^?

Extracted key-value pairs from the document, including confidence scores.

Returns:

• (Array<Dataleon::Models::Individuals::GenericDocument::Value>, nil)

# File 'lib/dataleon/models/individuals/generic_document.rb', line 66

optional :values, -> { Dataleon::Internal::Type::ArrayOf[Dataleon::Individuals::GenericDocument::Value] }