Přeskočit na obsah

Rychlý start

Níže uvedený postup používá API klíč k nahrání jednoho souboru, vytvoření překladové úlohy a stažení výsledků.

  1. Připravte přihlašovací údaje a soubor

    Terminál
    export OMNIDOC_API_KEY="sk_your_key"
    BASE="https://omnidoc.top/api/v1"
    FILE="report.docx"
    SIZE=$(wc -c < "$FILE" | tr -d ' ')
  2. Požádejte o adresu a nahrajte soubor

    Terminál
    PRESIGN=$(curl --fail-with-body -sS "$BASE/upload/presign" \
    -H "X-API-Key: $OMNIDOC_API_KEY" \
    -H "Content-Type: application/json" \
    -d "$(jq -n --arg filename "$(basename "$FILE")" --argjson size "$SIZE" \
    '{filename:$filename,file_size:$size}')")
    UPLOAD_URL=$(printf '%s' "$PRESIGN" | jq -r '.upload_url')
    UPLOAD_TYPE=$(printf '%s' "$PRESIGN" | jq -r '.upload_headers["Content-Type"]')
    FINALIZE_TOKEN=$(printf '%s' "$PRESIGN" | jq -r '.finalize_token')
    curl --fail-with-body -sS -X PUT "$UPLOAD_URL" \
    -H "Content-Type: $UPLOAD_TYPE" \
    -H "If-None-Match: *" \
    --upload-file "$FILE"
  3. Potvrďte nahrání a získejte ID dokumentu

    Terminál
    DOCUMENT=$(curl --fail-with-body -sS "$BASE/upload/finalize" \
    -H "X-API-Key: $OMNIDOC_API_KEY" \
    -H "Content-Type: application/json" \
    -d "$(jq -n --arg token "$FINALIZE_TOKEN" '{finalize_token:$token}')")
    DOCUMENT_ID=$(printf '%s' "$DOCUMENT" | jq -r '.document.id')
  4. Vytvořte úlohu překladu

    Terminál
    JOB=$(curl --fail-with-body -sS "$BASE/jobs" \
    -H "X-API-Key: $OMNIDOC_API_KEY" \
    -H "Content-Type: application/json" \
    -H "Idempotency-Key: $(uuidgen)" \
    -d "$(jq -n --arg document_id "$DOCUMENT_ID" \
    '{document_id:$document_id,target_lang:"en"}')")
    JOB_ID=$(printf '%s' "$JOB" | jq -r '.id')
  5. Počkat na dokončení a stažení

    import re
    import time
    from urllib.parse import unquote
    while True:
    response = requests.get(f"{BASE}/jobs/{job_id}", headers=H, timeout=20)
    response.raise_for_status()
    job = response.json()
    if job["status"] in {"completed", "failed"}:
    break
    time.sleep(3)
    if job["status"] == "failed":
    raise RuntimeError(job.get("error_msg") or "translation failed")
    artifacts = requests.get(
    f"{BASE}/artifacts", headers=H, params={"job_id": job_id}, timeout=20
    )
    artifacts.raise_for_status()
    for artifact in artifacts.json():
    download = requests.get(
    f"{BASE}/artifacts/{artifact['id']}/download",
    headers=H,
    timeout=300,
    )
    download.raise_for_status()
    fallback = f"{artifact['id']}.{artifact['format']}"
    disposition = download.headers.get("Content-Disposition", "")
    utf8 = re.search(r"filename\*=UTF-8''([^;]+)", disposition, re.I)
    plain = re.search(r'filename="([^"]+)"', disposition, re.I)
    if utf8:
    name = unquote(utf8.group(1))
    elif plain:
    name = plain.group(1)
    else:
    name = fallback
    safe_name = Path(name).name or fallback
    Path(safe_name).write_bytes(download.content)

Skript nejprve vypíše job_id. Pokud úloha proběhne úspěšně, jsou výsledky staženy do aktuálního adresáře. Hlášení se zastaví, jakmile úloha dosáhne completed nebo failed.

Doba provedení závisí na velikosti souboru a frontě. V produkčním prostředí používejte webhook nebo SSE místo neomezeného pollingu.

V příkladu nedochází k automatickému opakovanému pokusu o vytvoření požadavků. Po vypršení časového limitu sítě uchovávejte ID úlohy, klíč idempotence a tělo požadavku a nejprve zkontrolujte stav. Úloha, která byla vytvořena, není zrušena po ukončení skriptu.

  • 401: zkontrolujte, zda je nastavena proměnná prostředí a klíč je platný.
  • 402 nebo quota_exceeded při práci: zkontrolujte, zda kreditní zůstatek (po odečtení dluhu) pokrývá počáteční hranici.
  • 403: zkontrolujte rozpočet klíče, jeho povolená nastavení a vlastníka zdroje.
  • 429: přečtěte si kód obchodní chyby, abyste rozlišili omezení rychlosti, plnou frontu a vyčerpaný rozpočet.
  • Přímá adresa pro nahrávání vypršela nebo nahrávání selhalo: požádejte o novou adresu pro nahrávání.

Zaznamenejte X-Request-Id a cestu požadavku, ale nikdy nezaznamenejte celý klíč ani přihlašovací údaje pro nahrávání. Všechny chyby a metody opakovaného pokusu jsou uvedeny v odkazu error reference .