API құжаттамасы

Сұраныстың мазмұны

* Пайдалану target_language (string) бір тіл үшін немесе 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 Бірнеше мақсаттар үшін (string).

Жауап

{
    "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)

Жауап (жұмыс күтуде - кезекте, графикалық процессорды күтуде)

{
    "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 үшін қайта сұрау. Бастапқы тапсырма әлі де графикалық процессорда өңделуі мүмкін.
• Әрбір 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, екеуі де емес.

Сұраныс (көпбөлік/пішін-деректер)

Қолданатын файл түрлері

Мысал (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"
}

Күй- жай мәндері

Құжаттың аудармасының күй- жайын тексеру немесе жүктеп алу URL- сілтемесін алу.

Жауап

{
    "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"},
        ...
    ]
}