Skip to main content

Xberg

txtai-xberg

Feed Xberg document extraction into txtai. XbergPipeline is a plain callable that extracts text and metadata from 107 formats — running OCR where needed — and flattens the result into documents ready for txtai.Embeddings.index. When you enable Xberg's native chunking, each chunk becomes one embedding-sized segment instead of a single blob.

Install

pip install txtai-xberg

Requires Python 3.10+. Install the txtai extra (pip install "txtai-xberg[txtai]") if txtai isn't already in your environment.

Extract

Call the pipeline with a path or a list of paths. A string returns one document; a list returns documents in input order. Batches run through Xberg's extract_batch in a single native call.

from txtai_xberg import XbergPipeline

pipeline = XbergPipeline()

doc = pipeline("report.pdf")
print(doc["content"])              # extracted markdown
print(doc["metadata"]["title"])    # source, mime_type, title, authors, languages, page_count

docs = pipeline(["report.pdf", "notes.docx"])

Index into txtai

Use to_documents to get (id, text, tags) tuples and hand them straight to Embeddings.index. Enable Xberg chunking so segments arrive sized for the model, with heading and page context in each document's tags.

from txtai import Embeddings
from txtai_xberg import XbergPipeline
from xberg import ChunkingConfig, ExtractionConfig

pipeline = XbergPipeline(
    config=ExtractionConfig(chunking=ChunkingConfig(max_characters=1000, overlap=200)),
)
documents = pipeline.to_documents(["report.pdf", "notes.docx"])

embeddings = Embeddings(path="sentence-transformers/all-MiniLM-L6-v2", content=True)
embeddings.index(documents)

for result in embeddings.search("quarterly revenue", 3):
    print(result["id"], result["text"])

Without a chunking config, to_documents emits one document per file. Chunk ids are "<source>#<chunk_index>".

Configure extraction

Pass any Xberg ExtractionConfig to control OCR, output format, chunking, and concurrency.

from xberg import ExtractionConfig, OcrConfig

pipeline = XbergPipeline(
    config=ExtractionConfig(
        output_format="markdown",
        ocr=OcrConfig(language="eng"),
        force_ocr=True,
        max_concurrent_extractions=8,
    ),
)

Async

Already inside an event loop? Use the async methods — await pipeline.acall(paths) and await pipeline.ato_documents(paths). The synchronous __call__ and to_documents wrap these with asyncio.run and must not run inside a running loop.

Errors

Per-input failures in a batch surface as an ExtractionFailedError, whose errors attribute holds Xberg's ExtractionErrorItem objects (each with an index, source, code, and message).

For the full API, see the Xberg documentation.

Release files for txtai-xberg 1.2.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for txtai-xberg 1.2.7
File Size Uploaded
txtai_xberg-1.2.7.tar.gz 9.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for txtai-xberg 1.2.7
File Interpreter ABI Platform
txtai_xberg-1.2.7-py3-none-any.whl Python 3 none any Details

Total release size: 16.7 kB

Release files / txtai_xberg-1.2.7.tar.gz

Download URL txtai_xberg-1.2.7.tar.gz
Size 9.7 kB
Tags Source
SHA-256 checksum
How to use checksums
4c4dc69c4aa5e7703cd6cc1e1430cb4aa45757e0efce09c4662383fe5f317a0a
BLAKE2b-256 checksum
How to use checksums
74c7e88a0494154526b36f2668a3837c8f97f55448faf9f2f5940641d74a20c0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / txtai_xberg-1.2.7-py3-none-any.whl

Download URL txtai_xberg-1.2.7-py3-none-any.whl
Size 7.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c418cb77a554d545c698d584418c2aa1169b7cdb68aed61a65d944e01a0d1c80
BLAKE2b-256 checksum
How to use checksums
ffce3eca8d9c826ae392fed92c2b248bdf2e034f9700ae43dcf0c791a3178a1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.17 {"installer":{"name":"uv","version":"0.12.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page