Skip to main content

Python package for Indian language translation using AI4Bharat's IndicTrans2 API

Project description

indictrans2-ai4bharat

A Python package for Indian language translation using AI4Bharat's IndicTrans2 API service. This package provides an easy-to-use interface for translating text between English and various Indian languages, with automatic language detection.

Acknowledgment

This package uses the IndicTrans2 translation service provided by AI4Bharat. All translation capabilities are powered by AI4Bharat's API. Visit AI4Bharat's website for more information about their services.

Features

  • Support for 23 Indian languages
  • Automatic language detection
  • Language information utilities
  • User agent rotation to avoid rate limits
  • Automatic session refresh
  • Retry mechanism for failed requests
  • Error handling and input validation
  • Easy to integrate into existing projects

Installation

You can install the package using pip:

pip install indictrans2-ai4bharat

Or install from source:

git clone https://github.com/yourusername/indictrans2-ai4bharat
cd indictrans2-ai4bharat
pip install -e .

Quick Start

from indictrans2 import IndicTranslator

# Create translator instance
translator = IndicTranslator()

# Auto-detect language and translate
text = "नमस्ते, कैसे हैं आप?"
translation = translator.translate(text, target_lang="en")
print(translation)  # Output: Hello, how are you?

# Get language information
languages = translator.get_supported_languages()
print(languages)

Language Detection and Information

# Detect language
text = "வணக்கம், எப்படி இருக்கிறீர்கள்?"
detected = translator.detect_language(text)
print(detected)  # Output: ta

# Get language name
lang_name = translator.get_language_name("ta")
print(lang_name)  # Output: Tamil

# Get confidence scores
confidence = translator.detect_language_confidence(text)
for lang, score in confidence:
    print(f"{lang}: {score:.2%}")

# Get language code from name
code = translator.get_language_code("Hindi")
print(code)  # Output: hi

# List all supported languages
codes = translator.get_supported_language_codes()
names = translator.get_supported_language_names()

Advanced Translation

# Create translator with custom settings
translator = IndicTranslator(
    max_retries=3,              # Number of retries for failed requests
    session_refresh_interval=3600  # Refresh session every hour
)

# Batch translation with auto-detection
texts = [
    "Hello world!",
    "नमस्ते दुनिया!",
    "வணக்கம் உலகம்!"
]

for text in texts:
    # Source language will be auto-detected
    translation = translator.translate(text, target_lang="hi")
    print(f"Original: {text}")
    print(f"Hindi: {translation}\n")

Supported Languages

Language Code Language Code
Assamese as Malayalam ml
Bengali bn Manipuri mni
Bodo brx Marathi mr
Dogri doi Nepali ne
English en Odia or
Gujarati gu Punjabi pa
Hindi hi Sanskrit sa
Kannada kn Santali sat
Kashmiri ks Sindhi sd
Konkani kok Tamil ta
Maithili mai Telugu te
Urdu ur

API Reference

IndicTranslator

class IndicTranslator:
    def translate(self, text, target_lang, source_lang=None):
        """
        Translate text with optional auto-detection
        
        Args:
            text: Text to translate
            target_lang: Target language code
            source_lang: Source language code (if None, will be auto-detected)
            
        Returns:
            Translated text if successful, None otherwise
        """
    
    def detect_language(self, text):
        """
        Detect the language of input text
        
        Returns:
            Detected language code
        """
    
    def detect_language_confidence(self, text):
        """
        Detect language with confidence scores
        
        Returns:
            List of (language_code, confidence_score) tuples
        """
    
    def get_language_name(self, lang_code):
        """Get language name from code"""
    
    def get_language_code(self, language_name):
        """Get language code from name"""
    
    def get_supported_languages(self):
        """Get dictionary of supported languages"""
    
    def get_supported_language_codes(self):
        """Get list of supported language codes"""
    
    def get_supported_language_names(self):
        """Get list of supported language names"""

Examples

See the examples directory for more detailed examples:

  • basic_translation.py: Basic translation usage
  • batch_translation.py: Batch translation with rate limit handling
  • language_detection.py: Language detection and information features

Contributing

Contributions are welcome! Please feel free to submit pull requests.

License

This package is licensed under the MIT License - see the LICENSE file for details.

Disclaimer

This is an unofficial package that uses AI4Bharat's IndicTrans2 API service. Users must ensure their usage complies with AI4Bharat's terms of service and guidelines. This package is not affiliated with or endorsed by AI4Bharat.

Credits

Translation service provided by AI4Bharat.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

indictrans2_ai4bharat-0.1.0.tar.gz (11.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

indictrans2_ai4bharat-0.1.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file indictrans2_ai4bharat-0.1.0.tar.gz.

File metadata

  • Download URL: indictrans2_ai4bharat-0.1.0.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for indictrans2_ai4bharat-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f36a22649b5f3111b1276713dd36335a722130d23feed3682aa8e3d8fb7f7d33
MD5 2cf6aa4e3e18c63ebb0b5b896b602a77
BLAKE2b-256 486306d4d18e290573721e77520190b65e702ff61743469924435db2333b578a

See more details on using hashes here.

File details

Details for the file indictrans2_ai4bharat-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for indictrans2_ai4bharat-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f059635f0d7438de60c710460a3e397a497f95eab935fd7be9336d7688e310a3
MD5 41f249ca56fd53f158f4170baa43f9a4
BLAKE2b-256 9436a65a94c287ffd1260f5f6eb960a25aa8a76c746687b5f3d41c5a135fea70

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page