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:0e1c5c15465f2c9da4f2fcf714b1b89f3893986d5fd4cea462737f5f31d0c1e3
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, ChunkClassificationConfig, ChunkClassificationDefinition, ChunkClassificationEnrichmentConfig, ChunkInfo, ChunkMetadata, ChunkSizing, ChunkSizingCharacters, ChunkSizingTokenizer, ChunkType, ChunkerType, ChunkingConfig, ChunkingReason, ChunkingReasonLargeAndManyPages, ChunkingReasonLargeFile, ChunkingReasonManyPages, ChunkingReasonOcrRequired, Citation, CitationMetadata, ClassificationLabel, CodeBlockStyle, CodeChunkInfo, CodeContentMode, CodeDataAttribute, CodeDataNode, CodeDataNodeKind, CodeMetadata, ContentConfig, ContentFilterConfig, ContentLayer, ContributorRole, ConversionOptions, 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, HeadingStyle, HeuristicsConfig, HierarchicalBlock, HierarchyConfig, HighlightStyle, 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, LayoutStrategy, LinkMetadata, LinkStyle, LinkType, ListIndentType, ListType, LlmConfig, LlmUsage, MapResult, MergeMode, MetaSchema, Metadata, ModelPaths, MultiVectorEmbedding, MultidocInput, MultidocThresholds, NerBackendKind, NerConfig, NewlineStyle, 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, PageSpan, PageStructure, PageUnitType, PatternMatch, PdfAnnotation, PdfAnnotationType, PdfConfig, PdfFormField, PdfMetadata, PiiCategory, PostProcessorConfig, PptxAppProperties, PptxExtractionResult, PptxMetadata, PreprocessingOptions, PreprocessingPreset, 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, UrlEscapeStyle, UrlExtractionConfig, UrlExtractionMode, UserChunkConfig, VlmFallbackPolicy, VlmFallbackPolicyAlways, VlmFallbackPolicyDisabled, VlmFallbackPolicyOnLowQuality, WhisperModel, WhitespaceMode, XlsxAppProperties, XmlExtractionResult, XmlMetadata, YakeParams, YearRange
Constant Summary
collapse
- VERSION =
The version string for this package.
"1.0.5"
Class Method Summary
collapse
Class Method Details
.classify_chunks ⇒ void
This method returns an undefined value.
2799
|
# File 'sig/types.rbs', line 2799
def self.classify_chunks: (ExtractedDocument result, ChunkClassificationConfig config) -> void
|
This method returns an undefined value.
2769
|
# File 'sig/types.rbs', line 2769
def self.clear_document_extractors: () -> void
|
.clear_embedding_backends ⇒ void
This method returns an undefined value.
2759
|
# File 'sig/types.rbs', line 2759
def self.clear_embedding_backends: () -> void
|
.clear_ocr_backends ⇒ void
This method returns an undefined value.
2773
|
# File 'sig/types.rbs', line 2773
def self.clear_ocr_backends: () -> void
|
.clear_post_processors ⇒ void
This method returns an undefined value.
2777
|
# File 'sig/types.rbs', line 2777
def self.clear_post_processors: () -> void
|
.clear_renderers ⇒ void
This method returns an undefined value.
2785
|
# File 'sig/types.rbs', line 2785
def self.clear_renderers: () -> void
|
.clear_reranker_backends ⇒ void
This method returns an undefined value.
2787
|
# File 'sig/types.rbs', line 2787
def self.clear_reranker_backends: () -> void
|
.clear_tokenizer_backends ⇒ void
This method returns an undefined value.
2791
|
# File 'sig/types.rbs', line 2791
def self.clear_tokenizer_backends: () -> void
|
.clear_validators ⇒ void
This method returns an undefined value.
2797
|
# File 'sig/types.rbs', line 2797
def self.clear_validators: () -> void
|
.embed_multi_vector_async ⇒ Array[json_value]
2811
|
# File 'sig/types.rbs', line 2811
def self.embed_multi_vector_async: (Array[String] texts, LateInteractionConfig config, bool is_query) -> Array[json_value]
|
.embed_sparse_async ⇒ Array[json_value]
2805
|
# File 'sig/types.rbs', line 2805
def self.embed_sparse_async: (Array[String] texts, SparseEmbeddingConfig config) -> Array[json_value]
|
2751
|
# File 'sig/types.rbs', line 2751
def self.extract: (ExtractInput input, ExtractionConfig config) -> ExtractionResult
|
2753
|
# File 'sig/types.rbs', line 2753
def self.extract_batch: (Array[ExtractInput] inputs, ExtractionConfig config) -> ExtractionResult
|
.find_unmarked_claims ⇒ Array[String]
2801
|
# File 'sig/types.rbs', line 2801
def self.find_unmarked_claims: (String markdown) -> Array[String]
|
2767
|
# File 'sig/types.rbs', line 2767
def self.list_document_extractors: () -> Array[String]
|
.list_embedding_backends ⇒ Array[String]
2761
|
# File 'sig/types.rbs', line 2761
def self.list_embedding_backends: () -> Array[String]
|
.list_ocr_backends ⇒ Array[String]
2771
|
# File 'sig/types.rbs', line 2771
def self.list_ocr_backends: () -> Array[String]
|
.list_post_processors ⇒ Array[String]
2775
|
# File 'sig/types.rbs', line 2775
def self.list_post_processors: () -> Array[String]
|
.list_renderers ⇒ Array[String]
2783
|
# File 'sig/types.rbs', line 2783
def self.list_renderers: () -> Array[String]
|
.list_reranker_backends ⇒ Array[String]
2789
|
# File 'sig/types.rbs', line 2789
def self.list_reranker_backends: () -> Array[String]
|
2757
|
# File 'sig/types.rbs', line 2757
def self.list_supported_formats: () -> Array[SupportedFormat]
|
.list_tokenizer_backends ⇒ Array[String]
2793
|
# File 'sig/types.rbs', line 2793
def self.list_tokenizer_backends: () -> Array[String]
|
.list_validators ⇒ Array[String]
2795
|
# File 'sig/types.rbs', line 2795
def self.list_validators: () -> Array[String]
|
2755
|
# File 'sig/types.rbs', line 2755
def self.map_url: (String uri, UrlExtractionConfig config) -> MapResult
|
.max_sim_rank ⇒ Array[json_value]
2809
|
# File 'sig/types.rbs', line 2809
def self.max_sim_rank: (json_value query, Array[json_value] docs) -> Array[json_value]
|
.max_sim_score ⇒ Float
2807
|
# File 'sig/types.rbs', line 2807
def self.max_sim_score: (json_value query, json_value doc) -> Float
|
This method returns an undefined value.
2763
|
# File 'sig/types.rbs', line 2763
def self.register_document_extractor: (_DocumentExtractor extractor) -> void
|
.register_embedding_backend ⇒ nil
2881
|
# File 'sig/types.rbs', line 2881
def self.register_embedding_backend: (_EmbeddingBackend backend, String name) -> nil
|
.register_ocr_backend ⇒ nil
2869
|
# File 'sig/types.rbs', line 2869
def self.register_ocr_backend: (_OcrBackend backend, String name) -> nil
|
.register_post_processor ⇒ nil
2873
|
# File 'sig/types.rbs', line 2873
def self.register_post_processor: (_PostProcessor backend, String name) -> nil
|
.register_renderer ⇒ void
This method returns an undefined value.
2779
|
# File 'sig/types.rbs', line 2779
def self.register_renderer: (_Renderer renderer) -> void
|
.register_reranker_backend ⇒ nil
2885
|
# File 'sig/types.rbs', line 2885
def self.register_reranker_backend: (_RerankerBackend backend, String name) -> nil
|
.register_tokenizer_backend ⇒ nil
2889
|
# File 'sig/types.rbs', line 2889
def self.register_tokenizer_backend: (_TokenizerBackend backend, String name) -> nil
|
.register_validator ⇒ nil
2877
|
# File 'sig/types.rbs', line 2877
def self.register_validator: (_Validator backend, String name) -> nil
|
This method returns an undefined value.
2765
|
# File 'sig/types.rbs', line 2765
def self.unregister_document_extractor: (String name) -> void
|
.unregister_embedding_backend ⇒ nil
2883
|
# File 'sig/types.rbs', line 2883
def self.unregister_embedding_backend: (String name) -> nil
|
.unregister_ocr_backend ⇒ nil
2871
|
# File 'sig/types.rbs', line 2871
def self.unregister_ocr_backend: (String name) -> nil
|
.unregister_post_processor ⇒ nil
2875
|
# File 'sig/types.rbs', line 2875
def self.unregister_post_processor: (String name) -> nil
|
.unregister_renderer ⇒ void
This method returns an undefined value.
2781
|
# File 'sig/types.rbs', line 2781
def self.unregister_renderer: (String name) -> void
|
.unregister_reranker_backend ⇒ nil
2887
|
# File 'sig/types.rbs', line 2887
def self.unregister_reranker_backend: (String name) -> nil
|
.unregister_tokenizer_backend ⇒ nil
2891
|
# File 'sig/types.rbs', line 2891
def self.unregister_tokenizer_backend: (String name) -> nil
|
.unregister_validator ⇒ nil
2879
|
# File 'sig/types.rbs', line 2879
def self.unregister_validator: (String name) -> nil
|
.verify_excerpt ⇒ Boolean
2803
|
# File 'sig/types.rbs', line 2803
def self.verify_excerpt: (String excerpt, String source_text) -> bool
|