Element details

type: meya.facebook.wit.component.ask.form
class: WitAskFormComponent
path: /meya/facebook/wit/component/ask/form.py
signature: expect, ask_form

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
integration	The reference path to the configured Dialogflow integration.	◉	○		WitIntegrationRef
intent	The specific intent (or list of intents) to match if the confidence exceeds the specified `min_confidence`.	○	○	null	NoneType str list
intent_regex	The regex pattern to match the returned intent against if the confidence exceeds the specified `min_confidence`.	○	○	null	str
min_confidence	The minimum confidence threshold that the intent needs to achieve for the trigger to match.	○	○	0.75	Real
max_confidence	The maximum confidence threshold that the intent should not exceed for the trigger to match.	○	○	1.0	Real
locale	The first 2 letters must be a valid ISO639-1 language, followed by an underscore, followed by a valid ISO3166 alpha2 country code. Locale is used to resolve the entities.	○	○	null	str
coords	The user's location coordinates. Must be in the form of an object with 'lat': float and 'long': float. This field is used to improve ranking for wit/location's resolved values.	○	○	null	WitContextCoords
timezone	Must be a valid IANA timezone. Used only if no `reference_time` is provided. Example: 'America/Los_Angeles'	○	○	null	Timezone
reference_time	Local date and time of the user in ISO8601 format. Do not use UTC time.	○	○	null	str
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		○	○	focus: blur placeholder: collapse_placeholder: visibility:	ComposerElementSpec
header	Override the header for this component.	○	○	buttons: title: progress: milestones: extra_buttons:	HeaderElementSpec
markdown	Override the bot Markdown mode for this component. Check the Markdown guide for more info.	○	○	null	list bool NoneType
expect		○	◉	null	Expect
ask_form	Phrase to be sent to Wit AI for intent detection	○	◉	null	str
icon	Icon will be shown on field left side	○	○	null	IconElementSpec str NoneType
label	This text will be shown on top left of the form field	○	○	"Text"	str
field_name		○	○	"text"	str
autocomplete		○	○	"off"	str
placeholder		○	○	null	str
retries		○	○	"inf"	Real
error_message		○	○	"Invalid"	str

Usage reference

Basic

triggers:
  - keyword: meya.facebook.wit.component.ask.form
steps:
  - integration: integration.wit
    expect: wit
    ask_form: STRING

Full

triggers:
  - keyword: meya.facebook.wit.component.ask.form
steps:
  - spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.wit
    intent: STRING
    intent_regex: STRING
    min_confidence: 123
    max_confidence: 123
    locale: STRING
    coords:
      lat: 123
      long: 123
    timezone: TIMEZONE
    reference_time: STRING
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    quick_replies:
      - url: STRING
        javascript: STRING
        button_id: STRING
        context:
          STRING: ANY
        default: false
        disabled: false
        divider: false
        icon:
          url: STRING
          color: STRING
          path: STRING
        action: COMPONENT
        value: ANY
        result: ANY
        data:
          STRING: ANY
        magic: false
        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
    header:
      buttons:
        - url: STRING
          javascript: STRING
          button_id: STRING
          context:
            STRING: ANY
          default: false
          disabled: false
          divider: false
          icon:
            url: STRING
            color: STRING
            path: STRING
          action: COMPONENT
          value: ANY
          result: ANY
          data:
            STRING: ANY
          magic: false
          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:
        value: 123
        show_percent: false
      milestones:
        - text: STRING
          current: false
      extra_buttons:
        - url: STRING
          javascript: STRING
          button_id: STRING
          context:
            STRING: ANY
          default: false
          disabled: false
          divider: false
          icon:
            url: STRING
            color: STRING
            path: STRING
          action: COMPONENT
          value: ANY
          result: ANY
          data:
            STRING: ANY
          magic: false
          type: text|url|static|menu|divider|action|flow_next|component_next
          menu:
            - BUTTONELEMENTSPEC
          text: STRING
    markdown:
      - format|linkify|breaks|typographer
    expect: wit
    ask_form: STRING
    icon:
      url: STRING
      color: STRING
      path: STRING
    label: STRING
    field_name: STRING
    autocomplete: STRING
    placeholder: STRING
    retries: 123
    error_message: STRING