Response Payload
Complete Payload
Complete Payload
{
"languages": [
{
"sourceLanguage": "en",
"targetLanguageList": [
"as",
"bn",
"brx",
"gom",
"gu",
"hi",
"kn",
"ks",
"mai",
"ml",
"mni",
"mr",
"ne",
"or",
"pa",
"sa",
"sd",
"si",
"ta",
"te",
"ur"
]
},
{
"sourceLanguage": "as",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "bn",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "brx",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "gom",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "gu",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "hi",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "kn",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ks",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "mai",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ml",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "mni",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "mr",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ne",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "or",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "pa",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "sa",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "sd",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "si",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ta",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "te",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ur",
"targetLanguageList": [
"en"
]
}
],
"pipelineResponseConfig": [
{
"taskType": "transliteration",
"config": [
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0426e74a1c96b489b5441",
"language": {
"sourceLanguage": "en",
"targetLanguage": "as"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7c97d6da5111fca0f5e4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "bn"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0427878d51611abf708c4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "brx"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b3c64fa65d5a242f462655",
"language": {
"sourceLanguage": "en",
"targetLanguage": "gom"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7c7d2abd9b3200b3003b",
"language": {
"sourceLanguage": "en",
"targetLanguage": "gu"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c73ce41dcd012c08f07e3",
"language": {
"sourceLanguage": "en",
"targetLanguage": "hi"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7e662abd9b3200b3003c",
"language": {
"sourceLanguage": "en",
"targetLanguage": "kn"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0429574a1c96b489b5442",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ks"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cafad2abd9b3200b3003f",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mai"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca83c2abd9b3200b3003e",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ml"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0429f78d51611abf708c5",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mni"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c811dd6da5111fca0f5e5",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mr"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042a878d51611abf708c6",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ne"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042b878d51611abf708c7",
"language": {
"sourceLanguage": "en",
"targetLanguage": "or"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca0c52abd9b3200b3003d",
"language": {
"sourceLanguage": "en",
"targetLanguage": "pa"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042c374a1c96b489b5443",
"language": {
"sourceLanguage": "en",
"targetLanguage": "sa"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cab0ed6da5111fca0f5e8",
"language": {
"sourceLanguage": "en",
"targetLanguage": "sd"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cad21d6da5111fca0f5e9",
"language": {
"sourceLanguage": "en",
"targetLanguage": "si"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c741941dcd012c08f07e4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ta"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca307d6da5111fca0f5e6",
"language": {
"sourceLanguage": "en",
"targetLanguage": "te"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca3e8d6da5111fca0f5e7",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ur"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e599dd811234cfe86bb",
"language": {
"sourceLanguage": "as",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513eae9dd811234cfe86c3",
"language": {
"sourceLanguage": "bn",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e949dd811234cfe86c1",
"language": {
"sourceLanguage": "brx",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e3d9dd811234cfe86b8",
"language": {
"sourceLanguage": "gom",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513eb5610f2c0e43eeb476",
"language": {
"sourceLanguage": "gu",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513d39610f2c0e43eeb46e",
"language": {
"sourceLanguage": "hi",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e7d9dd811234cfe86c0",
"language": {
"sourceLanguage": "kn",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e4e610f2c0e43eeb471",
"language": {
"sourceLanguage": "ks",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e6c9dd811234cfe86be",
"language": {
"sourceLanguage": "mai",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e549dd811234cfe86ba",
"language": {
"sourceLanguage": "ml",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e84610f2c0e43eeb473",
"language": {
"sourceLanguage": "mni",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e71610f2c0e43eeb472",
"language": {
"sourceLanguage": "mr",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e5f9dd811234cfe86bc",
"language": {
"sourceLanguage": "ne",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e779dd811234cfe86bf",
"language": {
"sourceLanguage": "or",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e659dd811234cfe86bd",
"language": {
"sourceLanguage": "pa",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e43610f2c0e43eeb470",
"language": {
"sourceLanguage": "sa",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e489dd811234cfe86b9",
"language": {
"sourceLanguage": "sd",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e9d9dd811234cfe86c2",
"language": {
"sourceLanguage": "si",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e36610f2c0e43eeb46f",
"language": {
"sourceLanguage": "ta",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513ea6610f2c0e43eeb475",
"language": {
"sourceLanguage": "te",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e8c610f2c0e43eeb474",
"language": {
"sourceLanguage": "ur",
"targetLanguage": "en"
}
}
]
}
],
"feedbackUrl": "https://dhruva-api.bhashini.gov.in/services/feedback/submit",
"pipelineInferenceAPIEndPoint": {
"callbackUrl": "https://dhruva-api.bhashini.gov.in/services/inference/pipeline",
"inferenceApiKey": {
"name": "Authorization",
"value": "gQNj-sTUJjdkac_hsmJLRlj9DeJzO6Q2qzW5SrshxQAwU635MyHXyAajtExDykfZ"
},
"isMultilingualEnabled": true,
"isSyncApi": true
},
"pipelineInferenceSocketEndPoint": {
"callbackUrl": "wss://dhruva-api.bhashini.gov.in",
"inferenceApiKey": {
"name": "Authorization",
"value": "gQNj-sTUJjdkac_hsmJLRlj9DeJzO6Q2qzW5SrshxQAwU635MyHXyAajtExDykfZ"
},
"isMultilingualEnabled": true,
"isSyncApi": true
}
}
Complete Payload shows the JSON structure of the content that is received when Integrator makes a ULCA Config Call without any configuration details as detailed in Tab 1
of Request Payload
This response contains 3 major parameters listed below and detailed further down the section:
Parameter: languages
languages
This parameter helps integrator to know what languages are available that can be used for the requested pipeline tasks in that sequence. For example, consider scenarios where Integrator requests for either:
Individual Task i.e., Transliteration here
For Single Tasks, the understanding is straight-forward that the languages appearing in the response corresponds to that task. e.g.
If the integrator wants to do
only Transliteration
, the languages appearing shows that Server can doTransliteration
in these languages. In this case, parameterssourceLanguage
andtargetLanguageList
means that for the languages appearing intargetLanguageList
are the ones in which Server can do translation FROM the language that appear insourceLanguage
.
Usual format of language for such cases is below:
Supported Languages for requested Pipeline.
"languages": [
{
"sourceLanguage": "en",
"targetLanguageList": [
"as",
"bn",
"brx",
"gom",
"gu",
"hi",
"kn",
"ks",
"mai",
"ml",
"mni",
"mr",
"ne",
"or",
"pa",
"sa",
"sd",
"si",
"ta",
"te",
"ur"
]
},
{
"sourceLanguage": "as",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "bn",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "brx",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "gom",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "gu",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "hi",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "kn",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ks",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "mai",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ml",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "mni",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "mr",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ne",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "or",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "pa",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "sa",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "sd",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "si",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ta",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "te",
"targetLanguageList": [
"en"
]
},
{
"sourceLanguage": "ur",
"targetLanguageList": [
"en"
]
}
]
Parameter: pipelineResponseConfig
pipelineResponseConfig
This parameter helps the integrator to obtain the Service ID
for a particular task type and language(s) associated with that task.
The task types appearing here will be the same as the ones that the integrator requested while sending the pipelineTasks
parameter in Request Payload
Say the language pair chosen is Bengali
to Assamese
.
Integrator shall now obtain the Service ID correspondingly in the below manner:
Obtain Service ID for doing
ASR
inBengali
. Line 6 from Dictionary of Line 5-14 below.Obtain Service ID for doing
Translation
fromBengali
toAssamese
. Line 49 from Dictionary of Line 48-55 below.Obtain Service ID for doing
TTS
inAssamese
. Line 89 from Dictionary of Line 88-98 below.
These Service IDs will be used in the Transliteration Compute Call.
For each taskType
in the response, there may appear additional configuration parameters that are specific to each taskType.
Configuration Details and Service IDs for requested pipeline tasks.
"pipelineResponseConfig": [
{
"taskType": "transliteration",
"config": [
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0426e74a1c96b489b5441",
"language": {
"sourceLanguage": "en",
"targetLanguage": "as"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7c97d6da5111fca0f5e4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "bn"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0427878d51611abf708c4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "brx"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b3c64fa65d5a242f462655",
"language": {
"sourceLanguage": "en",
"targetLanguage": "gom"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7c7d2abd9b3200b3003b",
"language": {
"sourceLanguage": "en",
"targetLanguage": "gu"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c73ce41dcd012c08f07e3",
"language": {
"sourceLanguage": "en",
"targetLanguage": "hi"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7e662abd9b3200b3003c",
"language": {
"sourceLanguage": "en",
"targetLanguage": "kn"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0429574a1c96b489b5442",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ks"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cafad2abd9b3200b3003f",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mai"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca83c2abd9b3200b3003e",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ml"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0429f78d51611abf708c5",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mni"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c811dd6da5111fca0f5e5",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mr"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042a878d51611abf708c6",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ne"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042b878d51611abf708c7",
"language": {
"sourceLanguage": "en",
"targetLanguage": "or"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca0c52abd9b3200b3003d",
"language": {
"sourceLanguage": "en",
"targetLanguage": "pa"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042c374a1c96b489b5443",
"language": {
"sourceLanguage": "en",
"targetLanguage": "sa"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cab0ed6da5111fca0f5e8",
"language": {
"sourceLanguage": "en",
"targetLanguage": "sd"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cad21d6da5111fca0f5e9",
"language": {
"sourceLanguage": "en",
"targetLanguage": "si"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c741941dcd012c08f07e4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ta"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca307d6da5111fca0f5e6",
"language": {
"sourceLanguage": "en",
"targetLanguage": "te"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca3e8d6da5111fca0f5e7",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ur"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e599dd811234cfe86bb",
"language": {
"sourceLanguage": "as",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513eae9dd811234cfe86c3",
"language": {
"sourceLanguage": "bn",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e949dd811234cfe86c1",
"language": {
"sourceLanguage": "brx",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e3d9dd811234cfe86b8",
"language": {
"sourceLanguage": "gom",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513eb5610f2c0e43eeb476",
"language": {
"sourceLanguage": "gu",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513d39610f2c0e43eeb46e",
"language": {
"sourceLanguage": "hi",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e7d9dd811234cfe86c0",
"language": {
"sourceLanguage": "kn",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e4e610f2c0e43eeb471",
"language": {
"sourceLanguage": "ks",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e6c9dd811234cfe86be",
"language": {
"sourceLanguage": "mai",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e549dd811234cfe86ba",
"language": {
"sourceLanguage": "ml",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e84610f2c0e43eeb473",
"language": {
"sourceLanguage": "mni",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e71610f2c0e43eeb472",
"language": {
"sourceLanguage": "mr",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e5f9dd811234cfe86bc",
"language": {
"sourceLanguage": "ne",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e779dd811234cfe86bf",
"language": {
"sourceLanguage": "or",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e659dd811234cfe86bd",
"language": {
"sourceLanguage": "pa",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e43610f2c0e43eeb470",
"language": {
"sourceLanguage": "sa",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e489dd811234cfe86b9",
"language": {
"sourceLanguage": "sd",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e9d9dd811234cfe86c2",
"language": {
"sourceLanguage": "si",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e36610f2c0e43eeb46f",
"language": {
"sourceLanguage": "ta",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513ea6610f2c0e43eeb475",
"language": {
"sourceLanguage": "te",
"targetLanguage": "en"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "63513e8c610f2c0e43eeb474",
"language": {
"sourceLanguage": "ur",
"targetLanguage": "en"
}
}
]
}
],
Parameter: pipelineInferenceAPIEndPoint
pipelineInferenceAPIEndPoint
This parameter helps the integrator to know the details of the Transliteration Compute Call. where to send (callbackURL
parameter) and shall be sent along with the Authorization Key-Value pair
received under inferenceApiKey
parameter which will be used for authentication of the same.
Complete Payload
Complete Payload
{
"languages": [
{
"sourceLanguage": "en",
"targetLanguageList": [
"as",
"bn",
"brx",
"gom",
"gu",
"hi",
"kn",
"ks",
"mai",
"ml",
"mni",
"mr",
"ne",
"or",
"pa",
"sa",
"sd",
"si",
"ta",
"te",
"ur"
]
}
],
"pipelineResponseConfig": [
{
"taskType": "transliteration",
"config": [
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0426e74a1c96b489b5441",
"language": {
"sourceLanguage": "en",
"targetLanguage": "as"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7c97d6da5111fca0f5e4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "bn"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0427878d51611abf708c4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "brx"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b3c64fa65d5a242f462655",
"language": {
"sourceLanguage": "en",
"targetLanguage": "gom"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7c7d2abd9b3200b3003b",
"language": {
"sourceLanguage": "en",
"targetLanguage": "gu"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c73ce41dcd012c08f07e3",
"language": {
"sourceLanguage": "en",
"targetLanguage": "hi"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c7e662abd9b3200b3003c",
"language": {
"sourceLanguage": "en",
"targetLanguage": "kn"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0429574a1c96b489b5442",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ks"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cafad2abd9b3200b3003f",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mai"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca83c2abd9b3200b3003e",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ml"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b0429f78d51611abf708c5",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mni"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c811dd6da5111fca0f5e5",
"language": {
"sourceLanguage": "en",
"targetLanguage": "mr"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042a878d51611abf708c6",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ne"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042b878d51611abf708c7",
"language": {
"sourceLanguage": "en",
"targetLanguage": "or"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca0c52abd9b3200b3003d",
"language": {
"sourceLanguage": "en",
"targetLanguage": "pa"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "62b042c374a1c96b489b5443",
"language": {
"sourceLanguage": "en",
"targetLanguage": "sa"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cab0ed6da5111fca0f5e8",
"language": {
"sourceLanguage": "en",
"targetLanguage": "sd"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628cad21d6da5111fca0f5e9",
"language": {
"sourceLanguage": "en",
"targetLanguage": "si"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628c741941dcd012c08f07e4",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ta"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca307d6da5111fca0f5e6",
"language": {
"sourceLanguage": "en",
"targetLanguage": "te"
}
},
{
"serviceId": "ai4bharat/indicxlit--cpu-fsv2",
"modelId": "628ca3e8d6da5111fca0f5e7",
"language": {
"sourceLanguage": "en",
"targetLanguage": "ur"
}
}
]
}
],
"feedbackUrl": "https://dhruva-api.bhashini.gov.in/services/feedback/submit",
"pipelineInferenceAPIEndPoint": {
"callbackUrl": "https://dhruva-api.bhashini.gov.in/services/inference/pipeline",
"inferenceApiKey": {
"name": "Authorization",
"value": "gQNj-sTUJjdkac_hsmJLRlj9DeJzO6Q2qzW5SrshxQAwU635MyHXyAajtExDykfZ"
},
"isMultilingualEnabled": true,
"isSyncApi": true
},
"pipelineInferenceSocketEndPoint": {
"callbackUrl": "wss://dhruva-api.bhashini.gov.in",
"inferenceApiKey": {
"name": "Authorization",
"value": "gQNj-sTUJjdkac_hsmJLRlj9DeJzO6Q2qzW5SrshxQAwU635MyHXyAajtExDykfZ"
},
"isMultilingualEnabled": true,
"isSyncApi": true
}
}
Complete Payload shows the JSON structure of the content that is received when Integrator makes a ULCA Config Call with some configuration details as detailed in Tab 2
of Request Payload. Here, the integrator has requested to do a tasks Transliteration in that sequence from English
Parameter: languages
languages
The understanding of the parameters remains same as in previous tab. Since the languages were already known to the integrator before-hand, therefore, the response contains configuration details for those languages only.
There may occur a possibility that Integrator wants to do any individual task or combination of tasks in a sequence for the languages that are not
supported by that pipeline ID
in which case the following response will be obtained:
Response Code: 400 Bad Request
Response Body:
{
"code": "400 BAD_REQUEST",
"message": "Sequence of languages not supported",
"timestamp": "2023-04-14T06:32:12.133+00:00"
}
In such cases, it is recommended to send Pipeline Config Request without Configuration as shown in Tab 1
under Request Payload
Using which Integrators will know what all languages are supported by that pipeline ID.
Parameter: pipelineResponseConfig
pipelineResponseConfig
The understanding of the parameters remains same as in previous tab. Since the languages were already known to the integrator before-hand, therefore, the response contains configuration details for those languages only.
Parameter: pipelineInferenceAPIEndPoint
pipelineInferenceAPIEndPoint
The understanding of the parameters remains same as in previous tab.
Last updated