Domain Documentation
Introduction
This document outlines the different domains supported for transliteration. Each domain is designed for specific content types, ensuring accurate and contextual transliteration between languages. The domain system enables the transliteration of various categories such as names, financial terms, locations, and more, ensuring higher precision and relevance depending on the type of text.
How to Use Domains
When submitting content for transliteration, select the appropriate domain based on the type of text to ensure the best results. Below is a detailed list of available domains, their IDs, names, and specific descriptions to guide you in choosing the right one.
API Integration
To integrate these domains into your system, use the following domain IDs when sending data for transliteration:
- Domain ID 1 for generic content.
- Domain ID 2 for names.
- Domain ID 4 for English text.
- Domain ID 5 for cricketer names.
- Domain ID 6 for banking-related terminology.
- Domain ID 7 for brand and product names.
- Domain ID 9 for addresses and locations.
Domain Details
Domain ID | Domain Name | Description |
---|---|---|
1 | Default | Domain ID 1 will transliterate generic content irrespective of domain. |
2 | Names | Use domain ID 2 to transliterate the people’s names. |
4 | OnlyEnglish | The domain developed to transliterate the source content from the English script to the Indic language script. |
5 | Cricketers | The domain developed to transliterate the names of cricket players. It will efficiently transliterate foreign people’s names. |
6 | Banking | The Banking domain will transliterate the banking and financial terminologies accurately. |
7 | Brands | The domain is specially designed to transliterate the Brand & product catalog. |
9 | Addresses | Domain developed to transliterate location details like street name, city name, state, etc. |
Domain Usage Guide
Default Domain (Domain ID 1)
- Description: This is the general-purpose domain for transliteration, which works well for generic text, news articles, or any content that doesn't fall into a specific category.
- Use case: For blogs, articles, and news where the content covers a broad range of topics.
- Example API Request:
{ "text": "This is a generic example.", "domainID": 1 }
Names Domain (Domain ID 2)
- Description: Use this domain when transliterating people's names. It will maintain the original phonetics as closely as possible.
- Use case: Transliterate people's names in documents, registration forms, etc.
- Example API Request:
{ "text": "John Doe", "domainID": 2 }
OnlyEnglish Domain (Domain ID 4)
- Description: This domain transliterates text from the English script into the Indic language script.
- Use case: When you need to convert English text into local languages.
- Example API Request:
{ "text": "Welcome to the platform", "domainID": 4 }
Cricketers Domain (Domain ID 5)
- Description: Developed to transliterate the names of cricket players, including foreign names.
- Use case: Transliterate names of cricketers in news articles, sports magazines, or player databases.
- Example API Request:
{ "text": "Sachin Tendulkar", "domainID": 5 }
Banking Domain (Domain ID 6)
- Description: Tailored for banking and financial terminologies, ensuring accurate context-specific transliteration.
- Use case: Financial reports, banking documents, and industry-related terminologies.
- Example API Request:
{ "text": "Interest Rate, Loan Agreement", "domainID": 6 }
Brands Domain (Domain ID 7)
- Description: This domain is designed to handle brand names and product catalogs, ensuring the identity and uniqueness of brand names are preserved during transliteration.
- Use case: Product catalogs, brand listings, and marketing materials.
- Example API Request:
{ "text": "Nike, Adidas", "domainID": 7 }
Addresses Domain (Domain ID 9)
- Description: Designed for translating address information like street names, cities, and states.
- Use case: Address forms, location databases, and maps.
- Example API Request:
{ "text": "221B Baker Street, London", "domainID": 9 }
Best Practices
- Always choose the domain that best matches your content type to ensure the most accurate transliteration.
- For general content that does not fit into a specific category, use Domain ID 1.
- For specialized cases, such as financial or address information, use the corresponding domain IDs (e.g., Domain ID 6 for banking, Domain ID 9 for addresses).
Frequently Asked Questions
1. Can I use multiple domain IDs in one API request?
No, only one domain ID can be used per request. However, you can make multiple requests with different domain IDs as needed.
2. What happens if I don’t specify a domain?
If no domain is specified, the default Domain ID 1 will be used for transliteration.
3. How can I test the domains?
You can send a test request using our API with sample text to see how each domain affects the transliteration output.
For more information on integrating these domains or if you need help choosing the right domain, please refer to our API Documentation or contact our support team.