type: meya.csp.component.note
class: NoteComponent
path: /meya/csp/component/note.py
signature: note
Fields
field | signature | required | type | default | description |
---|---|---|---|---|---|
spec | ○ | ○ | Spec | null | Override the original spec for this element |
context | ○ | ○ | dict | {} | Send context data with this component's event |
sensitive | ○ | ○ | bool | false | Mark this component's event as sensitive |
triggers | ○ | ○ | list | [] | Activate these dynamic triggers when the component runs |
note | ◉ | ◉ | str | Leave a note in the transcript for customer support agents. These notes will not be sent to the end user and will only be visible to the agent. Each customer support integration will display bot notes in a different way, please see the integration documentation for specific details. |
Examples
Basic
triggers:
- keyword: meya.csp.component.note
steps:
- note: STRING
Full
triggers:
- keyword: meya.csp.component.note
steps:
- spec:
type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
context:
STRING: ANY
sensitive: false
triggers:
- type: STRING
data:
STRING: ANY
timeout: 123
trigger_when: ANY
note: STRING