For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • Configuration
      • ContextBuilder
        • addContext
        • Context
        • createSimpleContext
        • GatherInfo & GatherQuestion
        • getCompletionAction
        • getContext
        • getGatherInfo
        • getQuestions
        • getStepOrder
        • getSteps
        • getValidContexts
        • reset
        • Step
          • addBullets
          • addGatherQuestion
          • addSection
          • clearSections
          • setEnd
          • setFunctions
          • setGatherInfo
          • setResetConsolidate
          • setResetFullReset
          • setResetSystemPrompt
          • setResetUserPrompt
          • setSkipToNextStep
          • setSkipUserTurn
          • setStepCriteria
          • setText
          • setValidContexts
          • setValidSteps
        • toDict
        • validate
      • DataMap
      • FunctionResult
      • Helper Functions & Utilities
      • LiveWire
      • PomBuilder
      • Prefabs
      • SkillBase
      • SkillManager
      • SkillRegistry
      • Skills
      • SwaigFunction
      • SwmlBuilder
      • SWMLService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • ChatResource
      • Compat
      • Datasphere
      • Fabric
      • ImportedNumbersResource
      • Logs
      • LookupResource
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSubResource
      • Queues
      • Recordings
      • Registry
      • RestClient
      • RestError
      • Short Codes
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Parameters
  • Returns
  • Example
AgentsContextBuilderStep

setStepCriteria

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

setText

Next
Built with

Define when this step is considered complete. The AI evaluates this description against the conversation state to determine whether to advance.

Parameters

criteria
stringRequired

Natural-language description of completion conditions.

Returns

Step — Self for method chaining.

Be specific. Write “Customer has provided their full name AND phone number” rather than “Information collected”. Include failure conditions when appropriate: “Verified OR after 3 failed attempts”.

Example

1import { ContextBuilder } from '@signalwire/sdk';
2
3const builder = new ContextBuilder();
4const ctx = builder.addContext('default');
5const step = ctx.addStep('verify_identity');
6step.setText('Verify the caller\'s identity.');
7step.setStepCriteria(
8 'Complete when the customer has provided their account number ' +
9 'AND verified it with the last four digits of their SSN, ' +
10 'OR after 3 failed verification attempts.'
11);