Class ChatContext

Constructors

constructor

Accessors

items readonly

Methods

addMessage copy getById indexById insert toJSON toProviderFormat truncate empty

Constructors

constructor

Accessors

items

readonly

  • get readonly(): boolean

  • Indicates whether the context is read-only

    Returns boolean

Methods

addMessage

  • addMessage(params): ChatMessage

  • Add a new message to the context and return it.

    Parameters

    • params: {
          content: string | ChatContent[];
          createdAt?: number;
          id?: string;
          interrupted?: boolean;
          role: ChatRole;
      }
      • content: string | ChatContent[]
      • Optional createdAt?: number
      • Optional id?: string
      • Optional interrupted?: boolean
      • role: ChatRole

    Returns ChatMessage

copy

  • copy(options?): ChatContext

  • Parameters

    • options: {
          excludeEmptyMessage?: boolean;
          excludeFunctionCall?: boolean;
          excludeInstructions?: boolean;
          toolCtx?: ToolContext<any>;
      } = {}
      • Optional excludeEmptyMessage?: boolean
      • Optional excludeFunctionCall?: boolean
      • Optional excludeInstructions?: boolean
      • Optional toolCtx?: ToolContext<any>

    Returns ChatContext

getById

indexById

  • indexById(itemId): undefined | number

  • Parameters

    • itemId: string

    Returns undefined | number

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

    Returns void

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

toProviderFormat

  • toProviderFormat(format, injectDummyUserMessage?): Promise<Record<string, any>[] | [Record<string, any>[], GoogleFormatData]>

  • Parameters

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

truncate

Static empty

Settings

Member Visibility

Theme

On This Page

constructoritemsreadonlyaddMessagecopygetByIdindexByIdinserttoJSONtoProviderFormattruncateempty