Class ChatContext

Index

Constructors

constructor

new ChatContext(items?): ChatContext
Parameters
- Optional items: ChatItem[]
Returns ChatContext
- Defined in agents/src/llm/chat_context.ts:417

Accessors

items

get items(): ChatItem[]
Returns ChatItem[]
- Defined in agents/src/llm/chat_context.ts:425
set items(items): void
Parameters
- items: ChatItem[]
Returns void
- Defined in agents/src/llm/chat_context.ts:429

readonly

get readonly(): boolean
Indicates whether the context is read-only

Returns boolean
- Defined in agents/src/llm/chat_context.ts:891

Methods

_summarize

_summarize(llm, options?): Promise<ChatContext>
Parameters
- llm: llm.LLM
- options: {
  keepLastTurns?: number;
  } = {}
  - Optional keepLastTurns?: number
Returns Promise<ChatContext>
- Defined in agents/src/llm/chat_context.ts:782

addMessage

addMessage(params): ChatMessage
Add a new message to the context and return it.
Parameters
- params: {
      content: string | ChatContent[];
      createdAt?: number;
      extra?: Record<string, unknown>;
      id?: string;
      interrupted?: boolean;
      role: ChatRole;
  }
  - content: string | ChatContent[]
  - Optional createdAt?: number
  - Optional extra?: Record<string, unknown>
  - Optional id?: string
  - Optional interrupted?: boolean
  - role: ChatRole
Returns ChatMessage
- Defined in agents/src/llm/chat_context.ts:436

copy

copy(options?): ChatContext
Parameters
- options: {
      excludeEmptyMessage?: boolean;
      excludeFunctionCall?: boolean;
      excludeHandoff?: boolean;
      excludeInstructions?: boolean;
      toolCtx?: ToolContext<any>;
  } = {}
  - Optional excludeEmptyMessage?: boolean
  - Optional excludeFunctionCall?: boolean
  - Optional excludeHandoff?: boolean
  - Optional excludeInstructions?: boolean
  - Optional toolCtx?: ToolContext<any>
Returns ChatContext
- Defined in agents/src/llm/chat_context.ts:476

getById

getById(itemId): undefined | ChatItem
Parameters
- itemId: string
Returns undefined | ChatItem
- Defined in agents/src/llm/chat_context.ts:466

indexById

indexById(itemId): undefined | number
Parameters
- itemId: string
Returns undefined | number
- Defined in agents/src/llm/chat_context.ts:470

insert

insert(item): void
Insert a single item or multiple items based on their createdAt field so that the array keeps its chronological order.
Parameters
- item: ChatItem | ChatItem[]
Returns void
- Defined in agents/src/llm/chat_context.ts:458

isEquivalent

isEquivalent(other): boolean
Return true if other has the same sequence of items with matching essential fields (IDs, types, and payload) as this context.

Comparison rules:
- Messages: compares the full content list, role and interrupted.
- Function calls: compares name, callId, and args.
- Function call outputs: compares name, callId, output, and isError.
Does not consider timestamps or other metadata.
Parameters
- other: ChatContext
Returns boolean
- Defined in agents/src/llm/chat_context.ts:680

merge

merge(other, options?): ChatContext
Parameters
- other: ChatContext
- options: {
  excludeFunctionCall?: boolean;
  excludeInstructions?: boolean;
  } = {}
  - Optional excludeFunctionCall?: boolean
  - Optional excludeInstructions?: boolean
Returns ChatContext
- Defined in agents/src/llm/chat_context.ts:530

toJSON

toJSON(options?): JSONObject
Parameters
- options: {
      excludeAudio?: boolean;
      excludeFunctionCall?: boolean;
      excludeImage?: boolean;
      excludeTimestamp?: boolean;
  } = {}
  - Optional excludeAudio?: boolean
  - Optional excludeFunctionCall?: boolean
  - Optional excludeImage?: boolean
  - Optional excludeTimestamp?: boolean
Returns JSONObject
- Defined in agents/src/llm/chat_context.ts:594

toProviderFormat

toProviderFormat(format, injectDummyUserMessage?): Promise<Record<string, any>[] | [Record<string, unknown>[], GoogleFormatData]>
Parameters
- format: ProviderFormat
- injectDummyUserMessage: boolean = true
Returns Promise<Record<string, any>[] | [Record<string, unknown>[], GoogleFormatData]>
- Defined in agents/src/llm/chat_context.ts:651

truncate

truncate(maxItems): ChatContext
Parameters
- maxItems: number
Returns ChatContext
- Defined in agents/src/llm/chat_context.ts:565

`Static` empty

empty(): ChatContext
Returns ChatContext
- Defined in agents/src/llm/chat_context.ts:421

Class ChatContext

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ChatContext

Accessors

items

Returns ChatItem[]

Parameters

Returns void

readonly

Returns boolean

Methods

_summarize

Parameters

Optional keepLastTurns?: number

Returns Promise<ChatContext>

addMessage

Parameters

content: string | ChatContent[]

Optional createdAt?: number

Optional extra?: Record<string, unknown>

Optional id?: string

Optional interrupted?: boolean

role: ChatRole

Returns ChatMessage

copy

Parameters

Optional excludeEmptyMessage?: boolean

Optional excludeFunctionCall?: boolean

Optional excludeHandoff?: boolean

Optional excludeInstructions?: boolean

Optional toolCtx?: ToolContext<any>

Returns ChatContext

getById

Parameters

Returns undefined | ChatItem

indexById

Parameters

Returns undefined | number

insert

Parameters

Returns void

isEquivalent

Parameters

Returns boolean

merge

Parameters

Optional excludeFunctionCall?: boolean

Optional excludeInstructions?: boolean

Returns ChatContext

toJSON

Parameters

Optional excludeAudio?: boolean

Optional excludeFunctionCall?: boolean

Optional excludeImage?: boolean

Optional excludeTimestamp?: boolean

Returns JSONObject

toProviderFormat

Parameters

Returns Promise<Record<string, any>[] | [Record<string, unknown>[], GoogleFormatData]>

truncate

Parameters

Returns ChatContext

Static empty

Returns ChatContext

Settings

Member Visibility

Theme

On This Page

`Optional` keepLastTurns?: number

`Optional` createdAt?: number

`Optional` extra?: Record<string, unknown>

`Optional` id?: string

`Optional` interrupted?: boolean

`Optional` excludeEmptyMessage?: boolean

`Optional` excludeFunctionCall?: boolean

`Optional` excludeHandoff?: boolean

`Optional` excludeInstructions?: boolean

`Optional` toolCtx?: ToolContext<any>

`Optional` excludeFunctionCall?: boolean

`Optional` excludeInstructions?: boolean

`Optional` excludeAudio?: boolean

`Optional` excludeFunctionCall?: boolean

`Optional` excludeImage?: boolean

`Optional` excludeTimestamp?: boolean

`Static` empty