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:c1dfa38f25cb4a4f3ae999d5f20b3224282c944b5460083a05218399c26fa935 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, _TokenizerBackend, _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, DocumentCounts, 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, JupyterCellRendering, Keyword, KeywordAlgorithm, KeywordConfig, LanguageDetectionConfig, LayoutClass, LayoutDetection, LayoutDetectionConfig, LayoutRegion, LinkMetadata, LinkType, ListType, LlmConfig, LlmUsage, MapResult, 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, SitemapUrl, SsrfPolicy, StructuredData, StructuredDataResult, StructuredDataType, StructuredExtractionConfig, SummarizationConfig, SummaryStrategy, SupportedFormat, SvgOptions, Table, TableCell, TableChunkingMode, TableDiff, TableGrid, TableModel, TableOverlapPreference, 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.15"

Class Method Summary collapse

Class Method Details

.clear_document_extractorsvoid

This method returns an undefined value.



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

def self.clear_document_extractors: () -> void

.clear_embedding_backendsvoid

This method returns an undefined value.



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

def self.clear_embedding_backends: () -> void

.clear_ocr_backendsvoid

This method returns an undefined value.



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

def self.clear_ocr_backends: () -> void

.clear_post_processorsvoid

This method returns an undefined value.



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

def self.clear_post_processors: () -> void

.clear_renderersvoid

This method returns an undefined value.



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

def self.clear_renderers: () -> void

.clear_reranker_backendsvoid

This method returns an undefined value.



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

def self.clear_reranker_backends: () -> void

.clear_tokenizer_backendsvoid

This method returns an undefined value.



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

def self.clear_tokenizer_backends: () -> void

.clear_validatorsvoid

This method returns an undefined value.



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

def self.clear_validators: () -> void

.extractExtractionResult

Parameters:

Returns:



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

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

.extract_batchExtractionResult

Parameters:

Returns:



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

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

.find_unmarked_claimsArray[String]

Parameters:

  • markdown (String)

Returns:

  • (Array[String])


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

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

.list_document_extractorsArray[String]

Returns:

  • (Array[String])


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

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

.list_embedding_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_ocr_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_post_processorsArray[String]

Returns:

  • (Array[String])


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

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

.list_renderersArray[String]

Returns:

  • (Array[String])


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

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

.list_reranker_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_supported_formatsArray[SupportedFormat]

Returns:



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

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

.list_tokenizer_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_validatorsArray[String]

Returns:

  • (Array[String])


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

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

.map_urlMapResult

Parameters:

Returns:



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

def self.map_url: (String uri, UrlExtractionConfig config) -> MapResult

.register_document_extractorvoid

This method returns an undefined value.

Parameters:

  • extractor (DocumentExtractor)


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

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

.register_embedding_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_ocr_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_post_processornil

Parameters:

Returns:

  • (nil)


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

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

.register_renderervoid

This method returns an undefined value.

Parameters:

  • renderer (Renderer)


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

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

.register_reranker_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_tokenizer_backendnil

Parameters:

Returns:

  • (nil)


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

def self.register_tokenizer_backend: (_TokenizerBackend backend, String name) -> nil

.register_validatornil

Parameters:

Returns:

  • (nil)


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

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

.unregister_document_extractorvoid

This method returns an undefined value.

Parameters:

  • name (String)


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

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

.unregister_embedding_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_ocr_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_post_processornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_renderervoid

This method returns an undefined value.

Parameters:

  • name (String)


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

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

.unregister_reranker_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_tokenizer_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_validatornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.verify_excerptBoolean

Parameters:

  • excerpt (String)
  • source_text (String)

Returns:

  • (Boolean)


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

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