ConversationState

Manages session lifecycle: load, save, delete, message append, turn counting. Shared by Runtime and VoiceEngine.

Methods

appendAssistantMessage()

appendAssistantMessage(session, text): void;

Append an assistant message to the session history.

Parameters

Parameter	Type
session	Session
text	string

Returns

void

---

appendMessage()

appendMessage(session, message): void;

Append a raw ModelMessage to the session history.

Parameters

Parameter	Type
session	Session
message	ModelMessage

Returns

void

---

appendUserMessage()

appendUserMessage(session, text): void;

Append a user message to the session history.

Parameters

Parameter	Type
session	Session
text	string

Returns

void

---

bumpSessionTurn()

bumpSessionTurn(session): number;

Increment and return the new turn number.

Parameters

Parameter	Type
session	Session

Returns

number

---

createSession()

createSession(
   id,
   defaultAgentId,
   userId?,
   opts?): Session;

Create a fresh session with defaults.

Parameters

Parameter	Type
id	string
defaultAgentId	string
userId?	string
opts?	{ channelId?: ChannelId; conversationId?: string; }
opts.channelId?	ChannelId
opts.conversationId?	string

Returns

Session

---

delete()

delete(sessionId): Promise<void>;

Delete a session from the backing store.

Parameters

Parameter	Type
sessionId	string

Returns

Promise<void>

---

getSessionTurn()

getSessionTurn(session): number;

Get the current turn number for the session.

Parameters

Parameter	Type
session	Session

Returns

number

---

load()

load(sessionId, userId?): Promise<Session>;

Load an existing session or create a new one.

Parameters

Parameter	Type
sessionId	string
userId?	string

Returns

Promise<Session>

---

save()

save(session): Promise<void>;

Persist session to the backing store.

Parameters

Parameter	Type
session	Session

Returns

Promise<void>

---

touchSession()

touchSession(session): void;

Update the session’s updatedAt timestamp.

Parameters

Parameter	Type
session	Session

Returns

void

---

workingMemory()

workingMemory(session): WorkingMemory;

Get a WorkingMemory wrapper for the session.

Parameters

Parameter	Type
session	Session

Returns

WorkingMemory