You can verify whether HPE IDOL Speech Server has all the necessary resources for a task before you start the task. For example, if you run multiple installations of HPE IDOL Speech Server, you can use the CheckResources
action to check which one can best process a task.
http://host:port/action=CheckResources&Type=task&requiredParams&optionalParams
where:
host
|
is the IP address or name of the machine where HPE IDOL Speech Server is installed. |
port
|
is the ACI port by which actions are sent to HPE IDOL Speech Server (set by the Port parameter in the HPE IDOL Speech Server configuration file's [Server] section). |
task
|
is the name of the configuration section that define the options for the task in the HPE IDOL Speech Server tasks configuration file. |
requiredParams
|
are the parameters that you must supply for the action you request. (Not all tasks have required parameters.) |
optionalParams
|
are the parameters that you can supply for the action you request. (Not all tasks have optional parameters.) |
You must specify all parameters that you want use to perform the task. If you intend to run the task across multiple cores (see Run Tasks Across Multiple Cores), you must set the TaskManagers
parameter.
TaskManagers
|
The number of task managers to split the task across. If you specify more task managers than are available, HPE IDOL Speech Server returns an error. |
You do not need to set the SplitSize
or Overlap
parameters for the CheckResources
action.
The CheckResources
action returns one of the following status messages.
AVAILABLE_LOADED
|
The language pack is already loaded and the server can accept your task. |
AVAILABLE_NOT_LOADED
|
The language pack is either already loaded or the task does not use one, so the server can accept your task. |
NOT_AVAILABLE
|
The server has either reached the maximum number of tasks it can run in parallel or the maximum number of languages it can load. The task is rejected if submitted. |
For example:
http://localhost:13000/action=CheckResources&Type=WavToText&File=Speech.wav&Out=Text.ctm
This action checks the server resources for a HPE IDOL Speech Server on the local machine using ACI port 13000
. It checks resources for the speech-to-text task defined in the [WavToText]
section of the HPE IDOL Speech Server tasks configuration file, on the file Speech.wav
.
If you enabled queuing, the CheckResources
action is not available.
The results of a CheckResources
action might not continue to be valid if you subsequently submit new tasks to the server. In addition, CheckResources
does not consider any pending tasks that might be in the system (that is, tasks that have been submitted using the AddTask
action, but are not yet fully registered with the task tracker). These tasks are shown as PENDING
in the GetStatus
output.
A|fter you submit a task, HPE recommends that you use the GetStatus
action with the task token to check the status of the task. Do not make any calls to CheckResources
for subsequent tasks until the task status changes from PENDING
to STARTING
, RUNNING
, LOADING_LM
, and so on.
|