OpenAIResponsesCompactionAwareSession

Interface representing a persistent session store for conversation history.

Extends

Session

Methods

addItems()

addItems(items): Promise<void>;

Append new items to the conversation history.

Parameters

Parameter	Type	Description
`items`	`AgentInputItem`[]	Items to add to the session history.

Returns

Promise<void>

Inherited from

Session.addItems

clearSession()

clearSession(): Promise<void>;

Remove all items that belong to the session and reset its state.

Returns

Promise<void>

Inherited from

Session.clearSession

getItems()

getItems(limit?): Promise<AgentInputItem[]>;

Retrieve items from the conversation history.

Parameters

Parameter	Type	Description
`limit?`	`number`	The maximum number of items to return. When provided the most recent limit items should be returned in chronological order.

Returns

Promise<AgentInputItem[]>

Inherited from

Session.getItems

getSessionId()

getSessionId(): Promise<string>;

Ensure and return the identifier for this session.

Returns

Promise<string>

Inherited from

Session.getSessionId

popItem()

popItem(): Promise<
 | AgentInputItem
| undefined>;

Remove and return the most recent item from the conversation history if it exists.

Returns

Promise< | AgentInputItem | undefined>

Inherited from

Session.popItem

runCompaction()

runCompaction(args?):
 | OpenAIResponsesCompactionResult
 | Promise<
 | OpenAIResponsesCompactionResult
 | null>
 | null;

Invoked by the runner after it persists a completed turn into the session.

Implementations may decide to call responses.compact (or an equivalent API) and replace the stored history.

This hook is best-effort. Implementations should consider handling transient failures and deciding whether to retry or skip compaction for the current turn.

Parameters

Parameter	Type
`args?`	`OpenAIResponsesCompactionArgs`

Returns