Python SDK (polylingo)

Офіційний клієнт Python для PolyLingo REST API. Використовує httpx і надає як синхронні, так і асинхронні клієнти з однаковими назвами методів.

• PyPI: polylingo
• Джерело: UsePolyLingo/polylingo-python

Для деталей сирого HTTP див. API reference.

Встановлення

pip install polylingo

Python: >= 3.9

Синхронний клієнт

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # необов’язково; показано за замовчуванням
    timeout=120.0,  # необов’язково; секунд на запит (за замовчуванням 120)
)

result = client.translate(content="# Hello", targets=["es", "fr"], format="markdown")
print(result["translations"]["es"])

client.close()

Контекстний менеджер:

with polylingo.PolyLingo(api_key="...") as client:
    print(client.languages())

Асинхронний клієнт

import polylingo

async with polylingo.AsyncPolyLingo(api_key="...") as client:
    r = await client.translate(content="Hi", targets=["de"])

Якщо не використовуєте async with, виконайте await client.aclose().

Назви методів збігаються з синхронним клієнтом; всі мережеві методи — async def.

Методи (синхронні та асинхронні)

health() / await health()

GET /health

h = client.health()
# async: h = await client.health()

languages() / await languages()

GET /languages

data = client.languages()
langs = data["languages"]

translate(...)

POST /translate

r = client.translate(
    content="# Hello",
    targets=["es", "fr"],
    format="markdown",  # необов’язково
    source="en",        # необов’язково
    model="standard",   # необов’язково: "standard" | "advanced"
)
r["translations"]["es"]
r["usage"]["total_tokens"]

batch(...)

POST /translate/batch

b = client.batch(
    items=[
        {"id": "a", "content": "Hello"},
        {"id": "b", "content": "## Title", "format": "markdown"},
    ],
    targets=["de"],
)
b["results"][0]["translations"]["de"]

usage() / await usage()

GET /usage

u = client.usage()

Завдання — client.jobs

create / await create

POST /jobs — повертає тіло 202 (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# також приймає kwargs: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Коли status == "completed", відповіді містять translations і usage на верхньому рівні.

translate(...) — зручність

Опитує, доки не буде completed або failed, або поки не вичерпається час.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # секунд між опитуваннями; за замовчуванням 5.0
    timeout=600.0,        # **загальний** бюджет у секундах; за замовчуванням 1200 (20 хв)
    on_progress=lambda pos: print(f"Queue: {pos}"),
)
done["translations"]["de"]

Асинхронно:

done = await client.jobs.translate(
    content=long_md,
    targets=["de"],
    poll_interval=2.0,
    timeout=300.0,
)

Статуси API: pending, processing, completed, failed.

Винятки

import polylingo

try:
    client.translate(content="x", targets=["es"])
except polylingo.AuthError as e:
    print(e.status, e.error)
except polylingo.RateLimitError as e:
    print(e.retry_after)
except polylingo.JobFailedError as e:
    print(e.job_id)
except polylingo.PolyLingoError as e:
    print(e.status, e.error)

Шаблон асинхронних завдань (резюме)

1. Ручний: jobs.create → цикл jobs.get до кінцевого стану.
2. Допоміжний: jobs.translate з poll_interval, timeout та необов’язковим on_progress.

Віддавайте перевагу завданням для дуже великого контенту, де синхронний translate може стикнутися з таймаутами клієнта або сервера.

Типи

Пакет постачається з py.typed. Об’єкти відповіді — це прості значення dict, узгоджені з API; за бажанням використовуйте анотації у стилі TypedDict у вашому коді.

Журнал змін

0.1.0

• Початковий реліз: синхронний PolyLingo, асинхронний AsyncPolyLingo, повне покриття кінцевих точок, включно з помічником опитування jobs.translate.