Open topic with navigation

# Display Task Details

To retrieve information about a particular task, including the task schema and available parameters, send a `TaskHelp` action to IDOL Speech Server.

To display information about a task

- Send the `TaskHelp` action to IDOL Speech Server, and set the following parameter:

  `Type` | The task name.

For example:

    http://localhost:15000/action=TaskHelp&Type=SpeechToText

This action returns details about the `SpeechToText` task.

IDOL Speech Server returns task information as plain text. For example:

    Task: speechToText

    ================================================================
    SCHEMA
    ================================================================
    The following table represents the schema that defines the task:

    ----------------------------------------------------------------
    Module          Mode        Inputs      Outputs
    ----------------------------------------------------------------
    audio           MONO        input       a,ts
    frontend        _           a           f
    normalizer      _           f           nf
    stt             _           nf          w
    postproc        _           w           w2
    wout            _           ts,w2       output
    ----------------------------------------------------------------

    For a description of each module, mode, input, and output, refer to the IDOL
    Speech Server Reference.

    ===============================================================
    PARAMETERS
    ================================================================
    You can set the following action parameters for this task:

    --------------------------------------------------------------------------------
    Corresponding
    Action Parameter        Configuration Parameter         Type            Default
    --------------------------------------------------------------------------------
    inputType               audio.inputtype                 string          file
    file                    audio.file                      file
    sugdInputFrequency      audio.sugdinputfrequency        int             0
    sugdInputChannels       audio.sugdinputchannels         string
    startTime               audio.starttime                 real            0.00
    endTime                 audio.endtime                   real            0.
    ................................................................................
    mode                    stt.mode                        string          fixed
    modeValue               stt.modevalue                   real            4
    lang                    stt.lang                        resource        ENUK
    conf                    stt.enableconfidence            bool            true
    dnnScale                stt.dnnscale                    real            0.0
    diag                    stt.diag                        bool            false
    diagFile                stt.diagfile                    file            $outfile
    latFile                 stt.latfile                     file
    latWordFile             stt.latwordfile                 file
    latScale                stt.latscale                    real            0.5
    latWinSize              stt.latwinsize                  int             0
    frameDupl               stt.framedupl                   int             0
    speedBiasLevel          stt.speedbiaslevel              int             0
    ................................................................................
    punctuation             postproc.dopunctuation          bool            false
    wordBar                 postproc.dowordbarring          bool            false
    wordBarList             postproc.barredlist             file
    forceRecompoundOn       postproc.forcerecompoundon      bool            false
    ................................................................................
    out                     wout.output                     file            $outfile
    -------------------------------------------------------------------------------

    Depending on the resources that the task uses, there might be additional
    parameters that are not listed here.

    For a description of each parameter, refer to the IDOL Speech Server Reference.

NOTE:

If a task uses one or more resources, you can sometimes set additional parameters depending on the resource configuration. Sometimes the additional parameters are mandatory. The additional parameters are determined after you have specified the resources for a task, therefore they do not appear in the Parameters table.

Related Topics

- Display Online Help
- Configure Custom Tasks

© 2015-2018 EntIT Software LLC, a Micro Focus company | Send documentation feedback to Micro Focus Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm