Class: Xberg::Metadata

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Metadata

Returns a new instance of Metadata.

Parameters:

  • title: (String)
  • subject: (String)
  • authors: (Array[String])
  • keywords: (Array[String])
  • language: (String)
  • created_at: (String)
  • modified_at: (String)
  • created_by: (String)
  • modified_by: (String)
  • pages: (PageStructure)
  • format: (FormatMetadata)
  • image_preprocessing: (ImagePreprocessingMetadata)
  • json_schema: (json_value)
  • error: (ErrorMetadata)
  • extraction_duration_ms: (Integer)
  • category: (String)
  • tags: (Array[String])
  • document_version: (String)
  • abstract_text: (String)
  • output_format: (String)
  • ocr_used: (Boolean)
  • additional: (Hash[String, json_value]) 


1331
 
# File 'sig/types.rbs', line 1331

def initialize: (?title: String, ?subject: String, ?authors: Array[String], ?keywords: Array[String], ?language: String, ?created_at: String, ?modified_at: String, ?created_by: String, ?modified_by: String, ?pages: PageStructure, ?format: FormatMetadata, ?image_preprocessing: ImagePreprocessingMetadata, ?json_schema: json_value, ?error: ErrorMetadata, ?extraction_duration_ms: Integer, ?category: String, ?tags: Array[String], ?document_version: String, ?abstract_text: String, ?output_format: String, ?ocr_used: bool, ?additional: Hash[String, json_value]) -> void

Instance Attribute Details

#abstract_text ⇒ String?

Returns the value of attribute abstract_text.

Returns:

  • (String, nil) 


1326
1327
1328
 
# File 'sig/types.rbs', line 1326

def abstract_text
  @abstract_text
end

#additional ⇒ Hash[String, json_value]?

Returns the value of attribute additional.

Returns:

  • (Hash[String, json_value], nil) 


1329
1330
1331
 
# File 'sig/types.rbs', line 1329

def additional
  @additional
end

#authors ⇒ Array[String]?

Returns the value of attribute authors.

Returns:

  • (Array[String], nil) 


1310
1311
1312
 
# File 'sig/types.rbs', line 1310

def authors
  @authors
end

#category ⇒ String?

Returns the value of attribute category.

Returns:

  • (String, nil) 


1323
1324
1325
 
# File 'sig/types.rbs', line 1323

def category
  @category
end

#created_at ⇒ String?

Returns the value of attribute created_at.

Returns:

  • (String, nil) 


1313
1314
1315
 
# File 'sig/types.rbs', line 1313

def created_at
  @created_at
end

#created_by ⇒ String?

Returns the value of attribute created_by.

Returns:

  • (String, nil) 


1315
1316
1317
 
# File 'sig/types.rbs', line 1315

def created_by
  @created_by
end

#document_version ⇒ String?

Returns the value of attribute document_version.

Returns:

  • (String, nil) 


1325
1326
1327
 
# File 'sig/types.rbs', line 1325

def document_version
  @document_version
end

#error ⇒ ErrorMetadata?

Returns the value of attribute error.

Returns:



1321
1322
1323
 
# File 'sig/types.rbs', line 1321

def error
  @error
end

#extraction_duration_ms ⇒ Integer?

Returns the value of attribute extraction_duration_ms.

Returns:

  • (Integer, nil) 


1322
1323
1324
 
# File 'sig/types.rbs', line 1322

def extraction_duration_ms
  @extraction_duration_ms
end

#format ⇒ FormatMetadata?

Returns the value of attribute format.

Returns:



1318
1319
1320
 
# File 'sig/types.rbs', line 1318

def format
  @format
end

#image_preprocessing ⇒ ImagePreprocessingMetadata?

Returns the value of attribute image_preprocessing.

Returns:



1319
1320
1321
 
# File 'sig/types.rbs', line 1319

def image_preprocessing
  @image_preprocessing
end

#json_schema ⇒ json_value?

Returns the value of attribute json_schema.

Returns:

  • (json_value, nil) 


1320
1321
1322
 
# File 'sig/types.rbs', line 1320

def json_schema
  @json_schema
end

#keywords ⇒ Array[String]?

Returns the value of attribute keywords.

Returns:

  • (Array[String], nil) 


1311
1312
1313
 
# File 'sig/types.rbs', line 1311

def keywords
  @keywords
end

#language ⇒ String?

Returns the value of attribute language.

Returns:

  • (String, nil) 


1312
1313
1314
 
# File 'sig/types.rbs', line 1312

def language
  @language
end

#modified_at ⇒ String?

Returns the value of attribute modified_at.

Returns:

  • (String, nil) 


1314
1315
1316
 
# File 'sig/types.rbs', line 1314

def modified_at
  @modified_at
end

#modified_by ⇒ String?

Returns the value of attribute modified_by.

Returns:

  • (String, nil) 


1316
1317
1318
 
# File 'sig/types.rbs', line 1316

def modified_by
  @modified_by
end

#ocr_used ⇒ Boolean?

Returns the value of attribute ocr_used.

Returns:

  • (Boolean, nil) 


1328
1329
1330
 
# File 'sig/types.rbs', line 1328

def ocr_used
  @ocr_used
end

#output_format ⇒ String?

Returns the value of attribute output_format.

Returns:

  • (String, nil) 


1327
1328
1329
 
# File 'sig/types.rbs', line 1327

def output_format
  @output_format
end

#pages ⇒ PageStructure?

Returns the value of attribute pages.

Returns:



1317
1318
1319
 
# File 'sig/types.rbs', line 1317

def pages
  @pages
end

#subject ⇒ String?

Returns the value of attribute subject.

Returns:

  • (String, nil) 


1309
1310
1311
 
# File 'sig/types.rbs', line 1309

def subject
  @subject
end

#tags ⇒ Array[String]?

Returns the value of attribute tags.

Returns:

  • (Array[String], nil) 


1324
1325
1326
 
# File 'sig/types.rbs', line 1324

def tags
  @tags
end

#title ⇒ String?

Returns the value of attribute title.

Returns:

  • (String, nil) 


1308
1309
1310
 
# File 'sig/types.rbs', line 1308

def title
  @title
end

Instance Method Details

#is_empty ⇒ Boolean

Returns:

  • (Boolean) 


1332
 
# File 'sig/types.rbs', line 1332

def is_empty: () -> bool