Class: Xberg::ExtractedDocument

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ExtractedDocument

Returns a new instance of ExtractedDocument.

Parameters:



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

def initialize: (?content: String, ?mime_type: String, ?metadata: Metadata, ?extraction_method: ExtractionMethod, ?tables: Array[Table], ?detected_languages: Array[String], ?chunks: Array[Chunk], ?images: Array[ExtractedImage], ?pages: Array[PageContent], ?elements: Array[Element], ?djot_content: DjotContent, ?ocr_elements: Array[OcrElement], ?document: DocumentStructure, ?extracted_keywords: Array[Keyword], ?quality_score: Float, ?processing_warnings: Array[ProcessingWarning], ?annotations: Array[PdfAnnotation], ?children: Array[ArchiveEntry], ?uris: Array[ExtractedUri], ?revisions: Array[DocumentRevision], ?structured_output: json_value, ?code_intelligence: json_value, ?llm_usage: Array[LlmUsage], ?entities: Array[Entity], ?summary: DocumentSummary, ?extraction_confidence: ExtractionConfidence, ?translation: Translation, ?page_classifications: Array[PageClassification], ?redaction_report: RedactionReport, ?formulas: Array[Formula], ?form_fields: Array[PdfFormField], ?formatted_content: String) -> void

Instance Attribute Details

#annotations ⇒ Array[PdfAnnotation]?

Returns the value of attribute annotations.

Returns:



904
905
906
 
# File 'sig/types.rbs', line 904

def annotations
  @annotations
end

#children ⇒ Array[ArchiveEntry]?

Returns the value of attribute children.

Returns:



905
906
907
 
# File 'sig/types.rbs', line 905

def children
  @children
end

#chunks ⇒ Array[Chunk]?

Returns the value of attribute chunks.

Returns:



894
895
896
 
# File 'sig/types.rbs', line 894

def chunks
  @chunks
end

#code_intelligence ⇒ json_value?

Returns the value of attribute code_intelligence.

Returns:

  • (json_value, nil) 


909
910
911
 
# File 'sig/types.rbs', line 909

def code_intelligence
  @code_intelligence
end

#content ⇒ String?

Returns the value of attribute content.

Returns:

  • (String, nil) 


888
889
890
 
# File 'sig/types.rbs', line 888

def content
  @content
end

#detected_languages ⇒ Array[String]?

Returns the value of attribute detected_languages.

Returns:

  • (Array[String], nil) 


893
894
895
 
# File 'sig/types.rbs', line 893

def detected_languages
  @detected_languages
end

#djot_content ⇒ DjotContent?

Returns the value of attribute djot_content.

Returns:



898
899
900
 
# File 'sig/types.rbs', line 898

def djot_content
  @djot_content
end

#document ⇒ DocumentStructure?

Returns the value of attribute document.

Returns:



900
901
902
 
# File 'sig/types.rbs', line 900

def document
  @document
end

#elements ⇒ Array[Element]?

Returns the value of attribute elements.

Returns:



897
898
899
 
# File 'sig/types.rbs', line 897

def elements
  @elements
end

#entities ⇒ Array[Entity]?

Returns the value of attribute entities.

Returns:



911
912
913
 
# File 'sig/types.rbs', line 911

def entities
  @entities
end

#extracted_keywords ⇒ Array[Keyword]?

Returns the value of attribute extracted_keywords.

Returns:



901
902
903
 
# File 'sig/types.rbs', line 901

def extracted_keywords
  @extracted_keywords
end

#extraction_confidence ⇒ ExtractionConfidence?

Returns the value of attribute extraction_confidence.

Returns:



913
914
915
 
# File 'sig/types.rbs', line 913

def extraction_confidence
  @extraction_confidence
end

#extraction_method ⇒ ExtractionMethod?

Returns the value of attribute extraction_method.

Returns:



891
892
893
 
# File 'sig/types.rbs', line 891

def extraction_method
  @extraction_method
end

#form_fields ⇒ Array[PdfFormField]?

Returns the value of attribute form_fields.

Returns:



918
919
920
 
# File 'sig/types.rbs', line 918

def form_fields
  @form_fields
end

#formatted_content ⇒ String?

Returns the value of attribute formatted_content.

Returns:

  • (String, nil) 


919
920
921
 
# File 'sig/types.rbs', line 919

def formatted_content
  @formatted_content
end

#formulas ⇒ Array[Formula]?

Returns the value of attribute formulas.

Returns:



917
918
919
 
# File 'sig/types.rbs', line 917

def formulas
  @formulas
end

#images ⇒ Array[ExtractedImage]?

Returns the value of attribute images.

Returns:



895
896
897
 
# File 'sig/types.rbs', line 895

def images
  @images
end

#llm_usage ⇒ Array[LlmUsage]?

Returns the value of attribute llm_usage.

Returns:



910
911
912
 
# File 'sig/types.rbs', line 910

def llm_usage
  @llm_usage
end

#metadata ⇒ Metadata?

Returns the value of attribute metadata.

Returns:



890
891
892
 
# File 'sig/types.rbs', line 890

def metadata
  @metadata
end

#mime_type ⇒ String?

Returns the value of attribute mime_type.

Returns:

  • (String, nil) 


889
890
891
 
# File 'sig/types.rbs', line 889

def mime_type
  @mime_type
end

#ocr_elements ⇒ Array[OcrElement]?

Returns the value of attribute ocr_elements.

Returns:



899
900
901
 
# File 'sig/types.rbs', line 899

def ocr_elements
  @ocr_elements
end

#page_classifications ⇒ Array[PageClassification]?

Returns the value of attribute page_classifications.

Returns:



915
916
917
 
# File 'sig/types.rbs', line 915

def page_classifications
  @page_classifications
end

#pages ⇒ Array[PageContent]?

Returns the value of attribute pages.

Returns:



896
897
898
 
# File 'sig/types.rbs', line 896

def pages
  @pages
end

#processing_warnings ⇒ Array[ProcessingWarning]?

Returns the value of attribute processing_warnings.

Returns:



903
904
905
 
# File 'sig/types.rbs', line 903

def processing_warnings
  @processing_warnings
end

#quality_score ⇒ Float?

Returns the value of attribute quality_score.

Returns:

  • (Float, nil) 


902
903
904
 
# File 'sig/types.rbs', line 902

def quality_score
  @quality_score
end

#redaction_report ⇒ RedactionReport?

Returns the value of attribute redaction_report.

Returns:



916
917
918
 
# File 'sig/types.rbs', line 916

def redaction_report
  @redaction_report
end

#revisions ⇒ Array[DocumentRevision]?

Returns the value of attribute revisions.

Returns:



907
908
909
 
# File 'sig/types.rbs', line 907

def revisions
  @revisions
end

#structured_output ⇒ json_value?

Returns the value of attribute structured_output.

Returns:

  • (json_value, nil) 


908
909
910
 
# File 'sig/types.rbs', line 908

def structured_output
  @structured_output
end

#summary ⇒ DocumentSummary?

Returns the value of attribute summary.

Returns:



912
913
914
 
# File 'sig/types.rbs', line 912

def summary
  @summary
end

#tables ⇒ Array[Table]?

Returns the value of attribute tables.

Returns:



892
893
894
 
# File 'sig/types.rbs', line 892

def tables
  @tables
end

#translation ⇒ Translation?

Returns the value of attribute translation.

Returns:



914
915
916
 
# File 'sig/types.rbs', line 914

def translation
  @translation
end

#uris ⇒ Array[ExtractedUri]?

Returns the value of attribute uris.

Returns:



906
907
908
 
# File 'sig/types.rbs', line 906

def uris
  @uris
end