Skip to main content

Official Python SDK for the Poma document-processing API

Project description

POMA AI Logo

POMA: Preserving Optimal Markdown Architecture

Quick-Start Guide

Installation

Requires Python 3.10+. Install the core package:

pip install poma

For different integrations:

pip install 'poma[langchain]'
pip install 'poma[llamaindex]'
pip install 'poma[qdrant]'

# Or LangChain/LlamaIndex/Qdrant including example extras:
pip install 'poma[all]'
  • You may also want: pip install python-dotenv to load API keys from a .env file.
  • API keys required (POMA_API_KEY) for the POMA AI client via environment variables.
  • To request a POMA_API_KEY, please contact us at sdk@poma-ai.com

Usage

from poma import PrimeCut

pc = PrimeCut(api_key="your_key")

# Ingest a document — submits the file, polls, and returns typed results
result = pc.ingest("document.pdf")

print(result.chunksets[0])
print(result.chunks[0].content)

# Eco ingestion uses the same flow against the eco endpoints
eco_result = pc.ingest_eco("document.pdf")

The PrimeCut client also supports cheatsheet generation:

cheatsheet = pc.create_cheatsheet(
    relevant_chunksets=[cs.to_dict() for cs in result.chunksets],
    all_chunks=[c.to_dict() for c in result.chunks],
)
print(cheatsheet)

Example Implementations

All examples, integrations, and additional information can be found in our GitHub repository: poma-ai/poma

We provide example implementations to help you get started with POMA AI:

  • example.py — A standalone implementation for documents, showing the basic POMA AI workflow with simple keyword-based retrieval
  • example_langchain.py — Integration with LangChain, demonstrating how easy it is to use POMA AI with LangChain
  • example_llamaindex.py — Integration with LlamaIndex, showing how simple it is to use POMA AI with LlamaIndex

Note: The integration examples use OpenAI embeddings. Make sure to set your OPENAI_API_KEY environment variable, or replace the embeddings with your preferred ones.

All examples follow the same two-phase process (ingest → retrieve) but demonstrate different integration options for your RAG pipeline.

! Please do NOT send any sensitive and/or personal information to POMA AI endpoints without having a signed contract & DPA !

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

poma-0.4.1.tar.gz (33.7 kB view details)

Uploaded Source

Built Distribution

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

poma-0.4.1-py3-none-any.whl (37.7 kB view details)

Uploaded Python 3

File details

Details for the file poma-0.4.1.tar.gz.

File metadata

  • Download URL: poma-0.4.1.tar.gz
  • Upload date:
  • Size: 33.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for poma-0.4.1.tar.gz
Algorithm Hash digest
SHA256 d80cd0503cc14c81d5f67bacd0ebf397c9edaa5325ec734a0495400e0af4b2f8
MD5 d63a14aef9957089b03955f6f006c519
BLAKE2b-256 5608648ee8b801d68ff958b0ad9867c4962b7478f45b71e58eb68e1b1a5c3056

See more details on using hashes here.

Provenance

The following attestation bundles were made for poma-0.4.1.tar.gz:

Publisher: python-publish.yml on poma-ai/poma-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file poma-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: poma-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 37.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for poma-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be23bb56df4c6fde07d227f9fa9e90046abf4d5e66f8883ae311b64f68fc311a
MD5 1839f7baa9a015fc087e47b6f9774d7b
BLAKE2b-256 b44715a03fe3b79f7f2b8a71103b63ec3be44bc196deee875dd443f857110db4

See more details on using hashes here.

Provenance

The following attestation bundles were made for poma-0.4.1-py3-none-any.whl:

Publisher: python-publish.yml on poma-ai/poma-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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