Loading pattern preview
TemplatesHuman-in-the-Loop
HIL Inquire Multiple Choice
HIL Inquire Multiple Choice
Gather information through AI-driven multiple choice questions. Includes approval workflows and real-time rendering.
Loading pattern preview
Problems solved
Technical challenges this implementation handles out of the box.
- Pause the agent to ask structured multiple-choice questions
- Resume ToolLoopAgent after the user selects an answer
- Collect brand or preference context through guided choices
- Stop the loop on the inquire tool with hasToolCall
Use cases
Products and workflows this pattern is designed to support.
- Brand intake questionnaires
- Onboarding surveys inside an agent
- Preference gathering for recommendations
- Customer research chats with constrained answers
Setup
Requirements, wiring steps, and what this pattern adds to your project.
Getting started
Pick how you want to pull this pattern in. Then wire env vars and routes the same way.
- 1
Download → Next.js app
Use Download → Next.js app in the preview toolbar. You get a zip scaffold (Pro downloads rewrite preview `/view/.../api/*` paths to `/api/*` automatically).
- 2
Extract the zip and install dependencies
Unzip the archive, then run `pnpm install` (or npm / yarn) in the project folder.
- 3
Fill .env.local
The download includes .env.local placeholders when needed. Add real values for: OPENAI_API_KEY.
- 4
Customize the agent and tool files
Adapt prompts, tools, and stop conditions in the generated project for your product.
- 5
Run the app and open the pattern route
Run `pnpm dev`, open the setup/checklist page if present, then navigate to the generated pattern route and verify responses.
Environment variables
OPENAI_API_KEYGet key
Capabilities
AI SDK APIs
AgenttoolstepCountIsvalidateUIMessagesuseChatInferAgentUIMessageProviders
OpenAI
External services
Upstash
Files added
7 filesapp/page.tsxapp/layout.tsxapp/api/inquire-multiple-choice/route.tslib/ai/multiple-choice-inquire-agent.tslib/ai/tools/ask-multiple-choice-tool.tslib/tool-approval-types.tsREADME.md
Dependencies
13 totalnpm packages
6AISDKlucide-reactNext.jsReactsonnerZod
Registry components
buttoncheckboxemptyinputlabeltextareatooltip
Critical files
ai/multiple-choice-inquire-agent.tsAgent implementation using ToolLoopAgent with hasToolCall stop condition. Contains processMultipleChoiceToolCalls for handling user answers and respondWithProcessing for the message pipeline.
tools/ask-multiple-choice-tool.tsTool that dynamically generates multiple-choice questions using generateObject with a structured schema. Core tool for the inquire pattern.
Requirements
- Complexity
- Intermediate
- Setup time
- ~15 minutes
- Node
- 24+
- Memory
- 512MB
Upstash Redis
