Дакументацыя API

Тэла запыту

* Выкарыстанне target_language (радок) для адной мовы або target_languages (масіў) для мноства. Глядзіце Некалькі перакладаў.

Адказ

{
    "translated_text": "Hola, mundo!",
    "source_language": "en",
    "target_language": "es",
    "translations": {
        "es": "Hola, mundo!"
    },
    "character_count": 13,
    "translation_time": 0.45
}

Тэла запыту

{
    "text": "Hello, world!",
    "target_languages": ["es", "fr", "de", "ja"],
    "source_language": "en"
}

Выкарыстоўваць target_languages (масіў) замест target_language (радок) для некалькіх мэтаў.

Адказ

{
    "source_language": "en",
    "translations": {
        "es": "Hola, mundo!",
        "fr": "Bonjour, monde!",
        "de": "Hallo, Welt!",
        "ja": "こんにちは、世界！"
    },
    "character_count": 52,
    "translation_time": 2.31
}

Крок 1: Даслаць пакет

curl -X POST https://api.translateapi.ai/api/v1/translate/batch/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "texts": ["Hello", "Goodbye", "Thank you"],
    "target_language": "es",
    "source_language": "en"
}'

Адказ (HTTP 202 прыняты)

{
    "job_id": "67535b2b-c9e3-4f82-9499-e237edbc1dd8",
    "status": "pending",
    "total_texts": 3,
    "queue_position": 1,
    "source_language": "en",
    "target_languages": ["es"],
    "character_count": 22,
    "credits_remaining": -1,
    "poll_url": "https://api.translateapi.ai/api/v1/jobs/67535b2b-c9e3-4f82-9499-e237edbc1dd8/"
}

Крок 2: Праверыць вынікі

GET https://api.translateapi.ai/api/v1/jobs/{job_id}/

Прыклад апытання (Python)

import time, requests

job_id = response.json()["job_id"]
total = response.json()["total_texts"]
headers = {"Authorization": "Bearer YOUR_API_KEY"}

print(f"Batch submitted: {total} texts (job {job_id})")

while True:
    result = requests.get(f"https://api.translateapi.ai/api/v1/jobs/{job_id}/", headers=headers).json()
    status = result["status"]
    processed = result.get("processed_texts", 0)
    progress = result.get("progress_percentage", 0)

    if status == "completed":
        print(f"Completed: {processed}/{total} texts in {result.get('processing_time', 0):.1f}s")
        translations = result["result_data"]["translations"]
        break
    elif status == "failed":
        print(f"Failed at {processed}/{total}: {result.get('error_message', 'unknown')}")
        raise Exception(result.get("error_message", "Translation failed"))
    elif status == "pending":
        queue_pos = result.get("queue_position", "?")
        print(f"Queued (position {queue_pos}) — waiting for GPU worker...")
    else:
        print(f"[{status}] {processed}/{total} ({progress:.0f}%)")

    time.sleep(3)

Адказ (чакае - у чарзе, чакае GPU)

{
    "job_id": "67535b2b-...",
    "status": "pending",
    "processed_texts": 0,
    "total_texts": 3,
    "progress_percentage": 0.0,
    "queue_position": 3
}

Адказ (падчас апрацоўкі)

{
    "job_id": "67535b2b-...",
    "status": "processing",
    "processed_texts": 1,
    "total_texts": 3,
    "progress_percentage": 33.33,
    "queue_position": null
}

Адказ (выканана)

{
    "job_id": "67535b2b-...",
    "status": "completed",
    "processed_texts": 3,
    "total_texts": 3,
    "progress_percentage": 100.0,
    "processing_time": 10.65,
    "result_data": {
        "translations": ["Hola", "Adiós", "Gracias"],
        "source_language": "en",
        "target_language": "es",
        "character_count": 22,
        "processing_time": 10.65
    }
}

Назіранне за працэсам у рэальным часе

Кожны адказ на апытанне ўтрымлівае палі прагрэсу ў рэальным часе, так што вы можаце назіраць за тым, што адбываецца з вашым пакетам:

Лепшыя практыкі для вялікіх нагрузак

• Адпраўляць па адной мэтавай мове на пакетны запыт. Гэта забяспечвае хуткасць кожнага пакета і дазваляе лёгка адсочваць працэс.
• Папкі павінны складацца з 50- 100 тэкстаў. Маленькія пакункі працуюць хутчэй і даюць часцейшыя абнаўлення.
• Выканаць не больш за 2 адначасовых пакетных заданняў. Графічны працэсар апрацоўвае 2 пакеты паралельна - дадатковыя заданні стаяць у чарзе і не пачынаюцца хутчэй.
• Пасля заканчэння тэрміну чакання перапрацаваць той жа job_ id замест перадачы новай партыі. Першапачатковае заданне ўсё яшчэ можа апрацоўвацца на GPU.
• Запытваць кожныя 3- 5 секунд. Больш частае запытванне не паскарае апрацоўку.

Пакет на некалькіх мовах

Пераклад некалькіх тэкстаў на некалькі моў адначасова:

{
    "texts": ["Hello", "Goodbye"],
    "target_languages": ["es", "fr"],
    "source_language": "en"
}

Завершаныя выніковыя_ дадзеныя

{
    "translations": [
        {"es": "Hola", "fr": "Bonjour"},
        {"es": "Adiós", "fr": "Au revoir"}
    ],
    "source_language": "en",
    "target_languages": ["es", "fr"],
    "character_count": 24,
    "processing_time": 2.45
}

Параметры запыту

* Пакажыце або target_language або target_languages, не абодва.

Запыт (multipart/form-data)

Падтрымліваемыя тыпы файлаў

Прыклад (cURL)

# Translate a Word document
curl -X POST https://api.translateapi.ai/api/v1/translate/document/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.docx" \
  -F "target_language=es" \
  -F "source_language=en"

# Translate text from an image (OCR)
curl -X POST https://api.translateapi.ai/api/v1/translate/document/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@scanned_page.jpg" \
  -F "target_language=es" \
  -F "source_language=en"

Адказ

{
    "id": 123,
    "original_filename": "document.docx",
    "file_type": "docx",
    "source_language": "en",
    "target_language": "es",
    "status": "completed",
    "character_count": 5420,
    "translated_file_url": "/media/translated/document_es.docx",
    "created_at": "2024-01-15T10:30:00Z",
    "completed_at": "2024-01-15T10:30:05Z"
}

Значэнні стану

Праверка стану перакладу дакумента або атрыманне спасылкі для сцягвання.

Адказ

{
    "id": 123,
    "original_filename": "document.docx",
    "status": "completed",
    "translated_file_url": "/media/translated/document_es.docx",
    "character_count": 5420
}

Тэла запыту

{
    "text": "Bonjour, comment allez-vous?",
    "target_language": "en"
}

Адказ

{
    "translated_text": "Hello, how are you?",
    "source_language": "fr",
    "target_language": "en",
    "translations": {
        "en": "Hello, how are you?"
    },
    "character_count": 28,
    "translation_time": 0.52
}

Змяніць source_language поле ў адказе паказвае выяўленую мову пры выкарыстанні аўтаматычнага выяўлення.

Адказ

{
    "count": 186,
    "results": [
        {"iso": "en", "name": "English", "en_label": "English"},
        {"iso": "es", "name": "Español", "en_label": "Spanish"},
        {"iso": "fr", "name": "Français", "en_label": "French"},
        ...
    ]
}