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:



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

def initialize: (?content: String, ?mime_type: String, ?metadata: Metadata, ?extraction_method: ExtractionMethod, ?tables: Array[Table], ?counts: DocumentCounts, ?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:



944
945
946
 
# File 'sig/types.rbs', line 944

def annotations
  @annotations
end

#children ⇒ Array[ArchiveEntry]?

Returns the value of attribute children.

Returns:



945
946
947
 
# File 'sig/types.rbs', line 945

def children
  @children
end

#chunks ⇒ Array[Chunk]?

Returns the value of attribute chunks.

Returns:



934
935
936
 
# File 'sig/types.rbs', line 934

def chunks
  @chunks
end

#code_intelligence ⇒ json_value?

Returns the value of attribute code_intelligence.

Returns:

  • (json_value, nil) 


949
950
951
 
# File 'sig/types.rbs', line 949

def code_intelligence
  @code_intelligence
end

#content ⇒ String?

Returns the value of attribute content.

Returns:

  • (String, nil) 


927
928
929
 
# File 'sig/types.rbs', line 927

def content
  @content
end

#counts ⇒ DocumentCounts?

Returns the value of attribute counts.

Returns:



932
933
934
 
# File 'sig/types.rbs', line 932

def counts
  @counts
end

#detected_languages ⇒ Array[String]?

Returns the value of attribute detected_languages.

Returns:

  • (Array[String], nil) 


933
934
935
 
# File 'sig/types.rbs', line 933

def detected_languages
  @detected_languages
end

#djot_content ⇒ DjotContent?

Returns the value of attribute djot_content.

Returns:



938
939
940
 
# File 'sig/types.rbs', line 938

def djot_content
  @djot_content
end

#document ⇒ DocumentStructure?

Returns the value of attribute document.

Returns:



940
941
942
 
# File 'sig/types.rbs', line 940

def document
  @document
end

#elements ⇒ Array[Element]?

Returns the value of attribute elements.

Returns:



937
938
939
 
# File 'sig/types.rbs', line 937

def elements
  @elements
end

#entities ⇒ Array[Entity]?

Returns the value of attribute entities.

Returns:



951
952
953
 
# File 'sig/types.rbs', line 951

def entities
  @entities
end

#extracted_keywords ⇒ Array[Keyword]?

Returns the value of attribute extracted_keywords.

Returns:



941
942
943
 
# File 'sig/types.rbs', line 941

def extracted_keywords
  @extracted_keywords
end

#extraction_confidence ⇒ ExtractionConfidence?

Returns the value of attribute extraction_confidence.

Returns:



953
954
955
 
# File 'sig/types.rbs', line 953

def extraction_confidence
  @extraction_confidence
end

#extraction_method ⇒ ExtractionMethod?

Returns the value of attribute extraction_method.

Returns:



930
931
932
 
# File 'sig/types.rbs', line 930

def extraction_method
  @extraction_method
end

#form_fields ⇒ Array[PdfFormField]?

Returns the value of attribute form_fields.

Returns:



958
959
960
 
# File 'sig/types.rbs', line 958

def form_fields
  @form_fields
end

#formatted_content ⇒ String?

Returns the value of attribute formatted_content.

Returns:

  • (String, nil) 


959
960
961
 
# File 'sig/types.rbs', line 959

def formatted_content
  @formatted_content
end

#formulas ⇒ Array[Formula]?

Returns the value of attribute formulas.

Returns:



957
958
959
 
# File 'sig/types.rbs', line 957

def formulas
  @formulas
end

#images ⇒ Array[ExtractedImage]?

Returns the value of attribute images.

Returns:



935
936
937
 
# File 'sig/types.rbs', line 935

def images
  @images
end

#llm_usage ⇒ Array[LlmUsage]?

Returns the value of attribute llm_usage.

Returns:



950
951
952
 
# File 'sig/types.rbs', line 950

def llm_usage
  @llm_usage
end

#metadata ⇒ Metadata?

Returns the value of attribute metadata.

Returns:



929
930
931
 
# File 'sig/types.rbs', line 929

def metadata
  @metadata
end

#mime_type ⇒ String?

Returns the value of attribute mime_type.

Returns:

  • (String, nil) 


928
929
930
 
# File 'sig/types.rbs', line 928

def mime_type
  @mime_type
end

#ocr_elements ⇒ Array[OcrElement]?

Returns the value of attribute ocr_elements.

Returns:



939
940
941
 
# File 'sig/types.rbs', line 939

def ocr_elements
  @ocr_elements
end

#page_classifications ⇒ Array[PageClassification]?

Returns the value of attribute page_classifications.

Returns:



955
956
957
 
# File 'sig/types.rbs', line 955

def page_classifications
  @page_classifications
end

#pages ⇒ Array[PageContent]?

Returns the value of attribute pages.

Returns:



936
937
938
 
# File 'sig/types.rbs', line 936

def pages
  @pages
end

#processing_warnings ⇒ Array[ProcessingWarning]?

Returns the value of attribute processing_warnings.

Returns:



943
944
945
 
# File 'sig/types.rbs', line 943

def processing_warnings
  @processing_warnings
end

#quality_score ⇒ Float?

Returns the value of attribute quality_score.

Returns:

  • (Float, nil) 


942
943
944
 
# File 'sig/types.rbs', line 942

def quality_score
  @quality_score
end

#redaction_report ⇒ RedactionReport?

Returns the value of attribute redaction_report.

Returns:



956
957
958
 
# File 'sig/types.rbs', line 956

def redaction_report
  @redaction_report
end

#revisions ⇒ Array[DocumentRevision]?

Returns the value of attribute revisions.

Returns:



947
948
949
 
# File 'sig/types.rbs', line 947

def revisions
  @revisions
end

#structured_output ⇒ json_value?

Returns the value of attribute structured_output.

Returns:

  • (json_value, nil) 


948
949
950
 
# File 'sig/types.rbs', line 948

def structured_output
  @structured_output
end

#summary ⇒ DocumentSummary?

Returns the value of attribute summary.

Returns:



952
953
954
 
# File 'sig/types.rbs', line 952

def summary
  @summary
end

#tables ⇒ Array[Table]?

Returns the value of attribute tables.

Returns:



931
932
933
 
# File 'sig/types.rbs', line 931

def tables
  @tables
end

#translation ⇒ Translation?

Returns the value of attribute translation.

Returns:



954
955
956
 
# File 'sig/types.rbs', line 954

def translation
  @translation
end

#uris ⇒ Array[ExtractedUri]?

Returns the value of attribute uris.

Returns:



946
947
948
 
# File 'sig/types.rbs', line 946

def uris
  @uris
end