Skip to main content

Python client for the AILANG Parse document parsing API

Project description

AILANG Parse Python SDK

Python client for the AILANG Parse document parsing API. Parse 13 formats, generate 8 — zero dependencies for Office, pluggable AI for PDFs.

Install

pip install ailang-parse

Quick Start

from ailang_parse import DocParse

client = DocParse(api_key="dp_your_key_here")

# Parse a document
result = client.parse("report.docx")
print(f"{len(result.blocks)} blocks, format: {result.format}")

for block in result.blocks:
    if block.type == "heading":
        print(f"  H{block.level}: {block.text}")
    elif block.type == "table":
        print(f"  Table: {len(block.headers)} cols, {len(block.rows)} rows")
    elif block.type == "change":
        print(f"  {block.change_type} by {block.author}: {block.text}")
    else:
        print(f"  {block.type}: {block.text[:80]}")

Parse Documents

# Parse with different output formats
result = client.parse("report.docx")                        # Block ADT (default)
result = client.parse("report.docx", output_format="markdown")  # Markdown
result = client.parse("report.docx", output_format="html")      # HTML

# Access structured data
print(result.status)          # "success"
print(result.filename)        # "report.docx"
print(result.format)          # "zip-office"
print(result.blocks)          # List[Block]
print(result.metadata.title)  # Document title
print(result.metadata.author) # Document author
print(result.summary.tables)  # Number of tables found

Supported Formats

formats = client.formats()
print(formats.parse)       # ['docx', 'pptx', 'xlsx', 'odt', 'odp', 'ods', 'html', 'md', 'csv', 'epub', 'pdf', 'png', 'jpg']
print(formats.generate)    # ['docx', 'pptx', 'xlsx', 'odt', 'odp', 'ods', 'html', 'md']
print(formats.ai_required) # ['pdf', 'png', 'jpg', 'gif', 'bmp', 'tiff']

Block Types

AILANG Parse returns 9 block types:

Type Fields Description
text text, style, level Paragraphs, code blocks
heading text, level (1-6) Document headings
table headers, rows Tables with merge tracking
list items, ordered Ordered/unordered lists
image description, mime, data_length Embedded images
audio transcription, mime Audio transcriptions
video description, mime Video descriptions
section kind, children Slides, sheets, headers/footers
change change_type, author, date, text Track changes

Table cells

Table cells can be simple strings or merged cells:

for block in result.blocks:
    if block.type == "table":
        for cell in block.headers:
            print(f"  {cell.text} (colspan={cell.col_span}, merged={cell.merged})")

Nested sections

Section blocks contain child blocks (slides, sheets, headers/footers):

for block in result.blocks:
    if block.type == "section":
        print(f"Section: {block.kind}")  # "slide", "sheet", "header", "footer", etc.
        for child in block.children:
            print(f"  {child.type}: {child.text[:50]}")

API Key Management

Key generation uses the device auth flow (v0.10.0+). Direct generation is no longer available.

# Get a key via device auth flow:
#   1. POST /api/v1/auth/device       → {device_code, user_code, verification_url}
#   2. User opens verification_url, signs in, clicks Approve
#   3. POST /api/v1/auth/device/poll  → {api_key, tier}

# Check usage
usage = client.keys.usage(key_id="abc123", user_id="user123")
print(f"Requests today: {usage.usage.requests_today} / {usage.quota.requests_per_day}")
print(f"Pages this month: {usage.usage.pages_this_month} / {usage.quota.pages_per_month}")

# Rotate (new key, old one revoked, same tier)
new_key = client.keys.rotate(key_id="abc123", user_id="user123")
print(new_key.key)  # New key

# Revoke
client.keys.revoke(key_id="abc123", user_id="user123")

Migrating from Unstructured

One import change:

# Before
from unstructured_client import UnstructuredClient
client = UnstructuredClient(server_url="https://api.unstructured.io")

# After
from ailang_parse import UnstructuredClient
client = UnstructuredClient(
    server_url="https://api.parse.sunholo.com"
)

# All existing code works unchanged
elements = client.general.partition(file="report.docx")
for el in elements:
    print(f"{el.type}: {el.text[:80]}")
    print(f"  metadata: {el.metadata.filename}")

Error Handling

from ailang_parse import DocParse, DocParseError, AuthError, QuotaError

client = DocParse(api_key="dp_invalid")

try:
    result = client.parse("file.docx")
except AuthError as e:
    print(f"Bad key: {e}")           # 401
except QuotaError as e:
    print(f"Quota exceeded: {e}")    # 429
except DocParseError as e:
    print(f"API error ({e.status_code}): {e}")

Configuration

client = DocParse(
    api_key="dp_your_key",
    base_url="https://your-deployment.run.app",  # Custom endpoint
    timeout=120,                                   # Request timeout (seconds)
)

Links

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

ailang_parse-0.1.2.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

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

ailang_parse-0.1.2-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file ailang_parse-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for ailang_parse-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d2758a09d72258c036fb13b3676ee218580af8a24847726339fffa323b0d19f5
MD5 0f972f454db722d44fb2f5efa9db42e6
BLAKE2b-256 8c53da1b7e0151d9228fccdd2d270b03096968204b8a003dc6b8ec0e6cfd174d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ailang_parse-0.1.2.tar.gz:

Publisher: publish-sdks.yml on sunholo-data/ailang-parse

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

File details

Details for the file ailang_parse-0.1.2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for ailang_parse-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8145b9c1f8dbeca478242b199d4bf54481b58ca0303eb1a6cf8e4c0ea4bb2c4b
MD5 410454ca514f39e16c4ff9d5b5cb01e1
BLAKE2b-256 75f3ee0c85d6eb7bf734345ee8f23fc4b399b694a90432518cf7c9712c5236ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for ailang_parse-0.1.2-py3-none-any.whl:

Publisher: publish-sdks.yml on sunholo-data/ailang-parse

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