Skip to main content

Retab official python library

Project description

Retab

Retab Logo

The AI Automation Platform

Made with love by the team at Retab 🤍.

Our Website | Documentation | Discord | Twitter


What is Retab?

Retab solves all the major challenges in document processing with Large Language Models:

  1. Universal Document Preprocessing: Convert any file type (PDFs, Excel, emails, etc.) into LLM-ready format without writing custom parsers
  2. Structured, Schema-driven Extraction: Get consistent, reliable outputs using schema-based prompt engineering
  3. Processors: Publish a live, stable, shareable document processor.
  4. Automations: Create document processing workflows that can be triggered by events (mailbox, upload link, endpoint, outlook plugin).
  5. Optimizations: Identify the most used processors and help you finetune models to reduce costs and improve performance

We are offering you all the software-defined primitives to build your own document processing solutions. We see it as Stripe for document processing.

Our goal is to make the process of analyzing documents and unstructured data as easy and transparent as possible.

A new, lighter paradigm Large Language Models collapse entire layers of legacy OCR pipelines into a single, elegant abstraction. When a model can read, reason, and structure text natively, we no longer need brittle heuristics, handcrafted parsers, or heavyweight ETL jobs. Instead, we can expose a small, principled API: "give me the document, tell me the schema, and get back structured truth." Complexity evaporates, reliability rises, speed follows, and costs fall—because every component you remove is one that can no longer break. LLM‑first design lets us focus less on plumbing and more on the questions we actually want answered.

Many people haven't yet realized how powerful LLMs have become at document processing tasks - we're here to help unlock these capabilities.


Go further


Code examples

You can check our Github repository to see code examples: python examples and jupyter notebooks.

Workflow Specs

Use client.workflows.specs to validate, plan, apply, and export declarative workflow YAML.

from retab import Retab

client = Retab()

validation = client.workflows.specs.validate(yaml_definition)
plan = client.workflows.specs.plan(yaml_definition)
result = client.workflows.specs.apply(yaml_definition)
exported = client.workflows.specs.export(result.workflow_id)

Declarative specs use apiVersion: workflows.retab.com/v1alpha2 and explicit edge handles:

edges:
  - from:
      block: start-node
      handle: output-file-0
    to:
      block: extract-node
      handle: input-file-source_doc

Workflow Artifacts

Workflow steps expose artifact as a stable {operation, id} pointer. Use client.workflows.artifacts to fetch the persisted record behind that pointer, including HIL evaluations, conditional matches, function outputs, and API-call attempts.

run = client.workflows.runs.create_and_wait(
    workflow_id="workflow_abc123",
    documents={"start-node": "invoice.pdf"},
)

step = client.workflows.runs.steps.get(run.id, "hil-node")
if step.artifact:
    artifact = client.workflows.artifacts.get(step.artifact)
    print(artifact.operation)
    print(artifact.requires_human_review)
    print(artifact.evaluations)

all_artifacts = client.workflows.artifacts.list(run.id)

Community

Let's create the future of document processing together!

Join our discord community to share tips, discuss best practices, and showcase what you build. Or just tweet at us.

We can't wait to see how you'll use Retab.


Roadmap

We share our roadmap publicly on Github

Among the features we're working on:

  • Node.js SDK
  • Schema optimization autopilot
  • Sources API

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

retab-0.0.142.tar.gz (156.2 kB view details)

Uploaded Source

Built Distribution

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

retab-0.0.142-py3-none-any.whl (153.7 kB view details)

Uploaded Python 3

File details

Details for the file retab-0.0.142.tar.gz.

File metadata

  • Download URL: retab-0.0.142.tar.gz
  • Upload date:
  • Size: 156.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for retab-0.0.142.tar.gz
Algorithm Hash digest
SHA256 484ea6b87558b239deaa53b0af961231be6b8f3d03bdb9ddb7c58e0bdfbbb403
MD5 678104996680967d2ac9e417ad15417c
BLAKE2b-256 e6fbcf1def9147abae6d3764d0c43395d65cc5d5f4fe1877a6e3a4cce62bc56d

See more details on using hashes here.

File details

Details for the file retab-0.0.142-py3-none-any.whl.

File metadata

  • Download URL: retab-0.0.142-py3-none-any.whl
  • Upload date:
  • Size: 153.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for retab-0.0.142-py3-none-any.whl
Algorithm Hash digest
SHA256 f6fe07c71261a886d5509c7ef48acb2a16c825d4239a82c61ead1a6ed184b948
MD5 d6323038759e9fa03646930797bf75f2
BLAKE2b-256 3f45d16e8a743817a401e68ff20b140d1fd2236286e89c91469852a0f36b2a41

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