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:



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

def initialize: (?content: String, ?mime_type: String, ?metadata: Metadata, ?extraction_method: enum_ExtractionMethod, ?tables: Array[Table], ?counts: DocumentCounts, ?detected_languages: Array[String], ?detected_language_confidences: Array[LanguageConfidence], ?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: String, ?code_intelligence: String, ?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]) -> void

Instance Attribute Details

#annotations ⇒ Array[PdfAnnotation]? (readonly)

Returns the value of attribute annotations.

Returns:



866
867
868
 
# File 'sig/types.rbs', line 866

def annotations
  @annotations
end

#children ⇒ Array[ArchiveEntry]? (readonly)

Returns the value of attribute children.

Returns:



867
868
869
 
# File 'sig/types.rbs', line 867

def children
  @children
end

#chunks ⇒ Array[Chunk]? (readonly)

Returns the value of attribute chunks.

Returns:



856
857
858
 
# File 'sig/types.rbs', line 856

def chunks
  @chunks
end

#code_intelligence ⇒ String? (readonly)

Returns the value of attribute code_intelligence.

Returns:

  • (String, nil) 


871
872
873
 
# File 'sig/types.rbs', line 871

def code_intelligence
  @code_intelligence
end

#content ⇒ String (readonly)

Returns the value of attribute content.

Returns:

  • (String) 


848
849
850
 
# File 'sig/types.rbs', line 848

def content
  @content
end

#counts ⇒ DocumentCounts (readonly)

Returns the value of attribute counts.

Returns:



853
854
855
 
# File 'sig/types.rbs', line 853

def counts
  @counts
end

#detected_language_confidences ⇒ Array[LanguageConfidence]? (readonly)

Returns the value of attribute detected_language_confidences.

Returns:



855
856
857
 
# File 'sig/types.rbs', line 855

def detected_language_confidences
  @detected_language_confidences
end

#detected_languages ⇒ Array[String]? (readonly)

Returns the value of attribute detected_languages.

Returns:

  • (Array[String], nil) 


854
855
856
 
# File 'sig/types.rbs', line 854

def detected_languages
  @detected_languages
end

#djot_content ⇒ DjotContent? (readonly)

Returns the value of attribute djot_content.

Returns:



860
861
862
 
# File 'sig/types.rbs', line 860

def djot_content
  @djot_content
end

#document ⇒ DocumentStructure? (readonly)

Returns the value of attribute document.

Returns:



862
863
864
 
# File 'sig/types.rbs', line 862

def document
  @document
end

#elements ⇒ Array[Element]? (readonly)

Returns the value of attribute elements.

Returns:



859
860
861
 
# File 'sig/types.rbs', line 859

def elements
  @elements
end

#entities ⇒ Array[Entity]? (readonly)

Returns the value of attribute entities.

Returns:



873
874
875
 
# File 'sig/types.rbs', line 873

def entities
  @entities
end

#extracted_keywords ⇒ Array[Keyword]? (readonly)

Returns the value of attribute extracted_keywords.

Returns:



863
864
865
 
# File 'sig/types.rbs', line 863

def extracted_keywords
  @extracted_keywords
end

#extraction_confidence ⇒ ExtractionConfidence? (readonly)

Returns the value of attribute extraction_confidence.

Returns:



875
876
877
 
# File 'sig/types.rbs', line 875

def extraction_confidence
  @extraction_confidence
end

#extraction_method ⇒ enum_ExtractionMethod? (readonly)

Returns the value of attribute extraction_method.

Returns:

  • (enum_ExtractionMethod, nil) 


851
852
853
 
# File 'sig/types.rbs', line 851

def extraction_method
  @extraction_method
end

#form_fields ⇒ Array[PdfFormField] (readonly)

Returns the value of attribute form_fields.

Returns:



880
881
882
 
# File 'sig/types.rbs', line 880

def form_fields
  @form_fields
end

#formulas ⇒ Array[Formula] (readonly)

Returns the value of attribute formulas.

Returns:



879
880
881
 
# File 'sig/types.rbs', line 879

def formulas
  @formulas
end

#images ⇒ Array[ExtractedImage]? (readonly)

Returns the value of attribute images.

Returns:



857
858
859
 
# File 'sig/types.rbs', line 857

def images
  @images
end

#llm_usage ⇒ Array[LlmUsage]? (readonly)

Returns the value of attribute llm_usage.

Returns:



872
873
874
 
# File 'sig/types.rbs', line 872

def llm_usage
  @llm_usage
end

#metadata ⇒ Metadata (readonly)

Returns the value of attribute metadata.

Returns:



850
851
852
 
# File 'sig/types.rbs', line 850

def metadata
  @metadata
end

#mime_type ⇒ String (readonly)

Returns the value of attribute mime_type.

Returns:

  • (String) 


849
850
851
 
# File 'sig/types.rbs', line 849

def mime_type
  @mime_type
end

#ocr_elements ⇒ Array[OcrElement]? (readonly)

Returns the value of attribute ocr_elements.

Returns:



861
862
863
 
# File 'sig/types.rbs', line 861

def ocr_elements
  @ocr_elements
end

#page_classifications ⇒ Array[PageClassification]? (readonly)

Returns the value of attribute page_classifications.

Returns:



877
878
879
 
# File 'sig/types.rbs', line 877

def page_classifications
  @page_classifications
end

#pages ⇒ Array[PageContent]? (readonly)

Returns the value of attribute pages.

Returns:



858
859
860
 
# File 'sig/types.rbs', line 858

def pages
  @pages
end

#processing_warnings ⇒ Array[ProcessingWarning] (readonly)

Returns the value of attribute processing_warnings.

Returns:



865
866
867
 
# File 'sig/types.rbs', line 865

def processing_warnings
  @processing_warnings
end

#quality_score ⇒ Float? (readonly)

Returns the value of attribute quality_score.

Returns:

  • (Float, nil) 


864
865
866
 
# File 'sig/types.rbs', line 864

def quality_score
  @quality_score
end

#redaction_report ⇒ RedactionReport? (readonly)

Returns the value of attribute redaction_report.

Returns:



878
879
880
 
# File 'sig/types.rbs', line 878

def redaction_report
  @redaction_report
end

#revisions ⇒ Array[DocumentRevision]? (readonly)

Returns the value of attribute revisions.

Returns:



869
870
871
 
# File 'sig/types.rbs', line 869

def revisions
  @revisions
end

#structured_output ⇒ String? (readonly)

Returns the value of attribute structured_output.

Returns:

  • (String, nil) 


870
871
872
 
# File 'sig/types.rbs', line 870

def structured_output
  @structured_output
end

#summary ⇒ DocumentSummary? (readonly)

Returns the value of attribute summary.

Returns:



874
875
876
 
# File 'sig/types.rbs', line 874

def summary
  @summary
end

#tables ⇒ Array[Table] (readonly)

Returns the value of attribute tables.

Returns:



852
853
854
 
# File 'sig/types.rbs', line 852

def tables
  @tables
end

#translation ⇒ Translation? (readonly)

Returns the value of attribute translation.

Returns:



876
877
878
 
# File 'sig/types.rbs', line 876

def translation
  @translation
end

#uris ⇒ Array[ExtractedUri]? (readonly)

Returns the value of attribute uris.

Returns:



868
869
870
 
# File 'sig/types.rbs', line 868

def uris
  @uris
end