Skip to main content

ConversationState

ug-js-sdk

ug-js-sdk / ConversationState

Type Alias: ConversationState

ConversationState = "uninitialized" | "initializing" | "idle" | "paused" | "listening" | "userSpeaking" | "waiting" | "playing" | "processing_complete" | "completed" | "interrupted" | "error"

Defined in: types/index.ts:327

Possible states of a conversation session.

State flow typically follows:

uninitialized → initializing → idle ⇄ listening ⇄ userSpeaking → waiting → playing → idle
                                 ↓
                              paused
  • uninitialized - Initial state before connection
  • initializing - Connecting to server and setting up
  • idle - Ready and waiting for user interaction
  • paused - Conversation temporarily paused
  • listening - Actively listening for user input
  • userSpeaking - User is currently speaking
  • waiting - Processing user input, waiting for response
  • playing - Playing assistant audio response
  • processing_complete - Response processing finished
  • completed - Conversation ended normally
  • interrupted - User interrupted the assistant
  • error - An error occurred