Schnellstart
Der folgende Ablauf verwendet einen API-Schlüssel, um eine Datei hochzuladen, einen Übersetzungsauftrag zu erstellen und die Ergebnisse herunterzuladen.
-
Bereiten Sie die Anmeldedaten und die Datei vor
Terminal-Fenster export OMNIDOC_API_KEY="sk_your_key"BASE="https://omnidoc.top/api/v1"FILE="report.docx"SIZE=$(wc -c < "$FILE" | tr -d ' ')import uuidfrom pathlib import Pathimport requestsAPI_KEY = "sk_your_key"BASE = "https://omnidoc.top/api/v1"FILE = Path("report.docx")H = {"X-API-Key": API_KEY}import axios from 'axios';import fs from 'node:fs';import path from 'node:path';const API_KEY = 'sk_your_key';const BASE = 'https://omnidoc.top/api/v1';const filePath = 'report.docx';const apiHeaders = { 'X-API-Key': API_KEY }; -
Fordern Sie eine Adresse an und laden Sie die Datei hoch
Terminal-Fenster 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"presign = requests.post(f"{BASE}/upload/presign",headers=H,json={"filename": FILE.name,"file_size": FILE.stat().st_size,},timeout=20,)presign.raise_for_status()ticket = presign.json()with FILE.open("rb") as stream:put_headers = {**ticket["upload_headers"],"Content-Length": str(FILE.stat().st_size),}uploaded = requests.put(ticket["upload_url"], headers=put_headers, data=stream, timeout=300)uploaded.raise_for_status()const stat = fs.statSync(filePath);const { data: ticket } = await axios.post(`${BASE}/upload/presign`,{filename: path.basename(filePath),file_size: stat.size,},{ headers: apiHeaders });await axios.put(ticket.upload_url, fs.createReadStream(filePath), {headers: { ...ticket.upload_headers, 'Content-Length': stat.size },maxBodyLength: Infinity,}); -
Bestätigen Sie den Upload und erhalten Sie die Dokument-ID
Terminal-Fenster 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')finalized = requests.post(f"{BASE}/upload/finalize",headers=H,json={"finalize_token": ticket["finalize_token"]},timeout=30,)finalized.raise_for_status()document_id = finalized.json()["document"]["id"]const { data: finalized } = await axios.post(`${BASE}/upload/finalize`,{ finalize_token: ticket.finalize_token },{ headers: apiHeaders });const documentId = finalized.document.id; -
Erstellen Sie den Übersetzungsauftrag
Terminal-Fenster 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')job_response = requests.post(f"{BASE}/jobs",headers={**H, "Idempotency-Key": str(uuid.uuid4())},json={"document_id": document_id, "target_lang": "en"},timeout=30,)job_response.raise_for_status()job_id = job_response.json()["id"]const { data: job } = await axios.post(`${BASE}/jobs`,{ document_id: documentId, target_lang: 'en' },{ headers: { ...apiHeaders, 'Idempotency-Key': crypto.randomUUID() } });const jobId = job.id; -
Warten Sie auf den Abschluss und laden Sie herunter
import reimport timefrom urllib.parse import unquotewhile 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"}:breaktime.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 = fallbacksafe_name = Path(name).name or fallbackPath(safe_name).write_bytes(download.content)
Was Sie erhalten
Abschnitt betitelt „Was Sie erhalten“Das Skript gibt zunächst die job_id aus. Wenn der Auftrag erfolgreich ist, werden die Ergebnisse in das aktuelle Verzeichnis heruntergeladen. Die Abfrage wird beendet, sobald der Auftrag completed oder failed erreicht.
Wie lange es dauert, hängt von der Dateigröße und der Warteschlange ab. Verwenden Sie in der Produktion einen webhook oder SSE anstelle eines unbegrenzten Pollings.
Das Beispiel führt keine automatischen Wiederholungsversuche für Erstellungsanfragen durch. Nach einem Netzwerk-Timeout sollten die Job-ID, der Idempotenzschlüssel und der Anfragetext beibehalten und zunächst der Status überprüft werden. Ein bereits erstellter Job wird beim Beenden des Skripts nicht abgebrochen.
Wenn etwas fehlschlägt
Abschnitt betitelt „Wenn etwas fehlschlägt“401: Überprüfen Sie, ob die Umgebungsvariable gesetzt ist und der Schlüssel gültig ist.402oderquota_exceededim Einsatz: Prüfen Sie, ob der Guthabenstand (nach Abzug von Schulden) den Startschwellenwert deckt.403: Überprüfen Sie das Budget des Schlüssels, seine zulässigen Einstellungen und den Eigentümer der Ressource.429: Lesen Sie den Geschäftsfehlercode, um zwischen einer Rate-Limit-Verletzung, einer vollen Warteschlange und einem erschöpften Budget zu unterscheiden.- Die Direkt-Upload-Adresse ist abgelaufen oder der Upload ist fehlgeschlagen: Bitte fordern Sie eine neue Upload-Adresse an.
Protokollieren Sie X-Request-Id und den Anfragepfad, jedoch niemals den vollständigen Schlüssel oder die Upload-Anmeldedaten. Alle Fehler und Wiederholungsverfahren finden Sie in der Fehlerreferenz.