langchain 0.0.176 → 0.0.178

package/dist/prompts/few_shot.cjs

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FewShotPromptTemplate = void 0;
+exports.FewShotChatMessagePromptTemplate = exports.FewShotPromptTemplate = void 0;
 const base_js_1 = require("./base.cjs");
 const template_js_1 = require("./template.cjs");
 const prompt_js_1 = require("./prompt.cjs");
+const chat_js_1 = require("./chat.cjs");
 /**
  * Prompt template that contains few-shot examples.
  * @augments BasePromptTemplate
@@ -84,6 +85,9 @@ class FewShotPromptTemplate extends base_js_1.BaseStringPromptTemplate {
     _getPromptType() {
         return "few_shot";
     }
+    static lc_name() {
+        return "FewShotPromptTemplate";
+    }
     async getExamples(inputVariables) {
         if (this.examples !== undefined) {
             return this.examples;
@@ -161,3 +165,160 @@ class FewShotPromptTemplate extends base_js_1.BaseStringPromptTemplate {
     }
 }
 exports.FewShotPromptTemplate = FewShotPromptTemplate;
+/**
+ * Chat prompt template that contains few-shot examples.
+ * @augments BasePromptTemplateInput
+ * @augments FewShotChatMessagePromptTemplateInput
+ */
+class FewShotChatMessagePromptTemplate extends chat_js_1.BaseChatPromptTemplate {
+    _getPromptType() {
+        return "few_shot_chat";
+    }
+    static lc_name() {
+        return "FewShotChatMessagePromptTemplate";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        Object.defineProperty(this, "examples", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "exampleSelector", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "examplePrompt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "suffix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ""
+        });
+        Object.defineProperty(this, "exampleSeparator", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "\n\n"
+        });
+        Object.defineProperty(this, "prefix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ""
+        });
+        Object.defineProperty(this, "templateFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "f-string"
+        });
+        Object.defineProperty(this, "validateTemplate", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        this.examples = fields.examples;
+        this.examplePrompt = fields.examplePrompt;
+        this.exampleSeparator = fields.exampleSeparator ?? "\n\n";
+        this.exampleSelector = fields.exampleSelector;
+        this.prefix = fields.prefix ?? "";
+        this.suffix = fields.suffix ?? "";
+        this.templateFormat = fields.templateFormat ?? "f-string";
+        this.validateTemplate = fields.validateTemplate ?? true;
+        if (this.examples !== undefined && this.exampleSelector !== undefined) {
+            throw new Error("Only one of 'examples' and 'example_selector' should be provided");
+        }
+        if (this.examples === undefined && this.exampleSelector === undefined) {
+            throw new Error("One of 'examples' and 'example_selector' should be provided");
+        }
+        if (this.validateTemplate) {
+            let totalInputVariables = this.inputVariables;
+            if (this.partialVariables) {
+                totalInputVariables = totalInputVariables.concat(Object.keys(this.partialVariables));
+            }
+            (0, template_js_1.checkValidTemplate)(this.prefix + this.suffix, this.templateFormat, totalInputVariables);
+        }
+    }
+    async getExamples(inputVariables) {
+        if (this.examples !== undefined) {
+            return this.examples;
+        }
+        if (this.exampleSelector !== undefined) {
+            return this.exampleSelector.selectExamples(inputVariables);
+        }
+        throw new Error("One of 'examples' and 'example_selector' should be provided");
+    }
+    /**
+     * Formats the list of values and returns a list of formatted messages.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
+    async formatMessages(values) {
+        const allValues = await this.mergePartialAndUserVariables(values);
+        let examples = await this.getExamples(allValues);
+        examples = examples.map((example) => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const result = {};
+            this.examplePrompt.inputVariables.forEach((inputVariable) => {
+                result[inputVariable] = example[inputVariable];
+            });
+            return result;
+        });
+        const messages = [];
+        for (const example of examples) {
+            const exampleMessages = await this.examplePrompt.formatMessages(example);
+            messages.push(...exampleMessages);
+        }
+        return messages;
+    }
+    /**
+     * Formats the prompt with the given values.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
+    async format(values) {
+        const allValues = await this.mergePartialAndUserVariables(values);
+        const examples = await this.getExamples(allValues);
+        const exampleMessages = await Promise.all(examples.map((example) => this.examplePrompt.formatMessages(example)));
+        const exampleStrings = exampleMessages
+            .flat()
+            .map((message) => message.content);
+        const template = [this.prefix, ...exampleStrings, this.suffix].join(this.exampleSeparator);
+        return (0, template_js_1.renderTemplate)(template, this.templateFormat, allValues);
+    }
+    /**
+     * Partially formats the prompt with the given values.
+     * @param values The values to partially format the prompt with.
+     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
+     */
+    async partial(values) {
+        const newInputVariables = this.inputVariables.filter((variable) => !(variable in values));
+        const newPartialVariables = {
+            ...(this.partialVariables ?? {}),
+            ...values,
+        };
+        const promptDict = {
+            ...this,
+            inputVariables: newInputVariables,
+            partialVariables: newPartialVariables,
+        };
+        return new FewShotChatMessagePromptTemplate(promptDict);
+    }
+}
+exports.FewShotChatMessagePromptTemplate = FewShotChatMessagePromptTemplate;

package/dist/prompts/few_shot.d.ts

@@ -1,8 +1,9 @@
-import { BaseStringPromptTemplate, BasePromptTemplateInput, BaseExampleSelector } from "./base.js";
+import { BaseStringPromptTemplate, BasePromptTemplateInput, BaseExampleSelector, TypedPromptInputValues } from "./base.js";
 import { TemplateFormat } from "./template.js";
 import { PromptTemplate } from "./prompt.js";
 import { SerializedFewShotTemplate } from "./serde.js";
-import { Example, InputValues, PartialValues } from "../schema/index.js";
+import { BaseMessage, Example, InputValues, PartialValues } from "../schema/index.js";
+import { BaseChatPromptTemplate, BaseMessagePromptTemplate } from "./chat.js";
 export interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {
     /**
      * Examples to format into the prompt. Exactly one of this or
@@ -60,6 +61,7 @@ export declare class FewShotPromptTemplate extends BaseStringPromptTemplate impl
     validateTemplate: boolean;
     constructor(input: FewShotPromptTemplateInput);
     _getPromptType(): "few_shot";
+    static lc_name(): string;
     private getExamples;
     partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;
     /**
@@ -71,3 +73,89 @@ export declare class FewShotPromptTemplate extends BaseStringPromptTemplate impl
     serialize(): SerializedFewShotTemplate;
     static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;
 }
+export interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {
+    /**
+     * Examples to format into the prompt. Exactly one of this or
+     * {@link exampleSelector} must be
+     * provided.
+     */
+    examples?: Example[];
+    /**
+     * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.
+     */
+    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
+    /**
+     * String separator used to join the prefix, the examples, and suffix.
+     *
+     * @defaultValue `"\n\n"`
+     */
+    exampleSeparator?: string;
+    /**
+     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
+     * {@link examples} must be
+     * provided.
+     */
+    exampleSelector?: BaseExampleSelector | undefined;
+    /**
+     * A prompt template string to put before the examples.
+     *
+     * @defaultValue `""`
+     */
+    prefix?: string;
+    /**
+     * A prompt template string to put after the examples.
+     *
+     * @defaultValue `""`
+     */
+    suffix?: string;
+    /**
+     * The format of the prompt template. Options are: 'f-string'
+     *
+     * @defaultValue `f-string`
+     */
+    templateFormat?: TemplateFormat;
+    /**
+     * Whether or not to try validating the template on initialization.
+     *
+     * @defaultValue `true`
+     */
+    validateTemplate?: boolean;
+}
+/**
+ * Chat prompt template that contains few-shot examples.
+ * @augments BasePromptTemplateInput
+ * @augments FewShotChatMessagePromptTemplateInput
+ */
+export declare class FewShotChatMessagePromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {
+    lc_serializable: boolean;
+    examples?: InputValues[];
+    exampleSelector?: BaseExampleSelector | undefined;
+    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
+    suffix: string;
+    exampleSeparator: string;
+    prefix: string;
+    templateFormat: TemplateFormat;
+    validateTemplate: boolean;
+    _getPromptType(): "few_shot_chat";
+    static lc_name(): string;
+    constructor(fields: FewShotChatMessagePromptTemplateInput);
+    private getExamples;
+    /**
+     * Formats the list of values and returns a list of formatted messages.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
+    formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
+    /**
+     * Formats the prompt with the given values.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
+    format(values: TypedPromptInputValues<RunInput>): Promise<string>;
+    /**
+     * Partially formats the prompt with the given values.
+     * @param values The values to partially format the prompt with.
+     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
+     */
+    partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;
+}

package/dist/prompts/few_shot.js

@@ -1,6 +1,7 @@
 import { BaseStringPromptTemplate, } from "./base.js";
 import { checkValidTemplate, renderTemplate, } from "./template.js";
 import { PromptTemplate } from "./prompt.js";
+import { BaseChatPromptTemplate } from "./chat.js";
 /**
  * Prompt template that contains few-shot examples.
  * @augments BasePromptTemplate
@@ -81,6 +82,9 @@ export class FewShotPromptTemplate extends BaseStringPromptTemplate {
     _getPromptType() {
         return "few_shot";
     }
+    static lc_name() {
+        return "FewShotPromptTemplate";
+    }
     async getExamples(inputVariables) {
         if (this.examples !== undefined) {
             return this.examples;
@@ -157,3 +161,159 @@ export class FewShotPromptTemplate extends BaseStringPromptTemplate {
         });
     }
 }
+/**
+ * Chat prompt template that contains few-shot examples.
+ * @augments BasePromptTemplateInput
+ * @augments FewShotChatMessagePromptTemplateInput
+ */
+export class FewShotChatMessagePromptTemplate extends BaseChatPromptTemplate {
+    _getPromptType() {
+        return "few_shot_chat";
+    }
+    static lc_name() {
+        return "FewShotChatMessagePromptTemplate";
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "lc_serializable", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        Object.defineProperty(this, "examples", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "exampleSelector", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "examplePrompt", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "suffix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ""
+        });
+        Object.defineProperty(this, "exampleSeparator", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "\n\n"
+        });
+        Object.defineProperty(this, "prefix", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: ""
+        });
+        Object.defineProperty(this, "templateFormat", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "f-string"
+        });
+        Object.defineProperty(this, "validateTemplate", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: true
+        });
+        this.examples = fields.examples;
+        this.examplePrompt = fields.examplePrompt;
+        this.exampleSeparator = fields.exampleSeparator ?? "\n\n";
+        this.exampleSelector = fields.exampleSelector;
+        this.prefix = fields.prefix ?? "";
+        this.suffix = fields.suffix ?? "";
+        this.templateFormat = fields.templateFormat ?? "f-string";
+        this.validateTemplate = fields.validateTemplate ?? true;
+        if (this.examples !== undefined && this.exampleSelector !== undefined) {
+            throw new Error("Only one of 'examples' and 'example_selector' should be provided");
+        }
+        if (this.examples === undefined && this.exampleSelector === undefined) {
+            throw new Error("One of 'examples' and 'example_selector' should be provided");
+        }
+        if (this.validateTemplate) {
+            let totalInputVariables = this.inputVariables;
+            if (this.partialVariables) {
+                totalInputVariables = totalInputVariables.concat(Object.keys(this.partialVariables));
+            }
+            checkValidTemplate(this.prefix + this.suffix, this.templateFormat, totalInputVariables);
+        }
+    }
+    async getExamples(inputVariables) {
+        if (this.examples !== undefined) {
+            return this.examples;
+        }
+        if (this.exampleSelector !== undefined) {
+            return this.exampleSelector.selectExamples(inputVariables);
+        }
+        throw new Error("One of 'examples' and 'example_selector' should be provided");
+    }
+    /**
+     * Formats the list of values and returns a list of formatted messages.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
+    async formatMessages(values) {
+        const allValues = await this.mergePartialAndUserVariables(values);
+        let examples = await this.getExamples(allValues);
+        examples = examples.map((example) => {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            const result = {};
+            this.examplePrompt.inputVariables.forEach((inputVariable) => {
+                result[inputVariable] = example[inputVariable];
+            });
+            return result;
+        });
+        const messages = [];
+        for (const example of examples) {
+            const exampleMessages = await this.examplePrompt.formatMessages(example);
+            messages.push(...exampleMessages);
+        }
+        return messages;
+    }
+    /**
+     * Formats the prompt with the given values.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
+    async format(values) {
+        const allValues = await this.mergePartialAndUserVariables(values);
+        const examples = await this.getExamples(allValues);
+        const exampleMessages = await Promise.all(examples.map((example) => this.examplePrompt.formatMessages(example)));
+        const exampleStrings = exampleMessages
+            .flat()
+            .map((message) => message.content);
+        const template = [this.prefix, ...exampleStrings, this.suffix].join(this.exampleSeparator);
+        return renderTemplate(template, this.templateFormat, allValues);
+    }
+    /**
+     * Partially formats the prompt with the given values.
+     * @param values The values to partially format the prompt with.
+     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
+     */
+    async partial(values) {
+        const newInputVariables = this.inputVariables.filter((variable) => !(variable in values));
+        const newPartialVariables = {
+            ...(this.partialVariables ?? {}),
+            ...values,
+        };
+        const promptDict = {
+            ...this,
+            inputVariables: newInputVariables,
+            partialVariables: newPartialVariables,
+        };
+        return new FewShotChatMessagePromptTemplate(promptDict);
+    }
+}

package/dist/prompts/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PipelinePromptTemplate = exports.checkValidTemplate = exports.renderTemplate = exports.parseTemplate = exports.BaseChatPromptTemplate = exports.MessagesPlaceholder = exports.ChatMessagePromptTemplate = exports.SystemMessagePromptTemplate = exports.AIMessagePromptTemplate = exports.HumanMessagePromptTemplate = exports.ChatPromptTemplate = exports.FewShotPromptTemplate = exports.SemanticSimilarityExampleSelector = exports.LengthBasedExampleSelector = exports.isLLM = exports.isChatModel = exports.ConditionalPromptSelector = exports.BasePromptSelector = exports.PromptTemplate = exports.BaseStringPromptTemplate = exports.StringPromptValue = exports.BasePromptTemplate = exports.BaseExampleSelector = void 0;
+exports.PipelinePromptTemplate = exports.checkValidTemplate = exports.renderTemplate = exports.parseTemplate = exports.BaseChatPromptTemplate = exports.MessagesPlaceholder = exports.ChatMessagePromptTemplate = exports.SystemMessagePromptTemplate = exports.AIMessagePromptTemplate = exports.HumanMessagePromptTemplate = exports.ChatPromptTemplate = exports.FewShotChatMessagePromptTemplate = exports.FewShotPromptTemplate = exports.SemanticSimilarityExampleSelector = exports.LengthBasedExampleSelector = exports.isLLM = exports.isChatModel = exports.ConditionalPromptSelector = exports.BasePromptSelector = exports.PromptTemplate = exports.BaseStringPromptTemplate = exports.StringPromptValue = exports.BasePromptTemplate = exports.BaseExampleSelector = void 0;
 var base_js_1 = require("./base.cjs");
 Object.defineProperty(exports, "BaseExampleSelector", { enumerable: true, get: function () { return base_js_1.BaseExampleSelector; } });
 Object.defineProperty(exports, "BasePromptTemplate", { enumerable: true, get: function () { return base_js_1.BasePromptTemplate; } });
@@ -19,6 +19,7 @@ var SemanticSimilarityExampleSelector_js_1 = require("./selectors/SemanticSimila
 Object.defineProperty(exports, "SemanticSimilarityExampleSelector", { enumerable: true, get: function () { return SemanticSimilarityExampleSelector_js_1.SemanticSimilarityExampleSelector; } });
 var few_shot_js_1 = require("./few_shot.cjs");
 Object.defineProperty(exports, "FewShotPromptTemplate", { enumerable: true, get: function () { return few_shot_js_1.FewShotPromptTemplate; } });
+Object.defineProperty(exports, "FewShotChatMessagePromptTemplate", { enumerable: true, get: function () { return few_shot_js_1.FewShotChatMessagePromptTemplate; } });
 var chat_js_1 = require("./chat.cjs");
 Object.defineProperty(exports, "ChatPromptTemplate", { enumerable: true, get: function () { return chat_js_1.ChatPromptTemplate; } });
 Object.defineProperty(exports, "HumanMessagePromptTemplate", { enumerable: true, get: function () { return chat_js_1.HumanMessagePromptTemplate; } });

package/dist/prompts/index.d.ts

@@ -3,7 +3,7 @@ export { PromptTemplate, type PromptTemplateInput } from "./prompt.js";
 export { BasePromptSelector, ConditionalPromptSelector, isChatModel, isLLM, } from "./selectors/conditional.js";
 export { LengthBasedExampleSelector, type LengthBasedExampleSelectorInput, } from "./selectors/LengthBasedExampleSelector.js";
 export { SemanticSimilarityExampleSelector, type SemanticSimilarityExampleSelectorInput, } from "./selectors/SemanticSimilarityExampleSelector.js";
-export { FewShotPromptTemplate, type FewShotPromptTemplateInput, } from "./few_shot.js";
+export { FewShotPromptTemplate, type FewShotPromptTemplateInput, type FewShotChatMessagePromptTemplateInput, FewShotChatMessagePromptTemplate, } from "./few_shot.js";
 export { ChatPromptTemplate, HumanMessagePromptTemplate, AIMessagePromptTemplate, SystemMessagePromptTemplate, ChatMessagePromptTemplate, MessagesPlaceholder, BaseChatPromptTemplate, } from "./chat.js";
 export { type SerializedPromptTemplate, type SerializedBasePromptTemplate, type SerializedFewShotTemplate, } from "./serde.js";
 export { parseTemplate, renderTemplate, checkValidTemplate, type TemplateFormat, } from "./template.js";

package/dist/prompts/index.js

@@ -3,7 +3,7 @@ export { PromptTemplate } from "./prompt.js";
 export { BasePromptSelector, ConditionalPromptSelector, isChatModel, isLLM, } from "./selectors/conditional.js";
 export { LengthBasedExampleSelector, } from "./selectors/LengthBasedExampleSelector.js";
 export { SemanticSimilarityExampleSelector, } from "./selectors/SemanticSimilarityExampleSelector.js";
-export { FewShotPromptTemplate, } from "./few_shot.js";
+export { FewShotPromptTemplate, FewShotChatMessagePromptTemplate, } from "./few_shot.js";
 export { ChatPromptTemplate, HumanMessagePromptTemplate, AIMessagePromptTemplate, SystemMessagePromptTemplate, ChatMessagePromptTemplate, MessagesPlaceholder, BaseChatPromptTemplate, } from "./chat.js";
 export { parseTemplate, renderTemplate, checkValidTemplate, } from "./template.js";
 export { PipelinePromptTemplate, } from "./pipeline.js";

package/dist/retrievers/zep.cjs

@@ -47,6 +47,12 @@ class ZepRetriever extends retriever_js_1.BaseRetriever {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "searchScope", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         Object.defineProperty(this, "searchType", {
             enumerable: true,
             configurable: true,
@@ -67,17 +73,18 @@ class ZepRetriever extends retriever_js_1.BaseRetriever {
         });
         this.sessionId = config.sessionId;
         this.topK = config.topK;
+        this.searchScope = config.searchScope;
         this.searchType = config.searchType;
         this.mmrLambda = config.mmrLambda;
         this.filter = config.filter;
         this.zepClientPromise = zep_js_1.ZepClient.init(config.url, config.apiKey);
     }
     /**
-     *  Converts an array of search results to an array of Document objects.
+     *  Converts an array of message search results to an array of Document objects.
      *  @param {MemorySearchResult[]} results - The array of search results.
      *  @returns {Document[]} An array of Document objects representing the search results.
      */
-    searchResultToDoc(results) {
+    searchMessageResultToDoc(results) {
         return results
             .filter((r) => r.message)
             .map(({ message: { content, metadata: messageMetadata } = {}, dist, ...rest }) => new document_js_1.Document({
@@ -85,6 +92,19 @@ class ZepRetriever extends retriever_js_1.BaseRetriever {
             metadata: { score: dist, ...messageMetadata, ...rest },
         }));
     }
+    /**
+     *  Converts an array of summary search results to an array of Document objects.
+     *  @param {MemorySearchResult[]} results - The array of search results.
+     *  @returns {Document[]} An array of Document objects representing the search results.
+     */
+    searchSummaryResultToDoc(results) {
+        return results
+            .filter((r) => r.summary)
+            .map(({ summary: { content, metadata: summaryMetadata } = {}, dist, ...rest }) => new document_js_1.Document({
+            pageContent: content ?? "",
+            metadata: { score: dist, ...summaryMetadata, ...rest },
+        }));
+    }
     /**
      *  Retrieves the relevant documents based on the given query.
      *  @param {string} query - The query string.
@@ -94,6 +114,7 @@ class ZepRetriever extends retriever_js_1.BaseRetriever {
         const payload = {
             text: query,
             metadata: this.filter,
+            search_scope: this.searchScope,
             search_type: this.searchType,
             mmr_lambda: this.mmrLambda,
         };
@@ -104,7 +125,9 @@ class ZepRetriever extends retriever_js_1.BaseRetriever {
         }
         try {
             const results = await zepClient.memory.searchMemory(this.sessionId, payload, this.topK);
-            return this.searchResultToDoc(results);
+            return this.searchScope === "summary"
+                ? this.searchSummaryResultToDoc(results)
+                : this.searchMessageResultToDoc(results);
         }
         catch (error) {
             // eslint-disable-next-line no-instanceof/no-instanceof

package/dist/retrievers/zep.d.ts

@@ -9,6 +9,7 @@ import { Document } from "../document.js";
  * @argument {string} url - The URL of the Zep API.
  * @argument {number} [topK] - The number of results to return.
  * @argument {string} [apiKey] - The API key for the Zep API.
+ * @argument [searchScope] [searchScope] - The scope of the search: "messages" or "summary".
  * @argument [searchType] [searchType] - The type of search to perform: "similarity" or "mmr".
  * @argument {number} [mmrLambda] - The lambda value for the MMR search.
  * @argument {Record<string, unknown>} [filter] - The metadata filter to apply to the search.
@@ -18,6 +19,7 @@ export interface ZepRetrieverConfig extends BaseRetrieverInput {
     url: string;
     topK?: number;
     apiKey?: string;
+    searchScope?: "messages" | "summary";
     searchType?: "similarity" | "mmr";
     mmrLambda?: number;
     filter?: Record<string, unknown>;
@@ -38,16 +40,23 @@ export declare class ZepRetriever extends BaseRetriever {
     zepClientPromise: Promise<ZepClient>;
     private sessionId;
     private topK?;
+    private searchScope?;
     private searchType?;
     private mmrLambda?;
     private filter?;
     constructor(config: ZepRetrieverConfig);
     /**
-     *  Converts an array of search results to an array of Document objects.
+     *  Converts an array of message search results to an array of Document objects.
      *  @param {MemorySearchResult[]} results - The array of search results.
      *  @returns {Document[]} An array of Document objects representing the search results.
      */
-    private searchResultToDoc;
+    private searchMessageResultToDoc;
+    /**
+     *  Converts an array of summary search results to an array of Document objects.
+     *  @param {MemorySearchResult[]} results - The array of search results.
+     *  @returns {Document[]} An array of Document objects representing the search results.
+     */
+    private searchSummaryResultToDoc;
     /**
      *  Retrieves the relevant documents based on the given query.
      *  @param {string} query - The query string.