Request Payload

This sub-page helps the integrator to understand two different types of request payload, one without any additional configuration parameters, and one with additional configuration parameters.

Without configuration parameters

{
    "pipelineTasks" : [
        
        {
            "taskType": "transliteration"
        }
        
    ],
    "pipelineRequestConfig" : {
        "pipelineId" : "xxxx8d51ae52cxxxxxxxx"
    }
}

Parameters

We will now understand about each parameter available as a part of this payload. taskType

Type: String

• Line 4-6 for Transliteration

pipelineTasks

Type: Array This parameter takes an array of tasks, in the form of dictionary of taskType as defined above, that are to be done by the integrator. The sequence of tasks matter. In the above example, the configuration that will be returned back in the response will be for tasks ASR, Translation and TTS in that order. Each pipelineId (discussed below), may support few individual or task sequences as explained here and here and detailed out below.

pipelineId

Type: String pipelineId takes a string value of the specific pipeline integrator wants to use. The pipeline ID can be obtained either via Pipeline Search Call or via ULCA Web based on the description which helps the integrator to understand what a pipeline can or cannot do. Each pipeline ID may support multiple task and task sequences.

The same has been explained here and here.

pipelineRequestConfig

Type: Dictionary This parameter takes in the configuration requested to do the sequence of tasks defined under parameter pipelineTasks.

With Configuration Parameters

{
    "pipelineTasks": [
        {
            "taskType": "transliteration",
            "config": {
                "language": {
                    "sourceLanguage": "en"
                }
            }
        }
        
    ],
    "pipelineRequestConfig": {
        "pipelineId" : "xxxx8d51ae52cxxxxxxxx"
    }
}

Parameters

Only additional parameter config is detailed out below. Rest of the parameters' understanding remains the same as Without configuration parameters.

config

Type: dictionary config parameter is used for sending configuration parameters to the server for each taskType. Each taskType may have some common parameters such as language and some parameters which are specific to each taskType.

Currently, there are no additional taskType specific parameters. Once added, they will be described here.

config

Transliteration

Type: dictionary

contains: language Type: dictionary contains: sourceLanguage Type: String Source Language will take the ISO-639 code of the language as the input. This parameter will tell the server that integrator wants to receive the information and details about Speech Recognition in this specific language.