Input components

Inputs are useful for asking your users for information. There are different types of inputs to use depending on your desired information. The complexity of an input can range from simple using input_string to somewhat complex using input_pattern that looks for a specific regex pattern or a more complex request like audio or video inputs.

Input support matrix

Only certain messaging integrations support inputs other than text. See the support matrix below for more detail.

📘

Inputs vs. intents

Most inputs have a corresponding intent with the same behavior and messaging integration compatibility. For example input_image is paired with the image trigger.

meya.input_string

Optionally outputs text and waits for a response from the user. Matches any string.

Transitions

next: the default transition for an answer (if not present, flow will transition to the next in state in sequence)

component: meya.input_string
properties:
  text: "What's your middle name?"
  output: middle_name
  scope: user

Example - Language Detection

You can use the input_string component to detect a user's language. Start by creating a new flow and paste in the following code.

states:
    first:
        component: meya.text
        properties:
        		text: "Your language is {{ flow.language }}"

    input_state:
        component: meya.input_string
        properties:
            text: "Enter some text"
            detect_language: true
            output: value
            scope: flow

    greeting:
        component: meya.text
        properties:
        		text: "Your language is {{ flow.language }}"

Test it out in the test chat window. Entering hello will match the catchall trigger and start the flow. The bot will say Your language is since it hasn't yet detected your language. Enter hello again and the bot will respond Your language is en. Clear the messages to start over. This time try entering bonjour. The bot will respond Your language is fr.

meya.input_pattern

Matches a regex pattern for input. Properties are the same as meya.input_string with a few additions.

Transitions

next: the default transition for an answer (if not present, flow will transition to the next in state in sequence)
no_match: the state to transition to if require_match is false and the user inputs something that doesn't match the pattern.

component: meya.input_pattern
properties:
    text: "What's your API key?"
    pattern: ^(?P<capture_key>[0-9a-f]{32})$
    output: api_key
    require_match: true
    scope: user

📘

Regex capture groups

Capture groups are supported with meya.input_pattern. For example, pattern: ^(?P<capture_key>[0-9a-f]{32})$ will make capture_key available on the specified scope. Ex: {{ flow.capture_key }}

If a named capture group does not match, flow.<named_group> will equal the string 'None'.

The entire utterance can be accessed by reading the value of the output property.

meya.input_integer

Matches an integer value

Transitions

next: the default transition for an answer (if not present, flow will transition to the next in state in sequence)
no_match: the state to transition to if require_match is false and the user inputs something ambiguous

component: meya.input_integer
properties:
    text: "How old are you?"
    output: age
    require_match: false
    scope: user
transitions:
		next: proper_answer
    no_match: ambiguous_answer

meya.input_datetime

Matches a "human-readable" date. Some examples that will match "now", "in 15 minutes", "tomorrow", "next wednesday at 10:30am", "9pm tonight", "October 20, 1978", "Oct. 20 at 12pm". The result is stored in Unix time (seconds).

Transitions

next: the default transition for an answer (if not present, flow will transition to the next in state in sequence)
no_match: the state to transition to if require_match is false and the user inputs something ambiguous

📘

A note about timezones

If you don't specify a timezone and there is no timezone set for the user, Meya assumes GMT. Keep this in mind when using the data at a later date. Meya will do it's best to populate the user's time zone for you. However, we can't guarantee that it's available.

component: meya.input_datetime
properties:
    text: "When is your birthday?"
    output: birthdate
    timezone: Canada/Eastern

meya.input_image

Gets an image url uploaded by the user.

📘

Supported on Messenger, Telegram, Kik and Smooch.

component: meya.input_image
properties:
  text: "Send me a picture of your favorite food!"
  output: food_image
  scope: flow

meya.input_video

Gets a video url uploaded by the user.

📘

Supported on Messenger, Telegram, Kik and Twilio

component: meya.input_video
properties:
  text: "Send a video of your view!"
  output: view_video
  scope: flow

meya.input_audio

Gets an audio url uploaded by the user.

📘

Supported on Messenger, Telegram and Twilio.

component: meya.input_audio
properties:
  text: "Send a recorded message of your order :)"
  output: audio_url
  scope: flow

meya.input_file

Gets a file url uploaded by the user.

📘

Supported on Messenger, Telegram and Twilio.

component: meya.input_file
properties:
  text: "Send a file of the doc"
  output: file_url
  scope: flow

meya.input_location

Gets and stores the location information about the user. Works with a text-based answer (e.g. Sunnyvale, CA) for all integrations or a location pin 📍 in the case of Telegram and Messenger.

📘

Support

Location pins 📍 are only supported for Telegram, Messenger and Smooch

The data is stored to the user datastore. You can access the information found in the table below.

Example of a flow using input location.

component: meya.input_location
properties:
  text: "Where are you?"
  output: location