Python SDK (polylingo)

Officiel Python-klient til PolyLingo REST API. Den bruger httpx og tilbyder både sync og async klienter med de samme metodenavne.

For rå HTTP-detaljer, se API reference.


Installation

pip install polylingo

Python: >= 3.9


Sync klient

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # valgfrit; standard vist
    timeout=120.0,  # valgfrit; sekunder per forespørgsel (standard 120)
)

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

client.close()

Context manager:

with polylingo.PolyLingo(api_key="...") as client:
    print(client.languages())
ArgumentPåkrævetBeskrivelse
api_keyJaAPI-nøgle (Authorization: Bearer …).
base_urlNejAPI-præfiks inklusive /v1. Standard https://api.usepolylingo.com/v1.
timeoutNejhttpx timeout i sekunder. Standard 120.0.

Async klient

import polylingo

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

Brug await client.aclose() hvis du ikke bruger async with.

Metodenavne matcher sync klienten; alle netværksmetoder er async def.


Metoder (sync og async)

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",  # valgfrit
    source="en",        # valgfrit
    model="standard",   # valgfrit: "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()

Jobs — client.jobs

create / await create

POST /jobs — returnerer 202 body (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# kwargs accepteres også: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Når status == "completed", inkluderer svar translations og usage på topniveau.

translate(...) — bekvemmelighed

Poller indtil completed eller failed, eller indtil tiden løber ud.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # sekunder mellem polls; standard 5.0
    timeout=600.0,        # **total** sekunder budget; standard 1200 (20 min)
    on_progress=lambda pos: print(f"Queue: {pos}"),
)
done["translations"]["de"]

Async:

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

API-statusser: pending, processing, completed, failed.


Undtagelser

KlasseHvornår
polylingo.PolyLingoErrorBasis — status, error, args[0] besked.
polylingo.AuthErrorHTTP 401.
polylingo.RateLimitErrorHTTP 429retry_after kan være sat (sekunder).
polylingo.JobFailedErrorMislykket job, dårlig færdig payload eller polling timeout — job_id.
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)

Async jobs mønster (resumé)

  1. Manuel: jobs.create → loop jobs.get indtil terminal tilstand.
  2. Hjælper: jobs.translate med poll_interval, timeout og valgfri on_progress.

Foretræk jobs til meget stort indhold, hvor synkron translate kan ramme klient- eller server-timeouts.


Typer

Pakken leveres med py.typed. Responsobjekter er almindelige dict værdier tilpasset API; brug TypedDict-stil annotationer i din kode, hvis ønsket.


Ændringslog

0.1.0

  • Første udgivelse: sync PolyLingo, async AsyncPolyLingo, fuld endpoint-dækning inklusive jobs.translate polling hjælper.
Python SDK | PolyLingo dokumentation | PolyLingo