Skip to main content

Xberg document extraction tools for CrewAI agents — text, metadata, and batch extraction across 97 file formats

Project description

Xberg

crewai-xberg

CrewAI tools backed by Xberg. Give an agent document intelligence: extract text, metadata, keywords, entities, and summaries from 97 file formats — PDF, DOCX, XLSX, HTML, images with OCR, and more. Extraction is async at the core; the batch tool routes many files through Xberg's extract_batch in a single native call.

Install

pip install crewai-xberg

Requires Python 3.10+.

Tools

Tool Input Returns
XbergExtractTool file_path Extracted text, plus any requested rich results.
XbergExtractBatchTool file_paths One section per document via extract_batch, then errors.
XbergExtractMetadataTool file_path Title, authors, dates, page/table/image counts, format info.

Use

from crewai import Agent
from crewai_xberg import XbergExtractTool, XbergExtractBatchTool, XbergExtractMetadataTool

agent = Agent(
    role="Document Analyst",
    goal="Extract and analyze document content",
    backstory="You process documents of any format.",
    tools=[XbergExtractTool(), XbergExtractBatchTool(), XbergExtractMetadataTool()],
)

Call a tool directly to see its output:

tool = XbergExtractTool()

# Plain extraction
text = tool.run(file_path="report.pdf")

# Force OCR and surface keywords, entities, and a summary
enriched = tool.run(
    file_path="scan.pdf",
    output_format="markdown",
    force_ocr=True,
    extract_keywords=True,
    extract_entities=True,
    summarize=True,
)

# Many files in one batched extraction
combined = XbergExtractBatchTool().run(file_paths=["report.pdf", "notes.docx", "sheet.xlsx"])

Options

Both extraction tools accept the same options. Each toggles an Xberg ExtractionConfig capability:

Option Default Effect
output_format "markdown" plain, markdown, or html.
force_ocr False Run OCR on every page, even with a text layer.
chunk False Split into semantic chunks; report the chunk count.
extract_keywords False Append a keyword list.
extract_entities False Append named entities (people, orgs, locations).
summarize False Append a short summary.

Detected languages and tables are surfaced automatically when present.

Async

The tools are async at the core. Inside an event loop, await tool.arun(...); the synchronous run bridges to it and must not be called from a running loop.

Errors

A missing file raises from Xberg directly. In batch mode, per-file failures land in ExtractionResult.errors and are reported in a trailing Errors section instead of aborting the batch.

For the full API, see the Xberg documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crewai_xberg-1.0.0rc38.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

crewai_xberg-1.0.0rc38-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file crewai_xberg-1.0.0rc38.tar.gz.

File metadata

  • Download URL: crewai_xberg-1.0.0rc38.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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}

File hashes

Hashes for crewai_xberg-1.0.0rc38.tar.gz
Algorithm Hash digest
SHA256 3e8e00a0747ee7fd513450bf498b6e3f049c821d05ff17ce0fb893c787f21b63
MD5 e7c4922345483b78669c58d0b4fb38ed
BLAKE2b-256 edb396a297316f625c68e6311bc91cb65b3f995fe6d7b6defa45024c400c8b24

See more details on using hashes here.

File details

Details for the file crewai_xberg-1.0.0rc38-py3-none-any.whl.

File metadata

  • Download URL: crewai_xberg-1.0.0rc38-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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}

File hashes

Hashes for crewai_xberg-1.0.0rc38-py3-none-any.whl
Algorithm Hash digest
SHA256 feb143128796107569ebc80f56e2c9eeeb30db51e5dc2bf58d0326c7aa08db1d
MD5 071884ee3eb3b4302e9264f96d914f7d
BLAKE2b-256 895e418a526a9e14063815e33c1891f091ea6200ebd01ded4a2609effb486b12

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page