Questionnaire

Learn how to use our product with this module.

Presents the user with a series of questions then sends that information to your AI agent to analyze and make suggestions against. Works well with modules that accept data forwarding.

Module Overview

Key

QUESTIONNAIRE

Type

ACTION

Runtime

CLIENT_BEFORE_PROMPT

Data

Accepts: No
Forwards: Yes

Settings

Setting Key	Type	Default Value	Description
`msg`	`string`	Please answer a couple questions so that I can better help you.	The chat message the user will see when the questionnaire loads.
`msgComplete`	`string`	Thanks, give me a minute to analyze your responses.	The chat message the user sees after the questionnaire is complete and the AI Agent is analyzing the responses.
`sendToAiAgent`	`boolean`	true	Whether you want to send a prompt to the AI agent to act on the responses after completion. If false, the data will be stored for use with other modules.
`purpose`	`string`	Analyze the user responses and provide feedback according to the module's instructions.	The instructions given to the AI model behind the scenes instructing it what to do with the questionnaire responses.
`questions`	`IQuestion[]`	-	The questions the user will be asked during this questionnaire.

IQuestion

Question With Fixed Options

{
    "key": "risk_tolerance",
    "text": "What is your risk tolerance for trading?",
    "options": [
        "High: I don't mind losing money if it means a big win.",
        "Normal",
        "Low: I want to keep my money safe while making slow gains."
    ]
}

Question With Text Input

{
    "key": "willing_to_wager",
    "text": "How much are you willing to wager?",
    "options": null
}

Key	Type	Required?	Description
`key`	`string`	✅	An alpha-dash string representing the question's unique identifier.
`text`	`string`	✅	The question's text.
`options`	`string[]`	❌	The options a user can select from for this question. If not present, a text input will be provided to the user.