This is the base trigger element that is used by all other trigger
elements.
This is an abstract element and should not be used directly in
your BFML.
When you implement your own custom triggers
you will inherit from this element's Python class.
Element details
type: meya.trigger.element
class: Trigger
path: /meya/trigger/element/element.py
signature: -
Fields
field | description | required | signature | default | type |
---|---|---|---|---|---|
spec | Override the original spec for this element. | ○ | ○ | null | Spec |
bot | Bot used to evaluate this trigger. | ○ | ○ | null | BotRef |
action | Action executed if this trigger matches. Check the trigger action guide for more info. | ◉ | ○ | TriggerActionEntry ActionComponentSpec | |
when | Custom condition for when to evaluate this trigger. Check the trigger when guide for more info. | ◉ | ○ | typing.Any | |
confidence | Override the default confidence with a custom value for trigger matches. | ○ | ○ | null | Real |
Usage reference
Basic
triggers:
- type: meya.trigger.element
when: ANY
steps:
- say: STRING
Full
type: meya.trigger.element
spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
bot: element.name
action: COMPONENT
when: ANY
confidence: 123