Session
Interface representing a persistent session store for conversation history.
Extended by
Section titled “Extended by”Methods
Section titled “Methods”addItems()
Section titled “addItems()”addItems(items): Promise<void>;Append new items to the conversation history.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
|
|
Items to add to the session history. |
Returns
Section titled “Returns”Promise<void>
clearSession()
Section titled “clearSession()”clearSession(): Promise<void>;Remove all items that belong to the session and reset its state.
Returns
Section titled “Returns”Promise<void>
getItems()
Section titled “getItems()”getItems(limit?): Promise<AgentInputItem[]>;Retrieve items from the conversation history.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
|
|
|
The maximum number of items to return. When provided the most recent limit items should be returned in chronological order. |
Returns
Section titled “Returns”Promise<AgentInputItem[]>
getSessionId()
Section titled “getSessionId()”getSessionId(): Promise<string>;Ensure and return the identifier for this session.
Returns
Section titled “Returns”Promise<string>
popItem()
Section titled “popItem()”popItem(): Promise< | AgentInputItem| undefined>;Remove and return the most recent item from the conversation history if it exists.
Returns
Section titled “Returns”Promise<
| AgentInputItem
| undefined>
prepareHistoryItemForModelInput()?
Section titled “prepareHistoryItemForModelInput()?”optional prepareHistoryItemForModelInput(item): AgentInputItem;Optionally rewrite a stored history item before it is sent back to the model.
Session implementations can use this to strip provider-managed replay metadata while
preserving their public getItems() shape for UI and deletion workflows.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
Returns
Section titled “Returns”preserveReasoningItemIdsForPersistence()?
Section titled “preserveReasoningItemIdsForPersistence()?”optional preserveReasoningItemIdsForPersistence(): boolean;Optionally preserve reasoning item IDs when persisting generated output.
Some remote session stores require provider-assigned reasoning identities to accept stored reasoning items, even when model replay should omit those IDs.
Returns
Section titled “Returns”boolean