Python SDK (polylingo)

Virallinen Python-asiakas PolyLingo REST API:lle. Käyttää httpx ja tarjoaa sekä synkroniset että asynkroniset asiakkaat samoilla metodin nimillä.

• PyPI: polylingo
• Lähdekoodi: UsePolyLingo/polylingo-python

Raakojen HTTP-tietojen osalta katso API reference.

Asennus

pip install polylingo

Python: >= 3.9

Synkroninen asiakas

import os
import polylingo

client = polylingo.PolyLingo(
    api_key=os.environ["POLYLINGO_API_KEY"],
    base_url="https://api.usepolylingo.com/v1",  # valinnainen; oletusnäytetty
    timeout=120.0,  # valinnainen; sekunteja per pyyntö (oletus 120)
)

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

client.close()

Kontekstinhallinta:

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

Asynkroninen asiakas

import polylingo

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

Käytä await client.aclose() jos et käytä async with.

Metodien nimet vastaavat synkronista asiakasta; kaikki verkkometodit ovat async def.

Metodit (synkroniset ja asynkroniset)

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

Työt — client.jobs

create / await create

POST /jobs — palauttaa 202-vastauksen (job_id, status, …).

job = client.jobs.create(content=long_md, targets=["de", "fr"], format="markdown")
# kwargs hyväksytään myös: client.jobs.create(**{"content": ..., "targets": [...]})

get(job_id) / await get(job_id)

GET /jobs/:id. Kun status == "completed", vastaukset sisältävät translations ja usage ylimmällä tasolla.

translate(...) — kätevyys

Kysely suoritetaan, kunnes tila on completed tai failed, tai kunnes aika loppuu.

done = client.jobs.translate(
    content=long_md,
    targets=["de", "fr", "es"],
    format="markdown",
    poll_interval=10.0,   # sekuntia kyselyiden välillä; oletus 5.0
    timeout=600.0,        # **kokonais** sekuntibudjetti; oletus 1200 (20 min)
    on_progress=lambda pos: print(f"Queue: {pos}"),
)
done["translations"]["de"]

Asynkroninen:

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

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

Poikkeukset

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)

Asynkronisten töiden malli (yhteenveto)

1. Manuaalinen: jobs.create → silmukka jobs.get kunnes lopputila.
2. Apuri: jobs.translate poll_interval-, timeout- ja valinnaisella on_progress-parametrilla.

Suosi töitä erittäin suurille sisällöille, joissa synkroninen translate saattaa kohdata asiakas- tai palvelinaikakatkaisuja.

Tyypit

Paketti sisältää py.typed-tiedoston. Vastausobjektit ovat tavallisia dict-arvoja, jotka vastaavat API:a; käytä TypedDict-tyylisiä annotaatioita koodissasi halutessasi.

Muutokset

0.1.0

• Ensijulkaisu: synkroninen PolyLingo, asynkroninen AsyncPolyLingo, täydellinen päätepisteiden kattavuus mukaan lukien jobs.translate-kyselyapuri.