Module: Xberg

Defined in:
lib/xberg.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/native.rb,
lib/xberg/version.rb,
sig/types.rbs

Overview

This file is auto-generated by alef — DO NOT EDIT. alef:hash:b0f3e348cc193e0cfa8fdcc36fd3ebb5e08e4360d10b525744b736383abddeae To regenerate: alef generate To verify freshness: alef verify --exit-code frozen_string_literal: true

Defined Under Namespace

Modules: _DocumentExtractor, _EmbeddingBackend, _OcrBackend, _PostProcessor, _Renderer, _RerankerBackend, _Validator Classes: AccelerationConfig, AnnotationKind, AnnotationKindBold, AnnotationKindCode, AnnotationKindColor, AnnotationKindCustom, AnnotationKindFontSize, AnnotationKindHighlight, AnnotationKindItalic, AnnotationKindLink, AnnotationKindStrikethrough, AnnotationKindSubscript, AnnotationKindSuperscript, AnnotationKindUnderline, ArchiveEntry, ArchiveMetadata, AssetCategory, AudioMetadata, AuthConfig, AuthConfigBasic, AuthConfigBearer, AuthConfigHeader, BBox, BibtexMetadata, BlockType, BoundaryReason, BoundingBox, BrowserBackend, BrowserConfig, BrowserMode, BrowserWait, CacheStats, CallMode, CaptioningConfig, CellChange, Chunk, ChunkInfo, ChunkMetadata, ChunkSizing, ChunkSizingCharacters, ChunkSizingTokenizer, ChunkType, ChunkerType, ChunkingConfig, ChunkingReason, ChunkingReasonLargeAndManyPages, ChunkingReasonLargeFile, ChunkingReasonManyPages, ChunkingReasonOcrRequired, Citation, CitationMetadata, ClassificationLabel, CodeContentMode, ContentConfig, ContentFilterConfig, ContentLayer, ContributorRole, CoreProperties, CrawlConfig, CsvMetadata, DbfFieldInfo, DbfMetadata, DetectResponse, DetectionResult, DiffHunk, DiffLine, DiffLineAdded, DiffLineContext, DiffLineRemoved, DiffOptions, DjotContent, DjotImage, DjotLink, DocumentBoundary, DocumentMetadata, DocumentNode, DocumentRelationship, DocumentRevision, DocumentStructure, DocumentSummary, DocxAppProperties, DocxMetadata, Element, ElementMetadata, ElementType, EmailAttachment, EmailConfig, EmailExtractionResult, EmailMetadata, EmbeddedChanges, EmbeddedDiff, EmbeddedFile, EmbeddingConfig, EmbeddingModelType, EmbeddingModelTypeCustom, EmbeddingModelTypeLlm, EmbeddingModelTypePlugin, EmbeddingModelTypePreset, Entity, EntityCategory, EpubMetadata, ErrorMetadata, ExcelMetadata, ExcelSheet, ExcelWorkbook, ExecutionProviderType, ExtractInput, ExtractInputKind, ExtractedDocument, ExtractedImage, ExtractedUri, ExtractionConfidence, ExtractionConfig, ExtractionDiff, ExtractionErrorItem, ExtractionMethod, ExtractionResult, ExtractionSummary, FictionBookMetadata, FileExtractionConfig, Footnote, FootnoteAnchor, FootnoteConfig, FootnoteDefinition, FormFieldType, FormatMetadata, FormatMetadataArchive, FormatMetadataAudio, FormatMetadataBibtex, FormatMetadataCitation, FormatMetadataCode, FormatMetadataCsv, FormatMetadataDbf, FormatMetadataDocx, FormatMetadataEmail, FormatMetadataEpub, FormatMetadataExcel, FormatMetadataFictionBook, FormatMetadataHtml, FormatMetadataImage, FormatMetadataJats, FormatMetadataOcr, FormatMetadataPdf, FormatMetadataPptx, FormatMetadataPst, FormatMetadataText, FormatMetadataXml, FormattedBlock, Formula, GridCell, HeaderMetadata, HeadingContext, HeadingLevel, HeuristicsConfig, HierarchicalBlock, HierarchyConfig, HtmlMetadata, HtmlOutputConfig, HtmlTheme, ImageExtractionConfig, ImageKind, ImageMetadata, ImageMetadataType, ImageOutputFormat, ImageOutputFormatHeif, ImageOutputFormatJpeg, ImageOutputFormatNative, ImageOutputFormatPng, ImageOutputFormatSvg, ImageOutputFormatWebp, ImagePreprocessingConfig, ImagePreprocessingMetadata, ImageType, InlineElement, InlineType, JatsMetadata, Keyword, KeywordAlgorithm, KeywordConfig, LanguageDetectionConfig, LayoutClass, LayoutDetection, LayoutDetectionConfig, LayoutRegion, LinkMetadata, LinkType, ListType, LlmConfig, LlmUsage, MergeMode, MetaSchema, Metadata, ModelPaths, MultidocInput, MultidocThresholds, NerBackendKind, NerConfig, NoChunkingReason, NoChunkingReasonChunkingDisabled, NoChunkingReasonFastTextExtraction, NoChunkingReasonFewPages, NoChunkingReasonFormatNotChunkable, NoChunkingReasonSmallFile, NoChunkingReasonTextLayerDetected, NodeContent, NodeContentAdmonition, NodeContentCitation, NodeContentCode, NodeContentDefinitionItem, NodeContentDefinitionList, NodeContentFootnote, NodeContentFormula, NodeContentGroup, NodeContentHeading, NodeContentImage, NodeContentList, NodeContentListItem, NodeContentMetadataBlock, NodeContentPageBreak, NodeContentParagraph, NodeContentQuote, NodeContentRawBlock, NodeContentSlide, NodeContentTable, NodeContentTitle, OcrBackendType, OcrBoundingGeometry, OcrBoundingGeometryQuadrilateral, OcrBoundingGeometryRectangle, OcrConfidence, OcrConfig, OcrElement, OcrElementConfig, OcrElementLevel, OcrExtractionResult, OcrMetadata, OcrPipelineConfig, OcrPipelineStage, OcrQualityThresholds, OcrRotation, OcrTable, OcrTableBoundingBox, OrientationResult, OutputFormat, PSMMode, PaddleLanguage, PaddleOcrConfig, PageBoundary, PageClassification, PageClassificationConfig, PageConfig, PageContent, PageHierarchy, PageInfo, PageRange, PageSignals, PageStructure, PageUnitType, PatternMatch, PdfAnnotation, PdfAnnotationType, PdfConfig, PdfFormField, PdfMetadata, PiiCategory, PostProcessorConfig, PptxAppProperties, PptxExtractionResult, PptxMetadata, Preset, PresetCategory, PresetSample, PresetSummary, ProcessingStage, ProcessingWarning, ProxyConfig, PstMetadata, QrBoundingBox, QrCode, RakeParams, RecognizedTable, RedactionConfig, RedactionFinding, RedactionPattern, RedactionReport, RedactionStrategy, RedactionTerm, ReductionLevel, RegionKind, Registry, RelationshipKind, RerankedDocument, RerankerConfig, RerankerModelType, RerankerModelTypeCustom, RerankerModelTypeLlm, RerankerModelTypePlugin, RerankerModelTypePreset, ResolvedPreset, ResultFormat, RevisionAnchor, RevisionAnchorPage, RevisionAnchorParagraph, RevisionAnchorSheet, RevisionAnchorSlide, RevisionAnchorTableCell, RevisionDelta, RevisionKind, SchemaCompliance, SecurityLimits, ServerConfig, SsrfPolicy, StructuredData, StructuredDataResult, StructuredDataType, StructuredExtractionConfig, SummarizationConfig, SummaryStrategy, SupportedFormat, SvgOptions, Table, TableCell, TableChunkingMode, TableDiff, TableGrid, TableModel, TesseractConfig, TextAnnotation, TextDirection, TextExtractionResult, TextMetadata, TokenCounter, TokenReductionConfig, TokenReductionOptions, TranscriptionConfig, Translation, TranslationConfig, TreeSitterConfig, TreeSitterProcessConfig, UriKind, UrlExtractionConfig, UrlExtractionMode, UserChunkConfig, VlmFallbackPolicy, VlmFallbackPolicyAlways, VlmFallbackPolicyDisabled, VlmFallbackPolicyOnLowQuality, WhisperModel, XlsxAppProperties, XmlExtractionResult, XmlMetadata, YakeParams, YearRange

Constant Summary collapse

VERSION =

The version string for this package.

Returns:

  • (String)
"1.0.0.pre.rc.1"

Class Method Summary collapse

Class Method Details

.clear_document_extractorsvoid

This method returns an undefined value.



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

def self.clear_document_extractors: () -> void

.clear_embedding_backendsvoid

This method returns an undefined value.



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

def self.clear_embedding_backends: () -> void

.clear_ocr_backendsvoid

This method returns an undefined value.



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

def self.clear_ocr_backends: () -> void

.clear_post_processorsvoid

This method returns an undefined value.



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

def self.clear_post_processors: () -> void

.clear_renderersvoid

This method returns an undefined value.



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

def self.clear_renderers: () -> void

.clear_reranker_backendsvoid

This method returns an undefined value.



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

def self.clear_reranker_backends: () -> void

.clear_validatorsvoid

This method returns an undefined value.



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

def self.clear_validators: () -> void

.extractExtractionResult

Parameters:

Returns:



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

def self.extract: (ExtractInput input, ExtractionConfig config) -> ExtractionResult

.extract_batchExtractionResult

Parameters:

Returns:



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

def self.extract_batch: (Array[ExtractInput] inputs, ExtractionConfig config) -> ExtractionResult

.find_unmarked_claimsArray[String]

Parameters:

  • markdown (String)

Returns:

  • (Array[String])


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

def self.find_unmarked_claims: (String markdown) -> Array[String]

.list_document_extractorsArray[String]

Returns:

  • (Array[String])


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

def self.list_document_extractors: () -> Array[String]

.list_embedding_backendsArray[String]

Returns:

  • (Array[String])


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

def self.list_embedding_backends: () -> Array[String]

.list_ocr_backendsArray[String]

Returns:

  • (Array[String])


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

def self.list_ocr_backends: () -> Array[String]

.list_post_processorsArray[String]

Returns:

  • (Array[String])


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

def self.list_post_processors: () -> Array[String]

.list_renderersArray[String]

Returns:

  • (Array[String])


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

def self.list_renderers: () -> Array[String]

.list_reranker_backendsArray[String]

Returns:

  • (Array[String])


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

def self.list_reranker_backends: () -> Array[String]

.list_supported_formatsArray[SupportedFormat]

Returns:



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

def self.list_supported_formats: () -> Array[SupportedFormat]

.list_validatorsArray[String]

Returns:

  • (Array[String])


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

def self.list_validators: () -> Array[String]

.register_document_extractorvoid

This method returns an undefined value.

Parameters:



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

def self.register_document_extractor: (DocumentExtractor extractor) -> void

.register_embedding_backendnil

Parameters:

Returns:

  • (nil)


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

def self.register_embedding_backend: (_EmbeddingBackend backend, String name) -> nil

.register_ocr_backendnil

Parameters:

Returns:

  • (nil)


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

def self.register_ocr_backend: (_OcrBackend backend, String name) -> nil

.register_post_processornil

Parameters:

Returns:

  • (nil)


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

def self.register_post_processor: (_PostProcessor backend, String name) -> nil

.register_renderervoid

This method returns an undefined value.

Parameters:

  • renderer (Renderer)
  • backend (_Renderer)
  • name (String)


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

def self.register_renderer: (Renderer renderer) -> void

.register_reranker_backendnil

Parameters:

Returns:

  • (nil)


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

def self.register_reranker_backend: (_RerankerBackend backend, String name) -> nil

.register_validatornil

Parameters:

Returns:

  • (nil)


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

def self.register_validator: (_Validator backend, String name) -> nil

.unregister_document_extractorvoid

This method returns an undefined value.

Parameters:

  • name (String)


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

def self.unregister_document_extractor: (String name) -> void

.unregister_embedding_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

def self.unregister_embedding_backend: (String name) -> nil

.unregister_ocr_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

def self.unregister_ocr_backend: (String name) -> nil

.unregister_post_processornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

def self.unregister_post_processor: (String name) -> nil

.unregister_renderervoid

This method returns an undefined value.

Parameters:

  • name (String)


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

def self.unregister_renderer: (String name) -> void

.unregister_reranker_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

def self.unregister_reranker_backend: (String name) -> nil

.unregister_validatornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

def self.unregister_validator: (String name) -> nil

.verify_excerptBoolean

Parameters:

  • excerpt (String)
  • source_text (String)

Returns:

  • (Boolean)


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

def self.verify_excerpt: (String excerpt, String source_text) -> bool