Text Translation | Endpoints | Openai Api Tutorial

Introduction

Text translation using the OpenAI API allows you to translate text from one language to another seamlessly. This tutorial covers how to use the text translation endpoint effectively, its parameters, and examples in JavaScript and Python.

Endpoint Overview

The text translation endpoint enables you to translate text between different languages using advanced AI models.

Using the Text Translation Endpoint

API Request

To use the text translation endpoint, send a POST request to the endpoint URL with your API key and the text to translate.

POST /v1/engines/davinci-codex/translate HTTP/1.1
Host: api.openai.com
Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

{
    "model": "davinci-codex",
    "text": "Hello, how are you?",
    "target_language": "es"
}

In this example, a text in English is translated into Spanish using the "davinci-codex" model.

API Response

The API responds with the translated text based on the provided input.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "translation": "Hola, ¿cómo estás?"
}

The translated text is returned in the JSON response under the "translation" field.

Parameters

Here are some common parameters you can use with the text translation endpoint:

text: The text to translate.
model: The model to use for translation (e.g., "davinci-codex").
target_language: The target language code (e.g., "es" for Spanish).

Examples in JavaScript

Here's how you can use the text translation endpoint in JavaScript:

const axios = require('axios');

const apiKey = 'YOUR_API_KEY';
const endpoint = 'https://api.openai.com/v1/engines/davinci-codex/translate';

async function getTextTranslation(text, targetLanguage) {
    try {
        const response = await axios.post(endpoint, {
            model: 'davinci-codex',
            text: text,
            target_language: targetLanguage
        }, {
            headers: {
                'Content-Type': 'application/json',
                'Authorization': `Bearer ${apiKey}`
            }
        });

        console.log(response.data.translation);
    } catch (error) {
        console.error('Error:', error);
    }
}

getTextTranslation('Hello, how are you?', 'es');

Examples in Python

Here's how you can use the text translation endpoint in Python:

import requests
import json

api_key = 'YOUR_API_KEY'
endpoint = 'https://api.openai.com/v1/engines/davinci-codex/translate'

def get_text_translation(text, target_language):
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {api_key}'
    }
    data = {
        'model': 'davinci-codex',
        'text': text,
        'target_language': target_language
    }

    response = requests.post(endpoint, headers=headers, data=json.dumps(data))
    if response.status_code == 200:
        translation = response.json()['translation']
        print(translation)
    else:
        print(f"Error: {response.status_code}, {response.text}")

get_text_translation('Hello, how are you?', 'es');

Conclusion

The text translation endpoint in the OpenAI API provides an efficient way to translate text between languages. By understanding its usage, parameters, and seeing examples in JavaScript and Python, you can integrate text translation capabilities effectively into various applications.

Text Translation using OpenAI API