Bot Ask Name
The bot asks and recognizes names in the text provided by the user.
Starting from IBM RPA 23.0.3, support for Interactive Voice Response (IVR) is removed from this command due to the removal of IVR. For more information, see Removed.
Command availability: IBM RPA SaaS and IBM RPA on premises
Script syntax
IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.
botAskName [--retry(Boolean)] [--attempts(Numeric)] [--retrytext(String)] [--timeoutsub(String)] [--recognitionTimeout(TimeSpan)] [--speechCompleteTimeout(TimeSpan)] [--noInputTimeout(TimeSpan)] [--speechIncompleteTimeout(TimeSpan)] [--confidenceThreshold(Numeric)] [--beep(Boolean)] [--language(Language)] --text(String) [--textformat(String)] [--timeout(TimeSpan)] (String)=utterance (Boolean)=timedout (String)=botHistoryMessageId (List<String>)=values (String)=first (DataTable)=valuesmapping (Boolean)=success
Dependencies
- You must start a Chatbot or IVR instance by using the Connect to Chatbot (
botConnect) command. - This command must be in the Connect to Chatbot scope.
Input parameters
The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.
| Designer mode label | Script mode name | Required | Accepted variable types | Description |
|---|---|---|---|---|
| Retry | retry |
Optional |
Boolean |
Enable to allow the bot to ask a new question if there is no answer on the first try. |
| Attempts | attempts |
Optional |
Number |
Number of times the question from Alternative texts should be repeated. |
| Alternative texts | retrytext |
Optional |
Text |
Alternative question that is asked to the user if there is no answer on the first attempt. |
| Time out subroutine | timeoutsub |
Optional |
Text |
Subroutine that should run if user response time runs out. |
| Recognition timeout | recognitionTimeout |
Optional |
Time Span |
Timeout to acknowledge the user's response |
| Speech complete timeout | speechCompleteTimeout |
Optional |
Time Span |
Maximum time allowed without interaction with the bot after its speech. Starting from IBM RPA 23.0.3, this parameter is removed. |
| No input timeout | noInputTimeout |
Optional |
Time Span |
Maximum waiting time for the user to start the conversation. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Incomplete Speech Timeout | speechIncompleteTimeout |
Optional |
Time Span |
Maximum amount of time to wait for the user to complete the speech. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Confidence Threshold | confidenceThreshold |
Optional |
Number |
Numeric expression that indicates the confidence level for recognizing user response. Confidence rate is in the range 1 - 100. If the obtained value is lower than the specified range, it returns null. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Beep | beep |
Optional |
Boolean |
Enable to play a beep each time that the bot speaks. Starting from IBM RPA 23.0.3, this parameter is removed. |
| Language | language |
Optional |
Language |
Language used for bot communication. Use the Create a Language (createLanguage) command to get the language variable. |
| Text | text |
Required |
Text |
The first question that asks for the user's name. |
| Text Format | textformat |
Optional |
Text, BotTextFormat |
Specifies the text format to send to the chat, either Plain Text or Markdown (default). |
| Timeout | timeout |
Optional |
Time Span, Number, Text |
Timeout for waiting for user response. |
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Utterance | utterance |
Text |
Returns the text provided by the user. |
| Timed out | timedout |
Boolean |
Returns True if the time has run out, otherwise returns False. |
| Message History ID | botHistoryMessageId |
Text |
Identifier for other commands to save their history along with the history of this command. This field returns the identity value of the saved history if one has been set to the Storage Adapter parameter of the Connect to Chatbot ( botConnect) command. To use it, simply add this output to the command specific input parameter of which the history you want to link to this command's
history. |
| Values | values |
List<Text> |
List of names recognized in user-entered text. |
| First | first |
Text |
First name recognized in user-entered text. |
| Values mapping | valuesmapping |
Data Table |
Data table that returns the position of the name in the entered sentence, its length, and the text itself. |
| Success | success |
Boolean |
Returns True if the script runs successfully, otherwise returns False. |
Example
Recognizes names in the sentence "I found Anna and Mary on the way home", entered by the user, and returns the names that were recognized.
defVar --name language --type Language
defVar --name sentence --type String
defVar --name timeOut --type Boolean
defVar --name namesFound --type List --innertype String
defVar --name firstNameFound --type String
defVar --name tableInformation --type DataTable
createLanguage --culture "enUS" language=value
botConnect --type "Chat" --language ${language} --timeout 00:05:00
botAskName --timeoutsub TimeOutSubRoutine --confidenceThreshold 100 --beep--language ${language} --text "Enter a text:" --timeout 00:05:00 sentence=utterance timeOut=timedout namesFound=values firstNameFound=first tableInformation=valuesmapping
botDisconnect
logMessage --message "First Name Found: ${firstNameFound}\r\nValue Mapping: ${tableInformation}\r\nTime\'s up: ${timeOut}\r\nSentence: ${sentence}\r\nNames found: ${namesFound}" --type "Info"
Limitations
-
If the amount of time specified in the Recognition timeout, No input timeout, Speech complete timeout, Incomplete Speech Timeout, and Timeout parameters runs out, the interaction is forwarded to the subroutine specified in the Time out subroutine parameter.
-
The parameters Recognition timeout, No input timeout, Speech complete timeout, Incomplete Speech Timeout, and Beep are specific to the IVR communication type.
-
The Attempts and Alternative texts parameters are available when the Retry parameter is enabled.