addGatherQuestion | SignalWire

Add a question to this step’s gather_info configuration. setGatherInfo() must be called before this method.

Gather mode locks function access. While the model is asking gather questions, the runtime forcibly deactivates all of the step’s other functions. The only callable tools during a gather question are:

gather_submit (the native answer-submission tool)
Whatever names you list in this question’s functions option

next_step and change_context are also filtered out — the model cannot navigate away until the gather completes. If a question needs to call out to a tool (e.g. validate an email, geocode a ZIP), list that tool name in this question’s functions. Functions listed here are active only for this question.

Parameters

opts

objectRequired

Question configuration object with the following fields:

opts.key

stringRequired

Key name for storing the answer in global_data. Must be unique within this step’s gather questions.

opts.question

stringRequired

The question text to present to the caller.

opts.type

stringDefaults to string

JSON schema type for the answer parameter.

"string" — text value
"integer" — whole number value
"number" — numeric value including decimals
"boolean" — true or false value

opts.confirm

booleanDefaults to false

When true, the AI must confirm the answer with the caller before accepting it.

opts.prompt

string

Extra instruction text appended for this specific question.

opts.functions

string[]

Additional function names to make visible while asking this question.

Returns

Step — Self for method chaining. Throws an error if setGatherInfo() has not been called first.

Example

1 import { ContextBuilder } from '@signalwire/sdk';
2 
3 const builder = new ContextBuilder();
4 const ctx = builder.addContext('default');
5 const intake = ctx.addStep('intake');
6 intake.setText('Collect patient information.');
7 intake.setGatherInfo({
8   outputKey: 'patient_info',
9   completionAction: 'next_step',
10   prompt: 'Be friendly and professional when collecting information.',
11 });
12 intake.addGatherQuestion({
13   key: 'full_name', question: 'What is your full name?', confirm: true,
14 });
15 intake.addGatherQuestion({
16   key: 'date_of_birth',
17   question: 'What is your date of birth?',
18   type: 'string',
19   prompt: 'Spell it back to confirm.',
20 });
21 intake.addGatherQuestion({
22   key: 'insurance_id',
23   question: 'What is your insurance ID number?',
24   functions: ['verify_insurance'],
25 });
26 ctx.addStep('review').setText('Review the collected information with the patient.');