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.2.tar.gz (34.3 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.2-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: poma-0.4.2.tar.gz
  • Upload date:
  • Size: 34.3 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.2.tar.gz
Algorithm Hash digest
SHA256 1f4ce9866fa48961eaa01f4641b611e330a574519a7896ca9d0bc3958155db75
MD5 51bdbc592196da86e1efc43d63513f0d
BLAKE2b-256 b50840018b86da23a84036c7b58328aabe9fc4dccbfc2521b0ce9d18bf11c326

See more details on using hashes here.

Provenance

The following attestation bundles were made for poma-0.4.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: poma-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 38.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 77595a32b01033c9422f6ccaac3eb7caa6a3d91b290dab5833399e8c1e9aa71d
MD5 f8dda5b90e0e254691c3324bb625ce0a
BLAKE2b-256 c0f86cc74ca8fddcf07092b7b62dca676189a033996fa812ef03f01b39cffe7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for poma-0.4.2-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