RunContextAwareSession
此内容尚不支持你的语言。
Optional session capability for receiving the active run context.
Sessions opt in explicitly so existing implementations keep their legacy method call shapes. The runner passes the same RunContext instance to every history operation in a run.
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
|
|
|
Properties
Section titled “Properties”acceptsRunContext
Section titled “acceptsRunContext”readonly acceptsRunContext: true;Methods
Section titled “Methods”addItems()
Section titled “addItems()”addItems(items, runContext?): 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>
Overrides
Section titled “Overrides”clearSession()
Section titled “clearSession()”clearSession(runContext?): Promise<void>;Remove all items that belong to the session and reset its state.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”getItems()
Section titled “getItems()”getItems(limit?, runContext?): 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[]>
Overrides
Section titled “Overrides”getSessionId()
Section titled “getSessionId()”getSessionId(): Promise<string>;Ensure and return the identifier for this session.
Returns
Section titled “Returns”Promise<string>
Inherited from
Section titled “Inherited from”popItem()
Section titled “popItem()”popItem(runContext?): Promise< | AgentInputItem| undefined>;Remove and return the most recent item from the conversation history if it exists.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
Returns
Section titled “Returns”Promise<
| AgentInputItem
| undefined>
Overrides
Section titled “Overrides”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”Inherited from
Section titled “Inherited from”Session.prepareHistoryItemForModelInput
prepareHistoryItemsForPersistenceComparison()?
Section titled “prepareHistoryItemsForPersistenceComparison()?”optional prepareHistoryItemsForPersistenceComparison(items): AgentInputItem[];Optionally normalize stored and expected history before persistence reconciliation compares them.
Session implementations can use this to remove backend-assigned metadata while preserving
their public getItems() shape.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Session.prepareHistoryItemsForPersistenceComparison
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
Inherited from
Section titled “Inherited from”Session.preserveReasoningItemIdsForPersistence
replaceHistoryWithCompaction()?
Section titled “replaceHistoryWithCompaction()?”optional replaceHistoryWithCompaction(items, runContext?): Promise<void>;Optionally replace the logical session history with a compaction marker and its retained suffix without resetting the session identity.
Implementations may append the replacement when their backend treats the leading compaction item as the authoritative replay boundary. If this method is absent, the runner falls back to clearing and rebuilding the session with rollback protection.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
|
|
|
Returns
Section titled “Returns”Promise<void>