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/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:597bd1ea631d4ac6d358d121dc5791450b5d9aaaabe53fda1e43bef2af72e4ac 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, CodeChunkInfo, CodeContentMode, CodeMetadata, 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, EmbeddingsEmbeddingBackend, 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, LateInteractionConfig, LateInteractionMatch, LateInteractionModelType, LateInteractionModelTypeCustom, LateInteractionModelTypePlugin, LateInteractionModelTypePreset, LateInteractionPreset, LayoutClass, LayoutDetection, LayoutDetectionConfig, LayoutRegion, LinkMetadata, LinkType, ListType, LlmConfig, LlmUsage, MapResult, MergeMode, MetaSchema, Metadata, ModelPaths, MultiVectorEmbedding, 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, OcrStrategy, OcrStrategyAuto, OcrStrategyScannedPages, 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, PropertyChange, ProxyConfig, PstMetadata, QrBoundingBox, QrCode, RakeParams, RecognizedTable, RedactionConfig, RedactionFinding, RedactionPattern, RedactionReport, RedactionStrategy, RedactionTerm, ReductionLevel, RegionKind, Registry, RelationshipKind, RerankedDocument, RerankerConfig, RerankerHead, RerankerModelType, RerankerModelTypeCustom, RerankerModelTypeLlm, RerankerModelTypePlugin, RerankerModelTypePreset, ResolvedPreset, ResultFormat, RevisionAnchor, RevisionAnchorPage, RevisionAnchorParagraph, RevisionAnchorSheet, RevisionAnchorSlide, RevisionAnchorTableCell, RevisionDelta, RevisionKind, SchemaCompliance, SecurityLimits, ServerConfig, SitemapUrl, SparseEmbedding, SparseEmbeddingConfig, SparseEmbeddingModelType, SparseEmbeddingModelTypeCustom, SparseEmbeddingModelTypePlugin, SparseEmbeddingModelTypePreset, SparseEmbeddingPreset, 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.20"

Class Method Summary collapse

Class Method Details

.clear_document_extractorsvoid

This method returns an undefined value.



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

def self.clear_document_extractors: () -> void

.clear_embedding_backendsvoid

This method returns an undefined value.



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

def self.clear_embedding_backends: () -> void

.clear_ocr_backendsvoid

This method returns an undefined value.



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

def self.clear_ocr_backends: () -> void

.clear_post_processorsvoid

This method returns an undefined value.



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

def self.clear_post_processors: () -> void

.clear_renderersvoid

This method returns an undefined value.



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

def self.clear_renderers: () -> void

.clear_reranker_backendsvoid

This method returns an undefined value.



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

def self.clear_reranker_backends: () -> void

.clear_tokenizer_backendsvoid

This method returns an undefined value.



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

def self.clear_tokenizer_backends: () -> void

.clear_validatorsvoid

This method returns an undefined value.



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

def self.clear_validators: () -> void

.embed_multi_vector_asyncArray[MultiVectorEmbedding]

Parameters:

Returns:



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

def self.embed_multi_vector_async: (Array[String] texts, LateInteractionConfig config, bool is_query) -> Array[MultiVectorEmbedding]

.embed_sparse_asyncArray[SparseEmbedding]

Parameters:

Returns:



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

def self.embed_sparse_async: (Array[String] texts, SparseEmbeddingConfig config) -> Array[SparseEmbedding]

.extractExtractionResult

Parameters:

Returns:



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

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

.extract_batchExtractionResult

Parameters:

Returns:



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

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

.find_unmarked_claimsArray[String]

Parameters:

  • markdown (String)

Returns:

  • (Array[String])


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

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

.list_document_extractorsArray[String]

Returns:

  • (Array[String])


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

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

.list_embedding_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_ocr_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_post_processorsArray[String]

Returns:

  • (Array[String])


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

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

.list_renderersArray[String]

Returns:

  • (Array[String])


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

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

.list_reranker_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_supported_formatsArray[SupportedFormat]

Returns:



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

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

.list_tokenizer_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_validatorsArray[String]

Returns:

  • (Array[String])


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

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

.map_urlMapResult

Parameters:

Returns:



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

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

.max_sim_rankArray[LateInteractionMatch]

Parameters:

Returns:



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

def self.max_sim_rank: (MultiVectorEmbedding query, Array[MultiVectorEmbedding] docs) -> Array[LateInteractionMatch]

.max_sim_scoreFloat

Parameters:

Returns:

  • (Float)


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

def self.max_sim_score: (MultiVectorEmbedding query, MultiVectorEmbedding doc) -> Float

.register_document_extractorvoid

This method returns an undefined value.

Parameters:

  • extractor (DocumentExtractor)


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

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

.register_embedding_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_ocr_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_post_processornil

Parameters:

Returns:

  • (nil)


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

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

.register_renderervoid

This method returns an undefined value.

Parameters:

  • renderer (Renderer)


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

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

.register_reranker_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_tokenizer_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_validatornil

Parameters:

Returns:

  • (nil)


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

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

.unregister_document_extractorvoid

This method returns an undefined value.

Parameters:

  • name (String)


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

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

.unregister_embedding_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_ocr_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_post_processornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_renderervoid

This method returns an undefined value.

Parameters:

  • name (String)


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

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

.unregister_reranker_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_tokenizer_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_validatornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.verify_excerptBoolean

Parameters:

  • excerpt (String)
  • source_text (String)

Returns:

  • (Boolean)


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

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