跳转到内容

Жылдам бастау

Төмендегі ағын API кілтін пайдаланып, бір файлды жүктейді, аударма тапсырысын жасайды және нәтижелерді жүктеп алады.

  1. Арнайы деректер мен файлды дайындаңыз

    Terminal window
    export OMNIDOC_API_KEY="sk_your_key"
    BASE="https://omnidoc.top/api/v1"
    FILE="report.docx"
    SIZE=$(wc -c < "$FILE" | tr -d ' ')
  2. Мекенжайды сұрау және файлды жүктеу

    Terminal window
    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. Жүктеуді растаңыз және құжаттың ID-сін алыңыз

    Terminal window
    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. Аударма жұмысын жасаңыз

    Terminal window
    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. Аяқталуын күтіп, жүктеңіз

    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)

Скрипт алдымен job_id мәнін шығарады. Жұмыс сәтті аяқталған жағдайда нәтижелер ағымдағы каталогқа жүктеледі. Жұмыс completed немесе failed мәніне жеткенде сұрау тоқтатылады.

Қанша уақыт қажет болатыны файлдың көлеміне және кезекте тұрған мәліметтерге байланысты. Өндірісте шексіз сұрыптаудың орнына webhook немесе SSE пайдаланыңыз.

Мысалда жасау сұранымдары автоматты түрде қайта тырыспайды. Желілік уақытша қате болғаннан кейін, жұмыс ID-сын, идемпотенттік кілтті және сұраным денесін сақтаңыз да, алдымен мәртебені тексеріңіз. Скрипт шыққан кезде жасалған жұмыс жойылмайды.

Бірдеңе сәтсіздікке ұшырағанда

Section titled “Бірдеңе сәтсіздікке ұшырағанда”
  • 401: орташа айнымалы орнатылғанын және кілт дұрыс екенін тексеріңіз.
  • 402 немесе жұмыс барысында quota_exceeded: несие қалдығының (қарыздан кейінгі) бастапқы шекті жабатынын тексеріңіз.
  • 403: кілттің бюджетін, рұқсат етілген параметрлерін және ресурстың иесін тексеріңіз.
  • 429: тарифтік шектеуді, толық кезекті және біткен бюджетті ажырату үшін бизнес қатесі кодын оқыңыз.
  • Тікелей жүктеу мекенжайының мерзімі өтті немесе жүктеу сәтсіз аяқталды: жаңа жүктеу мекенжайын сұраңыз.

Журналға X-Request-Id және сұраным жолын жазыңыз, бірақ толық кілтті немесе жүктеу деректерін ешқашан жазбаңыз. Барлық қателер мен қайта тырысу әдістері қате сілтемесінде .