Open topic with navigation

# GetStatus

Returns the following details about the IDOL Speech Server setup, resource types, and resource usage (provided they have been configured):

`version` | The version of IDOL Speech Server.
`servicePort` | The port to send service actions to.
`binaryDataPort` | The port to send a binary data stream to.
`baseconfigpath` | The path to the base configuration file that IDOL Speech Server uses.
`tasksconfigpath` | The path to the tasks configuration file that IDOL Speech Server uses.
Resources
`maxLangResources` | The maximum number of language packs that IDOL Speech Server can load concurrently.
`maxAfpResources` | The maximum number of AFP resources that IDOL Speech Server can load concurrently.
`maxSidResources` | The maximum number of speaker identification resources that IDOL Speech Server can load concurrently.
`totalLoaded` | The total number of resources loaded.
`totalActive` | The total number of active resources.
`langsLoaded` | The number of language packs loaded.
`langsActive` | The number of active language packs.
`afpLoaded` | The number of AFP resources loaded.
`afpActive` | The number of active AFP resources.
`sidLoaded` | The number of speaker identification resources loaded.
`sidActive` | The number of active speaker identification resources.
For each loaded resource
`id` | A unique ID for the resource.
`type` | The type of resource.
`active` | Whether the loaded resource is active.
`name` | The name of the loaded resource.
`lang` | For `lang` and `langvt` resource types, the language of the loaded resource.
`sampleRate` | The sample rate of the audio that the resource can process.
`hasCustomLm` | Whether the resource uses a custom language model.
`classWordFile` | Whether the resource has a class word file.
`pronFile` | Whether the resource has a pronunciation file.
`manualLoad` | Whether the resource pack was loaded manually. If `True`, you must manually unload the language when it is no longer required.
`manualLoadParams` | For manually loaded resources, this option specifies the parameters that were used to load the resource.
`lmString` | The language models and their weights.
`amName` | The acoustic model.
`dctName` | The dictionary file.
`ianName` | The normalization file.
`dnnNameStd` | The name of the standard Deep Neural Network acoustic modeling file used for speech-to-text. NOTE: By default, speech-to-text uses `dnnNameStd` if fixed beam is used.
`dnnNameFast` | The name of the smaller DNN file used for speech-to-text in relative mode. NOTE: Speech-to-text uses `dnnNameFast` when running in relative or realtime mode.
`dnnNamevFast` | The name of the smallest and fastest DNN file used for speech-to-text in relative mode.
`dnnNameUser` | If set, the name of a user-specified DNN file.
For language model in resources (lm section)
`name` | The name of the language model.
`lmFile` | The file name of the language model file.
`build_label` | The build label of the language model.
`custom` | Whether the language model is a custom or standard language model.
`weight` | The weight of the language model.
Tasks |
`maxTasks` | The maximum number of tasks that IDOL Speech Server can process concurrently.
`running` | The number of tasks that are currently running.
`queued` | The number of tasks that are queued.
For each task |
`token` | A unique ID for the task.
`category` | The task category–either `STANDARD`, `MULTICORE` or `LM_LOAD`. `STANDARD`. Any task defined in the configuration file and run on a single task manager. `MULTICORE`. Any task defined in the configuration file but split across multiple cores. NOTE: Only some tasks can run across multiple cores. For more information, see the IDOL Speech Server Administration Guide. `LM_LOAD`. A language loading task.
`type` | The task name.
`params` | The parameters and their values for a task.
`nwarnings` | The total number of warnings generated by the task, regardless of any limit on the number of individual warnings that you set in the `MaxWarnings` parameter.
`maxwarnings` | The maximum number of individual warnings to display.
`warnings` | The warnings generated by the task. If there are no warnings, this field is omitted from the response. Each individual warning shows the index of each warning compared to the total number of warnings, and the date and time that the warning was generated. For example:
    <warnings>
        <warning>
            <index>1</index>
            <message>[ivdevel] No positive examples for template Brown</message>
            <time>14/01/2017 15:45:20</time>
        </warning>
        <warning>
            <index>2</index>
            <message>[ivdevel] No development scores found for template [Smith] – threshold not set</message>
            <time>14/01/2017 15:45:20</time>
        </warning>
    </warnings>
`nsubtasks` | The number of subtasks that a `MULTICORE` task is divided into. Each subtask is performed by a separate task manager. `STANDARD` and `LM_LOAD` tasks are not divided into subtasks, so the `nsubtasks` value for these tasks is always `-1`.
`status` | The task status.
`lang` | The ID of the resource that the task uses.
`secondsRun` | The number of seconds since the task was initialized.
`processingStart` | The progress in seconds of the least advanced module.
`processingEnd` | The progress in seconds of the furthest advanced module.
`nfiles` | In the `<outputFiles>` section, the number of output files associated with the task.
`label` | In the `<outputFile>` section, the label that you can use to retrieve the output file.
`filename` | In the `<outputFile>` section, the name of the output file.

## Example

    http://12.3.4.56:9000/action=GetStatus

This action uses port `9000` to request details about a component, which is located on a machine with the IP address `12.3.4.56`.

## Parameters

Parameter | Description | Required
--- | --- | ---
Brief | Whether to display concise or full information in the response. |
OutputEncoding | The encoding to use for the action output. |
ShowModules | Whether to return module licensing and usage information. |
ShowQueue | Whether to return the task queue (applies only if queuing is enabled). |
Token | The token returned by an action. |

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

© 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