facebook.wit.input

Element details

type: meya.facebook.wit.component.input
class: WitInputComponent
path: /meya/facebook/wit/component/input.py
signature: -

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
integrationThe reference path to the configured Dialogflow integration.WitIntegrationRef
intentThe specific intent (or list of intents) to match if the confidence exceeds the specified min_confidence.nullNoneType
str
list
intent_regexThe regex pattern to match the returned intent against if the confidence exceeds the specified min_confidence.nullstr
min_confidenceThe minimum confidence threshold that the intent needs to achieve for the trigger to match.0.75Real
max_confidenceThe maximum confidence threshold that the intent should not exceed for the trigger to match.1.0Real
localeThe 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.nullstr
coordsThe 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.nullWitContextCoords
timezoneMust be a valid IANA timezone. Used only if no reference_time is provided. Example: 'America/Los_Angeles'nullTimezone
reference_timeLocal date and time of the user in ISO8601 format. Do not use UTC time.nullstr
contextSend context data with this component's event.{}
dict
sensitiveMark this component's event as sensitive. This will encrypt the event if the Sensitive Data integration has been enabled.falsebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
quick_repliesList of buttons that the user can select for replies.[]list
composerThe composer spec that allows you to control the Orb's input composer. Check the Composer guide for more info.focus: blur
placeholder:
collapse_placeholder:
visibility:
character_limit:
ComposerElementSpec
headerOverride the header for this component.buttons:
title:
progress:
milestones:
extra_buttons:
HeaderElementSpec
markdownOverride the bot Markdown mode for this component. Check the Markdown guide for more info.nulllist
bool
NoneType
requiredfalsebool
labelnullstr
disabledfalsebool
iconThe icon spec or URL to use for the input field. See the Icons guide for more info.nullIconElementSpec
str
NoneType
placeholderThe input field's placeholder text. This is displayed when thefield has not user specified text.nullstr
defaultThe input's default value.nullstr
error_message"Invalid input, please try again."str

Usage reference

Basic

triggers: - keyword: meya.facebook.wit.component.input steps: - type: meya.facebook.wit.component.input integration: integration.wit

Full

triggers: - keyword: meya.facebook.wit.component.input steps: - type: meya.facebook.wit.component.input 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 character_limit: length: 123 error_text: STRING 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 required: false label: STRING disabled: false icon: url: STRING color: STRING path: STRING placeholder: STRING default: STRING error_message: STRING