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: (String)
  • 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, String]) 


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

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: String, ?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, String]) -> void

Instance Attribute Details

#abstract_text ⇒ String? (readonly)

Returns the value of attribute abstract_text.

Returns:

  • (String, nil) 


1600
1601
1602
 
# File 'sig/types.rbs', line 1600

def abstract_text
  @abstract_text
end

#additional ⇒ Hash[String, String] (readonly)

Returns the value of attribute additional.

Returns:

  • (Hash[String, String]) 


1603
1604
1605
 
# File 'sig/types.rbs', line 1603

def additional
  @additional
end

#authors ⇒ Array[String]? (readonly)

Returns the value of attribute authors.

Returns:

  • (Array[String], nil) 


1584
1585
1586
 
# File 'sig/types.rbs', line 1584

def authors
  @authors
end

#category ⇒ String? (readonly)

Returns the value of attribute category.

Returns:

  • (String, nil) 


1597
1598
1599
 
# File 'sig/types.rbs', line 1597

def category
  @category
end

#created_at ⇒ String? (readonly)

Returns the value of attribute created_at.

Returns:

  • (String, nil) 


1587
1588
1589
 
# File 'sig/types.rbs', line 1587

def created_at
  @created_at
end

#created_by ⇒ String? (readonly)

Returns the value of attribute created_by.

Returns:

  • (String, nil) 


1589
1590
1591
 
# File 'sig/types.rbs', line 1589

def created_by
  @created_by
end

#document_version ⇒ String? (readonly)

Returns the value of attribute document_version.

Returns:

  • (String, nil) 


1599
1600
1601
 
# File 'sig/types.rbs', line 1599

def document_version
  @document_version
end

#error ⇒ ErrorMetadata? (readonly)

Returns the value of attribute error.

Returns:



1595
1596
1597
 
# File 'sig/types.rbs', line 1595

def error
  @error
end

#extraction_duration_ms ⇒ Integer? (readonly)

Returns the value of attribute extraction_duration_ms.

Returns:

  • (Integer, nil) 


1596
1597
1598
 
# File 'sig/types.rbs', line 1596

def extraction_duration_ms
  @extraction_duration_ms
end

#format ⇒ FormatMetadata? (readonly)

Returns the value of attribute format.

Returns:



1592
1593
1594
 
# File 'sig/types.rbs', line 1592

def format
  @format
end

#image_preprocessing ⇒ ImagePreprocessingMetadata? (readonly)

Returns the value of attribute image_preprocessing.

Returns:



1593
1594
1595
 
# File 'sig/types.rbs', line 1593

def image_preprocessing
  @image_preprocessing
end

#json_schema ⇒ String? (readonly)

Returns the value of attribute json_schema.

Returns:

  • (String, nil) 


1594
1595
1596
 
# File 'sig/types.rbs', line 1594

def json_schema
  @json_schema
end

#keywords ⇒ Array[String]? (readonly)

Returns the value of attribute keywords.

Returns:

  • (Array[String], nil) 


1585
1586
1587
 
# File 'sig/types.rbs', line 1585

def keywords
  @keywords
end

#language ⇒ String? (readonly)

Returns the value of attribute language.

Returns:

  • (String, nil) 


1586
1587
1588
 
# File 'sig/types.rbs', line 1586

def language
  @language
end

#modified_at ⇒ String? (readonly)

Returns the value of attribute modified_at.

Returns:

  • (String, nil) 


1588
1589
1590
 
# File 'sig/types.rbs', line 1588

def modified_at
  @modified_at
end

#modified_by ⇒ String? (readonly)

Returns the value of attribute modified_by.

Returns:

  • (String, nil) 


1590
1591
1592
 
# File 'sig/types.rbs', line 1590

def modified_by
  @modified_by
end

#ocr_used ⇒ Boolean (readonly)

Returns the value of attribute ocr_used.

Returns:

  • (Boolean) 


1602
1603
1604
 
# File 'sig/types.rbs', line 1602

def ocr_used
  @ocr_used
end

#output_format ⇒ String? (readonly)

Returns the value of attribute output_format.

Returns:

  • (String, nil) 


1601
1602
1603
 
# File 'sig/types.rbs', line 1601

def output_format
  @output_format
end

#pages ⇒ PageStructure? (readonly)

Returns the value of attribute pages.

Returns:



1591
1592
1593
 
# File 'sig/types.rbs', line 1591

def pages
  @pages
end

#subject ⇒ String? (readonly)

Returns the value of attribute subject.

Returns:

  • (String, nil) 


1583
1584
1585
 
# File 'sig/types.rbs', line 1583

def subject
  @subject
end

#tags ⇒ Array[String]? (readonly)

Returns the value of attribute tags.

Returns:

  • (Array[String], nil) 


1598
1599
1600
 
# File 'sig/types.rbs', line 1598

def tags
  @tags
end

#title ⇒ String? (readonly)

Returns the value of attribute title.

Returns:

  • (String, nil) 


1582
1583
1584
 
# File 'sig/types.rbs', line 1582

def title
  @title
end

Instance Method Details

#is_empty ⇒ Boolean

Returns:

  • (Boolean) 


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

def is_empty: () -> bool