domainThe Domain refers to the universe in which you use the Transliteration API. Example- Health Care, Insurance, Legal, etc. Refer to Supporting Domain to see the available domains.
For Example :
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'cnt_lang: en' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["Reverie Language Technologies ltd website address is www.reverieinc.com"], }'
cnt_langThe language of the words in the input text. Example -“data”: “Singh Sahab aap Kahan the.” In the example above, the Hindi language words are written in the English language script (Roman Script). So cnt_lang = “hi” This is an optional parameter. If no value is provided, by default the value is the same as src_lang.
For Example :
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'cnt_lang: en' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["Reverie Language Technologies ltd website address is www.reverieinc.com"], }' isBulkSpecify whether the API should initially search in the Exception DB to transliterate the input text. Note: By default, the isBulk= true and will not search in the Exception DB.
For Example :
isBulk = true
isBulk = false
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["Reverie Language Technologies ltd website address is www.reverieinc.com"], "isBulk" :true, }'
noOfSuggestionsMention the number of transliteration suggestions the API should return for the input text. Note: By default, the noOfSuggestions = 1, means the API will return only one transliteration suggestion for the input string.
For Example :
noOfSuggestions = 1
noOfSuggestions = 2
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["Rama"], "noOfSuggestions" :1, }'
Response
noOfSuggestions = 1
noOfSuggestions = 2
{ "responseList" : [ { "inString" : "Rama" , "outString" : [ "रामा" ], "status" : 2 } ] }
abbreviateThe abbreviate will Validate whether any Abbreviations/ Acronyms are passed in the input text and will transliterate it accurately. Note - By default, the abbreviate = true. Note - if the value is false, the API will consider the abbreviation as a word and transliterate it to the nearest available word. Note - In the input text, pass the abbreviations in upper case.
For Example :
abbreviate = true
abbreviate = false
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["Rama"], "abbreviate" :true, }'
convertNumberSpecify whether to convert the numbers in the input text to the target language script based on the value type.
Three types of values for this parameter:
local: This value can convert the input number to the target language script.Source String Target String 2020.04 २०२०.०४
words: This value can convert numbers into words with respect to the target language.Source String Target String 505 पांच सौ पांच
roman: This value can convert Roman numbers to English numbers.
If the user types sector V in English, the transliteration would be सेक्टर 5 in Hindi.
Block II will be transliterated as ब्लॉक 2.
For Example :
convertNumber = local
convertNumber = words
convertNumber = roman
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["2020.04"], "convertNumber" : "local", }'
Response
convertNumber = local
convertNumber = words
convertNumber = roman
{ "responseList" : [ { "inString" : "2020.04" , "outString" : [ "२०२०.०४" ], "status" : 2 } ] }
ignoreTaggedEntitiesSpecify whether you want to retain the entities like email ID and URL in the input script. Note: By default, the ignoreTaggedEntities = true and will transliterate the email ID and URL into the target language script.
For Example :
ignoreTaggedEntities = true
ignoreTaggedEntities = false
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["Check product details in www.reverieinc.com"], "ignoreTaggedEntities" :true, }'
Response
ignoreTaggedEntities = true
ignoreTaggedEntities = false
{ "responseList" : [ { "inString" : "Check product details in www.reverieinc.com" , "outString" : [ "चेक प्रोडक्ट डिटेल्स इन डब्ल्युडब्ल्युडब्ल्यु.रेवरीइंक.कॉम" ], "status" : 2 } ] }
convertOrdinalThis is used for transliterating ordinal values to English numbers. Note - Default value = False
For Example :
convertOrdinal = true
convertOrdinal = false
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["15th Main"], "convertOrdinal" :true, }'
Response
convertOrdinal = true
convertOrdinal = false
{ "responseList" : [ { "inString" : "15th Main" , "outString" : [ "15 मेन" ], "status" : 2 } ] }
abbreviationWithoutDotThis is used to produce the abbreviation output without a dot. Note - Default value = False
For Example :
abbreviationWithoutDot = true
abbreviationWithoutDot = false
curl --location --request POST 'https://revapi.reverieinc.com/' \ --header 'Content-Type: application/json' \ --header 'REV-API-KEY: <YOUR API-KEY>' \ --header 'REV-APP-ID: <YOUR APP-ID>' \ --header 'src_lang: en' \ --header 'tgt_lang: hi' \ --header 'domain: generic' \ --header 'REV-APPNAME: transliteration' \ --header 'REV-APPVERSION: 2.0' \ --data-raw '{"data": ["SMS"], "abbreviationWithoutDot" :true, }'
Response
abbreviationWithoutDot = true
abbreviationWithoutDot = false
{ "responseList" : [ { "inString" : "SMS" , "outString" : [ "एसएमएस" ], "status" : 2 } ] }
