Class BhashiniPipelineResponse

Namespace

Uralstech.UBhashini.Data.Pipeline

Response of a BhashiniPipelineRequest.

public class BhashiniPipelineResponse

Inheritance

object

BhashiniPipelineResponse

Fields

InferenceEndpoint

The pipeline's inference endpoint.

public BhashiniPipelineInferenceEndpoint InferenceEndpoint

Field Value

BhashiniPipelineInferenceEndpoint

Remarks

As per the documentation:

This parameter helps the integrator to know the details of the Pipeline Compute Callwhere 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.

https://bhashini.gitbook.io/bhashini-apis/pipeline-config-call/response-payload

PipelineConfigurations

List of available pipeline configurations for the given tasks.

public BhashiniPipelineConfiguration[] PipelineConfigurations

Field Value

BhashiniPipelineConfiguration[]

Remarks

As per the documentation:

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 e.g.
    - Integrator request for configuration of the combination of ASR, Translation
    and TTS together, the pipelineResponseConfig parameter in the output will
    contain the JSON data as shown below. It will contain three dictionaries for
    each task type ASR, Translation and TTS. If Integrator requested for a
    combination of ASR and Translation, this parameter would contain JSON data
    for ASR and Translation only.

https://bhashini.gitbook.io/bhashini-apis/pipeline-config-call/response-payload

SupportedLanguages

The supported languages for the pipeline's tasks.

public BhashiniPipelineSupportedLanguages[] SupportedLanguages

Field Value

BhashiniPipelineSupportedLanguages[]

Remarks

As per the documentation:

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., either ASR or Translation or TTS as shown here:
    https://bhashini.gitbook.io/bhashini-apis/pipeline-config-call/request-payload#integrators-want-to-do-individual-tasks
    - Combination of Tasks in that sequence i.e.,
        - ASR+Translation or
        - Translation+TTS or
        - ASR+Translation+TTS as shown here:
        https://bhashini.gitbook.io/bhashini-apis/pipeline-config-call/request-payload#integrators-want-to-do-combination-of-tasks-in-that-order

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 ASR, the languages appearing shows that Server can do ASR in these languages. In this case, parameters
    sourceLanguage and targetLanguageList will contain the same value since for ASR involves only one language unlike Translation where source
    and target (two) languages are involved. In this case, targetLanguageList can safely be ignored and only sourceLanguage can be used. 

    - If the integrator wants to do only TTS, the languages appearing shows that Server can do TTS in these languages. In this case, parameters
    sourceLanguage and targetLanguageList will contain the same value since for TTS too only one language is involved. In this case too,
    targetLanguageList can safely be ignored and only sourceLanguage can be used.

https://bhashini.gitbook.io/bhashini-apis/pipeline-config-call/response-payload

_speechToTextConfiguration

private BhashiniPipelineConfiguration _speechToTextConfiguration

Field Value

BhashiniPipelineConfiguration

_textToSpeechConfiguration

private BhashiniPipelineConfiguration _textToSpeechConfiguration

Field Value

BhashiniPipelineConfiguration

_translateConfiguration

private BhashiniPipelineConfiguration _translateConfiguration

Field Value

BhashiniPipelineConfiguration

Properties

SpeechToTextConfiguration

Gets the first SpeechToText type BhashiniPipelineConfiguration in PipelineConfigurations.

public BhashiniPipelineConfiguration SpeechToTextConfiguration { get; }

Property Value

BhashiniPipelineConfiguration

TextToSpeechConfiguration

Gets the first TextToSpeech type BhashiniPipelineConfiguration in PipelineConfigurations.

public BhashiniPipelineConfiguration TextToSpeechConfiguration { get; }

Property Value

BhashiniPipelineConfiguration

TranslateConfiguration

Gets the first Translation type BhashiniPipelineConfiguration in PipelineConfigurations.

public BhashiniPipelineConfiguration TranslateConfiguration { get; }

Property Value

BhashiniPipelineConfiguration