Capture basic text input from the user. The ask component is the simplest
type of input component in the Meya SDK and simply display's a text message
to the user, and waits for input from the user.
ask What is your name?
Which produces the following in the Meya Orb Web SDK client:

The ask component is also an interactive component which allows you to set
quick replies, configure the input composer, configure the markdown support,
set context data and attach component triggers.
Here is a more advanced example:
ask What is your **name**? What's in a name...](https://en.wikipedia.org/wiki/Name)
quick_replies
text Discover earth
action
flow flow.earth
text Talk to an agent
action
flow flow.agent
context
foo bar
composer
focus text
placeholder Type your name here
markdown
format
linkify
Which produces the following output:

Note, not all integrations support the quick_replies, composer and markdown
fields. Check the compatibility matrix
and integration documentation to see which features the specific integration
you are using supports.
Input validation
The ask component has no built-in input validation and will capture any
text input submitted by the user.
The user's input text is always stored in (@ flow.result )
in your app's
flow scope data.
Element details
type: meya.text.component.ask
class: AskComponent
path: /meya/text/component/ask/ask.py
signature: ask
Fields
field | description
| required | signature | default | type |
---|---|---|---|---|---|
spec | Override the original spec for this element. | ○ | ○ | null | Spec |
context | Send context data with this component's event. | ○ | ○ | {} | dict |
sensitive | Mark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled. | ○ | ○ | false | bool |
triggers | Activate these dynamic triggers when the component runs. Check the component triggers guide for more info. | ○ | ○ | [] | list |
quick_replies | List of buttons that the user can select for replies. | ○ | ○ | [] | list |
composer | The composer spec that allows you to control the Orb's input composer. Check the Composer guide for more info. | ○ | ○ | focus: text | ComposerElementSpec |
header | Override the header for this component. | ○ | ○ | buttons: | HeaderElementSpec |
markdown | Override the bot Markdown mode for this component. Check the Markdown guide for more info. | ○ | ○ | null | list |
ask | Question to send to the user. | ○ | ◉ | str | |
retries | ○ | ○ | "inf" | Real | |
error_message | ○ | ○ | "Invalid input, please try again." | str | |
Usage reference
Basic
triggers
keyword meya.text.component.ask
steps
ask STRING
Full
triggers
keyword meya.text.component.ask
steps
spec
type STRING
data
STRING ANY
timeout123
trigger_when ANY
context
STRING ANY
sensitivefalse
triggers
type STRING
data
STRING ANY
timeout123
trigger_when ANY
quick_replies
url STRING
javascript STRING
button_id STRING
context
STRING ANY
defaultfalse
disabledfalse
dividerfalse
icon
url STRING
color STRING
path STRING
action COMPONENT
value ANY
result ANY
data
STRING ANY
magicfalse
type text|url|static|menu|divider|action|flow_next|component_next
menu
BUTTONELEMENTSPEC
text STRING
composer
focus file|image|text|blur
placeholder STRING
collapse_placeholder STRING
visibility collapse|hide|show
character_limit
length123
error_text STRING
header
buttons
url STRING
javascript STRING
button_id STRING
context
STRING ANY
defaultfalse
disabledfalse
dividerfalse
icon
url STRING
color STRING
path STRING
action COMPONENT
value ANY
result ANY
data
STRING ANY
magicfalse
type text|url|static|menu|divider|action|flow_next|component_next
menu
BUTTONELEMENTSPEC
text STRING
title
text STRING
icon
url STRING
color STRING
path STRING
progress
value123
show_percentfalse
milestones
text STRING
currentfalse
extra_buttons
url STRING
javascript STRING
button_id STRING
context
STRING ANY
defaultfalse
disabledfalse
dividerfalse
icon
url STRING
color STRING
path STRING
action COMPONENT
value ANY
result ANY
data
STRING ANY
magicfalse
type text|url|static|menu|divider|action|flow_next|component_next
menu
BUTTONELEMENTSPEC
text STRING
markdown
format|linkify|breaks|typographer
ask STRING
retries123
error_message STRING