Element details

type: meya.directly.component.engage.rate
class: DirectlyConversationRateComponent
path: /meya/directly/component/engage/rate.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
context	Send context data with this component's event.	○	○	{}	dict
sensitive		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
integration		◉	○		DirectlyIntegrationRef
conversation_id		◉	○		str
rating		◉	○		Rating
user_ref_id		◉	○		str

Usage reference

Basic

triggers:
  - keyword: meya.directly.component.engage.rate
steps:
  - type: meya.directly.component.engage.rate
    integration: integration.directly
    conversation_id: STRING
    rating: NEGATIVE_5|NEUTRAL_NEGATIVE_5|NEUTRAL_5|NEUTRAL_POSITIVE_5|POSITIVE_5
    user_ref_id: STRING

Full

triggers:
  - keyword: meya.directly.component.engage.rate
steps:
  - type: meya.directly.component.engage.rate
    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
    integration: integration.directly
    conversation_id: STRING
    rating: NEGATIVE_5|NEUTRAL_NEGATIVE_5|NEUTRAL_5|NEUTRAL_POSITIVE_5|POSITIVE_5
    user_ref_id: STRING