Element details

type: meya.google.dialogflow.component.ask
class: DialogflowAskComponent
path: /meya/google/dialogflow/component/ask/ask.py
signature: ask, expect

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.	◉	○		DialogflowIntegrationRef
language	The language code to be used for the Dialogflow API queries. If this is not provided explicitly, the user's language will be used. If the user has no language set, it will default to `en`.	○	○	null	str
intent	The specific intent (or list of intents) to match if the confidence exceeds the specified `min_confidence`.	○	○	null	str list NoneType
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
input_context	The optional input contexts that need to be applied to the detect intent API call. Providing an input context will inform Dialogflow to only evaluate intents that match the specified input contexts.	○	○	true	bool str list NoneType
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	The composer spec that allows you to control the Orb's input composer. Check the Composer guide for more info.	○	○	focus: text placeholder: collapse_placeholder: visibility: show character_limit:	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
ask	Question to send to the user.	○	◉		str
retries	The number of retries to perform should the component's validation fail.	○	○	"inf"	Real
error_message		○	○	"Invalid input, please try again."	str
catchall	Whether to return max confidence of 1.0 or not.	○	○	true	bool
expect		○	◉	null	Expect

Usage reference

Basic

triggers:
  - keyword: meya.google.dialogflow.component.ask
steps:
  - integration: integration.dialogflow
    ask: STRING
    expect: dialogflow

Full

triggers:
  - keyword: meya.google.dialogflow.component.ask
steps:
  - spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.dialogflow
    language: STRING
    intent:
      - item1
      - item2
    intent_regex: STRING
    min_confidence: 123
    max_confidence: 123
    input_context: 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
    ask: STRING
    retries: 123
    error_message: STRING
    catchall: false
    expect: dialogflow