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/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:fd78adb2897c71ff0eaa3207a3671a4d4fca9fccd64cc044a13e57b0870e29aa To regenerate: alef generate To verify freshness: alef verify 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, Attributes, AudioMetadata, AuthConfig, AuthConfigBasic, AuthConfigBearer, AuthConfigHeader, BBox, BedrockConfig, BibtexMetadata, BoundingBox, BrowserConfig, CacheStats, CaptioningConfig, CellChange, Chunk, ChunkClassificationConfig, ChunkClassificationDefinition, ChunkClassificationEnrichmentConfig, ChunkInfo, ChunkMetadata, ChunkSizing, ChunkSizingCharacters, ChunkSizingTokenizer, ChunkingConfig, ChunkingReason, ChunkingReasonLargeAndManyPages, ChunkingReasonLargeFile, ChunkingReasonManyPages, ChunkingReasonOcrRequired, Citation, CitationMetadata, ClassificationLabel, CodeChunkInfo, CodeDataAttribute, CodeDataNode, CodeMetadata, ConcurrencyConfig, ConfidenceSemantics, ContentConfig, ContentFilterConfig, ContributorRole, ConversionOptions, CoreProperties, CrawlConfig, CredentialProviderConfig, CredentialProviderConfigAzureAd, CredentialProviderConfigBedrockWebIdentity, CredentialProviderConfigVertexAdc, CredentialProviderConfigVertexOauth2, CsvConfig, CsvMetadata, DbfFieldInfo, DbfMetadata, DeepseekOcrBackendOptions, DetectResponse, DetectionResult, DiffHunk, DiffLine, DiffLineAdded, DiffLineContext, DiffLineRemoved, DiffOptions, DjotAttributeGroup, DjotContent, DjotImage, DjotLink, DoctorCheck, DoctorReport, DocumentBoundary, DocumentCounts, DocumentMetadata, DocumentNode, DocumentRelationship, DocumentRevision, DocumentStructure, DocumentSummary, DocxAppProperties, DocxMetadata, Element, ElementMetadata, EmailAttachment, EmailConfig, EmailExtractionResult, EmailMetadata, EmbeddedChanges, EmbeddedDiff, EmbeddedFile, EmbeddingConfig, EmbeddingModelType, EmbeddingModelTypeCustom, EmbeddingModelTypeLlm, EmbeddingModelTypePlugin, EmbeddingModelTypePreset, Entity, EntityCategory, EpubMetadata, ErrorMetadata, ExcelMetadata, ExcelSheet, ExcelWorkbook, ExtractInput, ExtractedDocument, ExtractedImage, ExtractedUri, ExtractionConfidence, ExtractionConfig, ExtractionDiff, ExtractionErrorItem, ExtractionResult, ExtractionSummary, FictionBookMetadata, FileExtractionConfig, Footnote, FootnoteAnchor, FootnoteConfig, FootnoteDefinition, FormatMetadata, FormatMetadataArchive, FormatMetadataAudio, FormatMetadataBibtex, FormatMetadataCitation, FormatMetadataCode, FormatMetadataCsv, FormatMetadataDbf, FormatMetadataDocx, FormatMetadataEmail, FormatMetadataEpub, FormatMetadataExcel, FormatMetadataFictionBook, FormatMetadataHtml, FormatMetadataImage, FormatMetadataJats, FormatMetadataOcr, FormatMetadataPdf, FormatMetadataPptx, FormatMetadataPst, FormatMetadataText, FormatMetadataXml, FormattedBlock, Formula, GeoJsonExtractionConfig, GlmOcrBackendOptions, GridCell, HeaderMetadata, HeadingContext, HeadingLevel, HeuristicsConfig, HierarchicalBlock, HierarchicalBoundingBox, HierarchyConfig, HostMatcher, HostMatcherCidr, HostMatcherExact, HostMatcherSuffix, HtmlMetadata, HtmlOutputConfig, ImageDimensions, ImageDpi, ImageExtractionConfig, ImageMetadata, ImageMetadataType, ImageOutputFormat, ImageOutputFormatHeif, ImageOutputFormatJpeg, ImageOutputFormatNative, ImageOutputFormatPng, ImageOutputFormatSvg, ImageOutputFormatWebp, ImagePreprocessingConfig, ImagePreprocessingMetadata, InlineElement, JatsMetadata, KeyValueAttribute, Keyword, KeywordConfig, LanguageConfidence, LanguageDetectionConfig, LateInteractionConfig, LateInteractionMatch, LateInteractionModelType, LateInteractionModelTypeCustom, LateInteractionModelTypePlugin, LateInteractionModelTypePreset, LateInteractionPreset, LayoutDetection, LayoutDetectionConfig, LayoutRegion, LinkMetadata, LlmBudgetConfig, LlmCacheConfig, LlmConfig, LlmProviderConfig, LlmRateLimitConfig, LlmUsage, MapResult, MarkdownCodeBlock, MarkdownLink, MetaSchema, Metadata, ModelPaths, MultiVectorEmbedding, MultidocInput, MultidocThresholds, NerConfig, NgramRange, NoChunkingReason, NoChunkingReasonChunkingDisabled, NoChunkingReasonFastTextExtraction, NoChunkingReasonFewPages, NoChunkingReasonFormatNotChunkable, NoChunkingReasonSmallFile, NoChunkingReasonTextLayerDetected, NodeContent, NodeContentAdmonition, NodeContentCitation, NodeContentCode, NodeContentComment, NodeContentDefinitionItem, NodeContentDefinitionList, NodeContentFootnote, NodeContentFormula, NodeContentGroup, NodeContentHeading, NodeContentImage, NodeContentList, NodeContentListItem, NodeContentMetadataBlock, NodeContentPageBreak, NodeContentParagraph, NodeContentQuote, NodeContentRawBlock, NodeContentSlide, NodeContentTable, NodeContentTitle, OcrBackendCapabilities, OcrBoundingGeometry, OcrBoundingGeometryQuadrilateral, OcrBoundingGeometryRectangle, OcrConfidence, OcrConfig, OcrElement, OcrElementConfig, OcrExtractionResult, OcrMetadata, OcrPipelineConfig, OcrPipelineStage, OcrPoint, OcrQualityThresholds, OcrRotation, OcrStrategy, OcrStrategyAuto, OcrStrategyScannedPages, OcrTable, OcrTableBoundingBox, OrientationResult, OutputFormat, PaddleOcrConfig, PaddleOcrVlBackendOptions, PageBoundary, PageClassification, PageClassificationConfig, PageConfig, PageContent, PageDimensions, PageHierarchy, PageInfo, PageOcrConfidence, PageRange, PageSignals, PageSpan, PageStructure, PatternMatch, PdfAnnotation, PdfConfig, PdfFormField, PdfMetadata, PiiCategory, PixelDimensions, PostProcessorConfig, PptxAppProperties, PptxExtractionResult, PptxMetadata, PreprocessingOptions, PresentationHyperlink, Preset, PresetSample, PresetSummary, ProcessingWarning, PropertyChange, ProxyConfig, PstMetadata, QrBoundingBox, QrCode, RakeParams, RecognizedTable, RedactionConfig, RedactionFinding, RedactionPattern, RedactionReport, RedactionTerm, Registry, RerankedDocument, RerankerConfig, RerankerModelType, RerankerModelTypeCustom, RerankerModelTypeLlm, RerankerModelTypePlugin, RerankerModelTypePreset, ResolvedPreset, RevisionAnchor, RevisionAnchorPage, RevisionAnchorParagraph, RevisionAnchorSheet, RevisionAnchorSlide, RevisionAnchorTableCell, RevisionDelta, SecurityLimits, ServerConfig, SitemapUrl, SparseEmbedding, SparseEmbeddingConfig, SparseEmbeddingModelType, SparseEmbeddingModelTypeCustom, SparseEmbeddingModelTypePlugin, SparseEmbeddingModelTypePreset, SparseEmbeddingPreset, SsrfPolicy, StructuredData, StructuredDataResult, StructuredExtractionConfig, SummarizationConfig, SupportedFormat, SvgOptions, Table, TableCell, TableCellStyle, TableDiff, TableGrid, TesseractConfig, TextAnnotation, TextExtractionResult, TextMetadata, TokenCounter, TokenReductionConfig, TokenReductionOptions, TranscriptionConfig, Translation, TranslationConfig, TreeSitterConfig, TreeSitterProcessConfig, TrocrBackendOptions, UrlExtractionConfig, UserChunkConfig, VlmFallbackPolicy, VlmFallbackPolicyAlways, VlmFallbackPolicyDisabled, VlmFallbackPolicyOnLowQuality, XlsxAppProperties, XmlExtractionResult, XmlMetadata, YakeParams, YearRange

Constant Summary collapse

VERSION =

The version string for this package.

Returns:

  • (String)
"1.2.6"

Class Method Summary collapse

Class Method Details

.classify_chunks_ownedExtractedDocument

Parameters:

Returns:



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

def self.classify_chunks_owned: (ExtractedDocument result, ChunkClassificationConfig config) -> ExtractedDocument

.clear_document_extractorsvoid

This method returns an undefined value.



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

def self.clear_document_extractors: () -> void

.clear_embedding_backendsvoid

This method returns an undefined value.



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

def self.clear_embedding_backends: () -> void

.clear_ocr_backendsvoid

This method returns an undefined value.



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

def self.clear_ocr_backends: () -> void

.clear_post_processorsvoid

This method returns an undefined value.



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

def self.clear_post_processors: () -> void

.clear_renderersvoid

This method returns an undefined value.



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

def self.clear_renderers: () -> void

.clear_reranker_backendsvoid

This method returns an undefined value.



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

def self.clear_reranker_backends: () -> void

.clear_tokenizer_backendsvoid

This method returns an undefined value.



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

def self.clear_tokenizer_backends: () -> void

.clear_validatorsvoid

This method returns an undefined value.



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

def self.clear_validators: () -> void

.doctorDoctorReport

Parameters:

Returns:



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

def self.doctor: (ExtractionConfig config) -> DoctorReport

.extractExtractionResult

Parameters:

Returns:



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

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

.extract_batchExtractionResult

Parameters:

Returns:



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

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

.find_unmarked_claimsArray[String]

Parameters:

  • markdown (String)

Returns:

  • (Array[String])


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

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

.list_document_extractorsArray[String]

Returns:

  • (Array[String])


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

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

.list_embedding_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_ocr_backend_capabilitiesArray[OcrBackendCapabilities]

Returns:



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

def self.list_ocr_backend_capabilities: () -> Array[OcrBackendCapabilities]

.list_ocr_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_post_processorsArray[String]

Returns:

  • (Array[String])


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

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

.list_renderersArray[String]

Returns:

  • (Array[String])


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

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

.list_reranker_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_supported_formatsArray[SupportedFormat]

Returns:



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

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

.list_tokenizer_backendsArray[String]

Returns:

  • (Array[String])


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

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

.list_validatorsArray[String]

Returns:

  • (Array[String])


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

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

.map_urlMapResult

Parameters:

Returns:



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

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

.max_sim_rankArray[json_value]

Parameters:

  • query (json_value)
  • docs (Array[json_value])

Returns:

  • (Array[json_value])


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

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

.max_sim_scoreFloat

Parameters:

  • query (json_value)
  • doc (json_value)

Returns:

  • (Float)


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

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

.ocr_backend_supports_languageBoolean

Parameters:

  • backend (String)
  • language (String)

Returns:

  • (Boolean)


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

def self.ocr_backend_supports_language: (String backend, String language) -> bool

.register_document_extractorvoid

This method returns an undefined value.

Parameters:



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

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

.register_embedding_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_ocr_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_post_processornil

Parameters:

Returns:

  • (nil)


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

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

.register_renderervoid

This method returns an undefined value.

Parameters:



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

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

.register_reranker_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_tokenizer_backendnil

Parameters:

Returns:

  • (nil)


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

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

.register_validatornil

Parameters:

Returns:

  • (nil)


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

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

.unregister_document_extractorvoid

This method returns an undefined value.

Parameters:

  • name (String)


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

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

.unregister_embedding_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_ocr_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_post_processornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_renderervoid

This method returns an undefined value.

Parameters:

  • name (String)


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

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

.unregister_reranker_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_tokenizer_backendnil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.unregister_validatornil

Parameters:

  • name (String)

Returns:

  • (nil)


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

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

.verify_excerptBoolean

Parameters:

  • excerpt (String)
  • source_text (String)

Returns:

  • (Boolean)


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

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