Interface TrimMessagesFields

interface TrimMessagesFields {
    allowPartial?: boolean;
    endOn?: MessageTypeOrClass | MessageTypeOrClass[];
    includeSystem?: boolean;
    maxTokens: number;
    startOn?: MessageTypeOrClass | MessageTypeOrClass[];
    strategy?: "last" | "first";
    textSplitter?: _TextSplitterInterface | ((text: string) => string[]) | ((text: string) => Promise<string[]>);
    tokenCounter: BaseLanguageModel<any, BaseLanguageModelCallOptions> | ((messages: BaseMessage[]) => number) | ((messages: BaseMessage[]) => Promise<number>);
}

Properties

allowPartial? endOn? includeSystem? maxTokens startOn? strategy? textSplitter? tokenCounter

Properties

OptionalallowPartial

allowPartial?: boolean

Param: allowPartial

Whether to split a message if only part of the message can be included. If strategy: "last" then the last partial contents of a message are included. If strategy: "first" then the first partial contents of a message are included.

Default

false

OptionalendOn

endOn?: MessageTypeOrClass | MessageTypeOrClass[]

Param: endOn

The message type to end on. If specified then every message after the last occurrence of this type is ignored. If strategy === "last" then this is done before we attempt to get the last maxTokens. If strategy === "first" then this is done after we get the first maxTokens. Can be specified as string names (e.g. "system", "human", "ai", ...) or as BaseMessage classes (e.g. SystemMessage, HumanMessage, AIMessage, ...). Can be a single type or an array of types.

OptionalincludeSystem

includeSystem?: boolean

Param: includeSystem

Whether to keep the SystemMessage if there is one at index 0. Should only be specified if strategy: "last".

Default

false

maxTokens

maxTokens: number

Param: maxTokens

Max token count of trimmed messages.

OptionalstartOn

startOn?: MessageTypeOrClass | MessageTypeOrClass[]

Param: startOn

The message type to start on. Should only be specified if strategy: "last". If specified then every message before the first occurrence of this type is ignored. This is done after we trim the initial messages to the last maxTokens. Does not apply to a SystemMessage at index 0 if includeSystem: true. Can be specified as string names (e.g. "system", "human", "ai", ...) or as BaseMessage classes (e.g. SystemMessage, HumanMessage, AIMessage, ...). Can be a single type or an array of types.

Optionalstrategy

strategy?: "last" | "first"

Param: strategy

Strategy for trimming.

  • "first": Keep the first <= n_count tokens of the messages.
  • "last": Keep the last <= n_count tokens of the messages.

Default

"last"

OptionaltextSplitter

textSplitter?: _TextSplitterInterface | ((text: string) => string[]) | ((text: string) => Promise<string[]>)

Param: textSplitter

Function or BaseDocumentTransformer for splitting the string contents of a message. Only used if allowPartial: true. If strategy: "last" then the last split tokens from a partial message will be included. If strategy: "first" then the first split tokens from a partial message will be included. Token splitter assumes that separators are kept, so that split contents can be directly concatenated to recreate the original text. Defaults to splitting on newlines.

tokenCounter

tokenCounter: BaseLanguageModel<any, BaseLanguageModelCallOptions> | ((messages: BaseMessage[]) => number) | ((messages: BaseMessage[]) => Promise<number>)

Param: tokenCounter

Function or LLM for counting tokens in an array of BaseMessages. If a BaseLanguageModel is passed in then BaseLanguageModel.getNumTokens() will be used.

Settings

Member Visibility

On This Page

Properties