Context | SignalWire

A Context represents a distinct conversation mode — like “sales”, “support”, or “billing” — within a ContextBuilder. Each context holds an ordered sequence of Step objects and configures its own prompt, system prompt, fillers, and navigation rules.

You obtain a Context by calling addContext() on a ContextBuilder or by calling getContext() to retrieve one that already exists.

Properties

name

stringRequired

Unique context name. When using a single context inside a ContextBuilder, this must be "default".

Methods

addBullets

Add a POM section with bullet points to the context prompt.

addEnterFiller

Add enter fillers for a specific language.

addExitFiller

Add exit fillers for a specific language.

addSection

Add a POM section to the context prompt.

addStep

Add a new step to this context.

addSystemBullets

Add a POM section with bullets to the system prompt.

addSystemSection

Add a POM section to the system prompt.

getStep

Get an existing step by name.

moveStep

Move an existing step to a specific position in the step order.

removeStep

Remove a step from this context.

setConsolidate

Set whether to consolidate conversation history when entering this context.

setEnterFillers

Set all enter fillers at once.

setExitFillers

Set all exit fillers at once.

setHistory

Set the default history visibility mode for every step.

setFullReset

Set whether to fully reset conversation history when entering this context.

setInitialStep

Set which step the context starts on when entered.

setIsolated

Set whether to truncate conversation history when entering this context.

setPostPrompt

Override the post-prompt text while this context is active.

setPrompt

Set the context’s prompt text directly.

setSystemPrompt

Set a new system prompt that takes effect when this context is entered.

setUserPrompt

Inject a user message when entering this context.

setValidContexts

Set which contexts the agent can navigate to from this context.

setValidSteps

Set which steps can be navigated to from any step in this context.

Example

import { ContextBuilder } from '@signalwire/sdk';
const builder = new ContextBuilder();
const main = builder.addContext('default');
main.addStep('menu').setText('Ask whether the caller needs sales or support.');
const support = builder.addContext('support');
// System prompt for this context
support.setSystemPrompt('You are a patient technical support engineer.');
support.setConsolidate(true);
// Fillers for smooth transitions
support.addEnterFiller('en-US', [
  'Let me connect you with support...',
  'Transferring you now...',
]);
support.addExitFiller('en-US', [
  'Thank you for contacting support.',
  'Glad I could help.',
]);
// Navigation
support.setValidContexts(['default']);
// Steps
support.addStep('diagnose', {
  task: 'Understand the customer\'s issue and gather relevant details.',
  criteria: 'Issue is clearly identified',
  functions: ['lookup_account', 'check_status'],
  validSteps: ['resolve'],
});
support.addStep('resolve', {
  task: 'Resolve the issue or escalate to a specialist.',
  functions: ['create_ticket', 'transfer_call'],
  validSteps: ['farewell'],
});
support.addStep('farewell')
  .setText('Thank the caller and end the conversation.')
  .setFunctions('none')
  .setEnd(true);