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 HPE IDOL Speech Server.

To display information about a task

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

  `Type` | The task name.

For example:

    http://localhost:13000/action=TaskHelp&Type=WavToText

This action uses port `13000` to instruct HPE IDOL Speech Server, which is located on the local machine, to return details about the `WavToText` task.

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

    Task: wavToText

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

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

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

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

    --------------------------------------------------------------------------------
                            Corresponding
    Action Parameter        Configuration Parameter         Type            Default
    --------------------------------------------------------------------------------
    file                    wav.wavfile                     file
    sugdInputFrequency      wav.sugdinputfrequency          int             0
    sugdInputChannels       wav.sugdinputchannels           string
    startTime               wav.starttime                   real            0.00
    endTime                 wav.endtime                     real            0.00
    ................................................................................
    lang                    stt.lang                        resource        ENUK
    diag                    stt.diag                        bool            False
    mode                    stt.mode                        string          fixed
    modeValue               stt.modevalue                   real            4
    conf                    stt.enableconfidence            bool            False
    ................................................................................
    out                     wout.output                     file
    --------------------------------------------------------------------------------

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

    For a description of each parameter, see the HPE 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-2017 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE 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 AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm