langchain 0.0.164 → 0.0.166

package/dist/llms/sagemaker_endpoint.d.ts

@@ -1,5 +1,7 @@
 import { SageMakerRuntimeClient, SageMakerRuntimeClientConfig } from "@aws-sdk/client-sagemaker-runtime";
-import { LLM, BaseLLMParams } from "./base.js";
+import { CallbackManagerForLLMRun } from "../callbacks/manager.js";
+import { GenerationChunk } from "../schema/index.js";
+import { BaseLLMCallOptions, BaseLLMParams, LLM } from "./base.js";
 /**
  * A handler class to transform input from LLM to a format that SageMaker
  * endpoint expects. Similarily, the class also handles transforming output from
@@ -28,22 +30,22 @@ import { LLM, BaseLLMParams } from "./base.js";
  * ```
  */
 export declare abstract class BaseSageMakerContentHandler<InputType, OutputType> {
-    /** The MIME type of the input data passed to endpoint */
     contentType: string;
-    /** The MIME type of the response data returned from endpoint */
     accepts: string;
     /**
-     * Transforms the input to a format that model can accept as the request Body.
-     * Should return bytes or seekable file like object in the format specified in
-     * the contentType request header.
+     * Transforms the prompt and model arguments into a specific format for sending to SageMaker.
+     * @param {InputType} prompt The prompt to be transformed.
+     * @param {Record<string, unknown>} modelKwargs Additional arguments.
+     * @returns {Promise<Uint8Array>} A promise that resolves to the formatted data for sending.
      */
     abstract transformInput(prompt: InputType, modelKwargs: Record<string, unknown>): Promise<Uint8Array>;
     /**
-     * Transforms the output from the model to string that the LLM class expects.
+     * Transforms SageMaker output into a desired format.
+     * @param {Uint8Array} output The raw output from SageMaker.
+     * @returns {Promise<OutputType>} A promise that resolves to the transformed data.
      */
     abstract transformOutput(output: Uint8Array): Promise<OutputType>;
 }
-/** Content handler for LLM class. */
 export type SageMakerLLMContentHandler = BaseSageMakerContentHandler<string, string>;
 /**
  * The SageMakerEndpointInput interface defines the input parameters for
@@ -61,11 +63,6 @@ export interface SageMakerEndpointInput extends BaseLLMParams {
      * Options passed to the SageMaker client.
      */
     clientOptions: SageMakerRuntimeClientConfig;
-    /**
-     * The content handler class that provides an input and output transform
-     * functions to handle formats between LLM and the endpoint.
-     */
-    contentHandler: SageMakerLLMContentHandler;
     /**
      * Key word arguments to pass to the model.
      */
@@ -74,29 +71,51 @@ export interface SageMakerEndpointInput extends BaseLLMParams {
      * Optional attributes passed to the InvokeEndpointCommand
      */
     endpointKwargs?: Record<string, unknown>;
+    /**
+     * The content handler class that provides an input and output transform
+     * functions to handle formats between LLM and the endpoint.
+     */
+    contentHandler: SageMakerLLMContentHandler;
+    streaming?: boolean;
 }
 /**
  * The SageMakerEndpoint class is used to interact with SageMaker
- * Inference Endpoint models. It extends the LLM class and overrides the
- * _call method to transform the input and output between the LLM and the
- * SageMaker endpoint using the provided content handler. The class uses
- * AWS client for authentication, which automatically loads credentials.
+ * Inference Endpoint models. It uses the AWS client for authentication,
+ * which automatically loads credentials.
  * If a specific credential profile is to be used, the name of the profile
  * from the ~/.aws/credentials file must be passed. The credentials or
  * roles used should have the required policies to access the SageMaker
  * endpoint.
  */
-export declare class SageMakerEndpoint extends LLM {
+export declare class SageMakerEndpoint extends LLM<BaseLLMCallOptions> {
+    static lc_name(): string;
     get lc_secrets(): {
         [key: string]: string;
     } | undefined;
     endpointName: string;
-    contentHandler: SageMakerLLMContentHandler;
     modelKwargs?: Record<string, unknown>;
     endpointKwargs?: Record<string, unknown>;
     client: SageMakerRuntimeClient;
+    contentHandler: SageMakerLLMContentHandler;
+    streaming: boolean;
     constructor(fields: SageMakerEndpointInput);
     _llmType(): string;
+    /**
+     * Calls the SageMaker endpoint and retrieves the result.
+     * @param {string} prompt The input prompt.
+     * @param {this["ParsedCallOptions"]} options Parsed call options.
+     * @param {CallbackManagerForLLMRun} _runManager Optional run manager.
+     * @returns {Promise<string>} A promise that resolves to the generated string.
+     */
     /** @ignore */
-    _call(prompt: string, options: this["ParsedCallOptions"]): Promise<string>;
+    _call(prompt: string, options: this["ParsedCallOptions"], _runManager?: CallbackManagerForLLMRun): Promise<string>;
+    private streamingCall;
+    private noStreamingCall;
+    /**
+     * Streams response chunks from the SageMaker endpoint.
+     * @param {string} prompt The input prompt.
+     * @param {this["ParsedCallOptions"]} options Parsed call options.
+     * @returns {AsyncGenerator<GenerationChunk>} An asynchronous generator yielding generation chunks.
+     */
+    _streamResponseChunks(prompt: string, options: this["ParsedCallOptions"]): AsyncGenerator<GenerationChunk>;
 }

package/dist/llms/sagemaker_endpoint.js

@@ -1,4 +1,5 @@
-import { SageMakerRuntimeClient, InvokeEndpointCommand, } from "@aws-sdk/client-sagemaker-runtime";
+import { InvokeEndpointCommand, InvokeEndpointWithResponseStreamCommand, SageMakerRuntimeClient, } from "@aws-sdk/client-sagemaker-runtime";
+import { GenerationChunk } from "../schema/index.js";
 import { LLM } from "./base.js";
 /**
  * A handler class to transform input from LLM to a format that SageMaker
@@ -29,14 +30,12 @@ import { LLM } from "./base.js";
  */
 export class BaseSageMakerContentHandler {
     constructor() {
-        /** The MIME type of the input data passed to endpoint */
         Object.defineProperty(this, "contentType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: "text/plain"
         });
-        /** The MIME type of the response data returned from endpoint */
         Object.defineProperty(this, "accepts", {
             enumerable: true,
             configurable: true,
@@ -47,16 +46,17 @@ export class BaseSageMakerContentHandler {
 }
 /**
  * The SageMakerEndpoint class is used to interact with SageMaker
- * Inference Endpoint models. It extends the LLM class and overrides the
- * _call method to transform the input and output between the LLM and the
- * SageMaker endpoint using the provided content handler. The class uses
- * AWS client for authentication, which automatically loads credentials.
+ * Inference Endpoint models. It uses the AWS client for authentication,
+ * which automatically loads credentials.
  * If a specific credential profile is to be used, the name of the profile
  * from the ~/.aws/credentials file must be passed. The credentials or
  * roles used should have the required policies to access the SageMaker
  * endpoint.
  */
 export class SageMakerEndpoint extends LLM {
+    static lc_name() {
+        return "SageMakerEndpoint";
+    }
     get lc_secrets() {
         return {
             "clientOptions.credentials.accessKeyId": "AWS_ACCESS_KEY_ID",
@@ -65,39 +65,44 @@ export class SageMakerEndpoint extends LLM {
         };
     }
     constructor(fields) {
-        super(fields ?? {});
+        super(fields);
         Object.defineProperty(this, "endpointName", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "contentHandler", {
+        Object.defineProperty(this, "modelKwargs", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "modelKwargs", {
+        Object.defineProperty(this, "endpointKwargs", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "endpointKwargs", {
+        Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        Object.defineProperty(this, "client", {
+        Object.defineProperty(this, "contentHandler", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
-        const regionName = fields.clientOptions.region;
-        if (!regionName) {
+        Object.defineProperty(this, "streaming", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        if (!fields.clientOptions.region) {
             throw new Error(`Please pass a "clientOptions" object with a "region" field to the constructor`);
         }
         const endpointName = fields?.endpointName;
@@ -112,13 +117,33 @@ export class SageMakerEndpoint extends LLM {
         this.contentHandler = fields.contentHandler;
         this.endpointKwargs = fields.endpointKwargs;
         this.modelKwargs = fields.modelKwargs;
+        this.streaming = fields.streaming ?? false;
         this.client = new SageMakerRuntimeClient(fields.clientOptions);
     }
     _llmType() {
         return "sagemaker_endpoint";
     }
+    /**
+     * Calls the SageMaker endpoint and retrieves the result.
+     * @param {string} prompt The input prompt.
+     * @param {this["ParsedCallOptions"]} options Parsed call options.
+     * @param {CallbackManagerForLLMRun} _runManager Optional run manager.
+     * @returns {Promise<string>} A promise that resolves to the generated string.
+     */
     /** @ignore */
-    async _call(prompt, options) {
+    async _call(prompt, options, _runManager) {
+        return this.streaming
+            ? await this.streamingCall(prompt, options)
+            : await this.noStreamingCall(prompt, options);
+    }
+    async streamingCall(prompt, options) {
+        const chunks = [];
+        for await (const chunk of this._streamResponseChunks(prompt, options)) {
+            chunks.push(chunk.text);
+        }
+        return chunks.join("");
+    }
+    async noStreamingCall(prompt, options) {
         const body = await this.contentHandler.transformInput(prompt, this.modelKwargs ?? {});
         const { contentType, accepts } = this.contentHandler;
         const response = await this.caller.call(() => this.client.send(new InvokeEndpointCommand({
@@ -133,4 +158,41 @@ export class SageMakerEndpoint extends LLM {
         }
         return this.contentHandler.transformOutput(response.Body);
     }
+    /**
+     * Streams response chunks from the SageMaker endpoint.
+     * @param {string} prompt The input prompt.
+     * @param {this["ParsedCallOptions"]} options Parsed call options.
+     * @returns {AsyncGenerator<GenerationChunk>} An asynchronous generator yielding generation chunks.
+     */
+    async *_streamResponseChunks(prompt, options) {
+        const body = await this.contentHandler.transformInput(prompt, this.modelKwargs ?? {});
+        const { contentType, accepts } = this.contentHandler;
+        const stream = await this.caller.call(() => this.client.send(new InvokeEndpointWithResponseStreamCommand({
+            EndpointName: this.endpointName,
+            Body: body,
+            ContentType: contentType,
+            Accept: accepts,
+            ...this.endpointKwargs,
+        }), { abortSignal: options.signal }));
+        if (!stream.Body) {
+            throw new Error("Inference result missing Body");
+        }
+        for await (const chunk of stream.Body) {
+            if (chunk.PayloadPart && chunk.PayloadPart.Bytes) {
+                yield new GenerationChunk({
+                    text: await this.contentHandler.transformOutput(chunk.PayloadPart.Bytes),
+                    generationInfo: {
+                        ...chunk,
+                        response: undefined,
+                    },
+                });
+            }
+            else if (chunk.InternalStreamFailure) {
+                throw new Error(chunk.InternalStreamFailure.message);
+            }
+            else if (chunk.ModelStreamError) {
+                throw new Error(chunk.ModelStreamError.message);
+            }
+        }
+    }
 }

package/dist/load/import_constants.cjs

@@ -37,8 +37,10 @@ exports.optionalImportEntrypoints = [
     "langchain/llms/bedrock",
     "langchain/llms/llama_cpp",
     "langchain/llms/writer",
+    "langchain/llms/portkey",
     "langchain/prompts/load",
     "langchain/vectorstores/analyticdb",
+    "langchain/vectorstores/cassandra",
     "langchain/vectorstores/elasticsearch",
     "langchain/vectorstores/cloudflare_vectorize",
     "langchain/vectorstores/chroma",
@@ -47,6 +49,7 @@ exports.optionalImportEntrypoints = [
     "langchain/vectorstores/faiss",
     "langchain/vectorstores/weaviate",
     "langchain/vectorstores/lancedb",
+    "langchain/vectorstores/momento_vector_index",
     "langchain/vectorstores/mongo",
     "langchain/vectorstores/mongodb_atlas",
     "langchain/vectorstores/pinecone",
@@ -101,6 +104,7 @@ exports.optionalImportEntrypoints = [
     "langchain/document_loaders/fs/openai_whisper_audio",
     "langchain/document_transformers/html_to_text",
     "langchain/document_transformers/mozilla_readability",
+    "langchain/chat_models/portkey",
     "langchain/chat_models/bedrock",
     "langchain/chat_models/googlevertexai",
     "langchain/chat_models/googlevertexai/web",

package/dist/load/import_constants.js

@@ -34,8 +34,10 @@ export const optionalImportEntrypoints = [
     "langchain/llms/bedrock",
     "langchain/llms/llama_cpp",
     "langchain/llms/writer",
+    "langchain/llms/portkey",
     "langchain/prompts/load",
     "langchain/vectorstores/analyticdb",
+    "langchain/vectorstores/cassandra",
     "langchain/vectorstores/elasticsearch",
     "langchain/vectorstores/cloudflare_vectorize",
     "langchain/vectorstores/chroma",
@@ -44,6 +46,7 @@ export const optionalImportEntrypoints = [
     "langchain/vectorstores/faiss",
     "langchain/vectorstores/weaviate",
     "langchain/vectorstores/lancedb",
+    "langchain/vectorstores/momento_vector_index",
     "langchain/vectorstores/mongo",
     "langchain/vectorstores/mongodb_atlas",
     "langchain/vectorstores/pinecone",
@@ -98,6 +101,7 @@ export const optionalImportEntrypoints = [
     "langchain/document_loaders/fs/openai_whisper_audio",
     "langchain/document_transformers/html_to_text",
     "langchain/document_transformers/mozilla_readability",
+    "langchain/chat_models/portkey",
     "langchain/chat_models/bedrock",
     "langchain/chat_models/googlevertexai",
     "langchain/chat_models/googlevertexai/web",

package/dist/load/import_map.cjs

@@ -25,7 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.retrievers__remote = exports.output_parsers = exports.callbacks = exports.schema__storage = exports.schema__runnable = exports.schema__retriever = exports.schema__query_constructor = exports.schema__output_parser = exports.schema__document = exports.schema = exports.chat_models__minimax = exports.chat_models__ollama = exports.chat_models__baiduwenxin = exports.chat_models__fireworks = exports.chat_models__anthropic = exports.chat_models__openai = exports.chat_models__base = exports.document_transformers__openai_functions = exports.document_loaders__web__sort_xyz_blockchain = exports.document_loaders__web__serpapi = exports.document_loaders__web__searchapi = exports.document_loaders__base = exports.document = exports.memory = exports.text_splitter = exports.vectorstores__xata = exports.vectorstores__vectara = exports.vectorstores__prisma = exports.vectorstores__memory = exports.vectorstores__base = exports.prompts = exports.llms__fireworks = exports.llms__ollama = exports.llms__aleph_alpha = exports.llms__ai21 = exports.llms__openai = exports.llms__base = exports.embeddings__minimax = exports.embeddings__openai = exports.embeddings__ollama = exports.embeddings__fake = exports.embeddings__cache_backed = exports.embeddings__base = exports.chains__openai_functions = exports.chains = exports.tools = exports.base_language = exports.agents__toolkits = exports.agents = exports.load__serializable = void 0;
-exports.evaluation = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__autogpt = exports.util__math = exports.storage__in_memory = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.cache = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__embeddings_filter = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__tavily_search_api = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__databerry = exports.retrievers__chaindesk = void 0;
+exports.runnables__remote = exports.evaluation = exports.experimental__chat_models__bittensor = exports.experimental__plan_and_execute = exports.experimental__generative_agents = exports.experimental__babyagi = exports.experimental__autogpt = exports.util__time = exports.util__math = exports.storage__in_memory = exports.stores__message__in_memory = exports.stores__file__in_memory = exports.stores__doc__in_memory = exports.cache = exports.retrievers__vespa = exports.retrievers__score_threshold = exports.retrievers__hyde = exports.retrievers__document_compressors__embeddings_filter = exports.retrievers__document_compressors__chain_extract = exports.retrievers__time_weighted = exports.retrievers__tavily_search_api = exports.retrievers__parent_document = exports.retrievers__multi_vector = exports.retrievers__multi_query = exports.retrievers__document_compressors = exports.retrievers__contextual_compression = exports.retrievers__databerry = exports.retrievers__chaindesk = void 0;
 exports.load__serializable = __importStar(require("../load/serializable.cjs"));
 exports.agents = __importStar(require("../agents/index.cjs"));
 exports.agents__toolkits = __importStar(require("../agents/toolkits/index.cjs"));
@@ -96,9 +96,11 @@ exports.stores__file__in_memory = __importStar(require("../stores/file/in_memory
 exports.stores__message__in_memory = __importStar(require("../stores/message/in_memory.cjs"));
 exports.storage__in_memory = __importStar(require("../storage/in_memory.cjs"));
 exports.util__math = __importStar(require("../util/math.cjs"));
+exports.util__time = __importStar(require("../util/time.cjs"));
 exports.experimental__autogpt = __importStar(require("../experimental/autogpt/index.cjs"));
 exports.experimental__babyagi = __importStar(require("../experimental/babyagi/index.cjs"));
 exports.experimental__generative_agents = __importStar(require("../experimental/generative_agents/index.cjs"));
 exports.experimental__plan_and_execute = __importStar(require("../experimental/plan_and_execute/index.cjs"));
 exports.experimental__chat_models__bittensor = __importStar(require("../experimental/chat_models/bittensor.cjs"));
 exports.evaluation = __importStar(require("../evaluation/index.cjs"));
+exports.runnables__remote = __importStar(require("../runnables/remote.cjs"));

package/dist/load/import_map.d.ts

@@ -68,9 +68,11 @@ export * as stores__file__in_memory from "../stores/file/in_memory.js";
 export * as stores__message__in_memory from "../stores/message/in_memory.js";
 export * as storage__in_memory from "../storage/in_memory.js";
 export * as util__math from "../util/math.js";
+export * as util__time from "../util/time.js";
 export * as experimental__autogpt from "../experimental/autogpt/index.js";
 export * as experimental__babyagi from "../experimental/babyagi/index.js";
 export * as experimental__generative_agents from "../experimental/generative_agents/index.js";
 export * as experimental__plan_and_execute from "../experimental/plan_and_execute/index.js";
 export * as experimental__chat_models__bittensor from "../experimental/chat_models/bittensor.js";
 export * as evaluation from "../evaluation/index.js";
+export * as runnables__remote from "../runnables/remote.js";

package/dist/load/import_map.js

@@ -69,9 +69,11 @@ export * as stores__file__in_memory from "../stores/file/in_memory.js";
 export * as stores__message__in_memory from "../stores/message/in_memory.js";
 export * as storage__in_memory from "../storage/in_memory.js";
 export * as util__math from "../util/math.js";
+export * as util__time from "../util/time.js";
 export * as experimental__autogpt from "../experimental/autogpt/index.js";
 export * as experimental__babyagi from "../experimental/babyagi/index.js";
 export * as experimental__generative_agents from "../experimental/generative_agents/index.js";
 export * as experimental__plan_and_execute from "../experimental/plan_and_execute/index.js";
 export * as experimental__chat_models__bittensor from "../experimental/chat_models/bittensor.js";
 export * as evaluation from "../evaluation/index.js";
+export * as runnables__remote from "../runnables/remote.js";

package/dist/output_parsers/list.cjs

@@ -119,7 +119,7 @@ class CustomListOutputParser extends ListOutputParser {
      * @returns A string containing instructions on the expected format of the response.
      */
     getFormatInstructions() {
-        return `Your response should be a list of ${this.length} items separated by "${this.separator}" (eg: \`foo${this.separator} bar${this.separator} baz\`)`;
+        return `Your response should be a list of ${this.length === undefined ? "" : `${this.length} `}items separated by "${this.separator}" (eg: \`foo${this.separator} bar${this.separator} baz\`)`;
     }
 }
 exports.CustomListOutputParser = CustomListOutputParser;

package/dist/output_parsers/list.js

@@ -114,6 +114,6 @@ export class CustomListOutputParser extends ListOutputParser {
      * @returns A string containing instructions on the expected format of the response.
      */
     getFormatInstructions() {
-        return `Your response should be a list of ${this.length} items separated by "${this.separator}" (eg: \`foo${this.separator} bar${this.separator} baz\`)`;
+        return `Your response should be a list of ${this.length === undefined ? "" : `${this.length} `}items separated by "${this.separator}" (eg: \`foo${this.separator} bar${this.separator} baz\`)`;
     }
 }

package/dist/prompts/chat.cjs

@@ -107,8 +107,25 @@ class MessagesPlaceholder extends BaseMessagePromptTemplate {
     get inputVariables() {
         return [this.variableName];
     }
-    formatMessages(values) {
-        return Promise.resolve(values[this.variableName]);
+    validateInputOrThrow(input, variableName) {
+        let isInputBaseMessage = false;
+        if (Array.isArray(input)) {
+            isInputBaseMessage = input.every((message) => (0, index_js_1.isBaseMessage)(message));
+        }
+        else {
+            isInputBaseMessage = (0, index_js_1.isBaseMessage)(input);
+        }
+        if (!isInputBaseMessage) {
+            const readableInput = typeof input === "string" ? input : JSON.stringify(input, null, 2);
+            const error = new Error(`Error: Field "${variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: ${readableInput}`);
+            error.name = "InputFormatError";
+            throw error;
+        }
+        return true;
+    }
+    async formatMessages(values) {
+        this.validateInputOrThrow(values[this.variableName], this.variableName);
+        return values[this.variableName];
     }
 }
 exports.MessagesPlaceholder = MessagesPlaceholder;

package/dist/prompts/chat.d.ts

@@ -62,6 +62,7 @@ export declare class MessagesPlaceholder<RunInput extends InputValues = any> ext
     constructor(variableName: Extract<keyof RunInput, string>);
     constructor(fields: MessagePlaceholderFields<Extract<keyof RunInput, string>>);
     get inputVariables(): Extract<keyof RunInput, string>[];
+    validateInputOrThrow(input: Array<unknown>, variableName: Extract<keyof RunInput, string>): input is BaseMessage[];
     formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
 }
 /**

package/dist/prompts/chat.js

@@ -102,8 +102,25 @@ export class MessagesPlaceholder extends BaseMessagePromptTemplate {
     get inputVariables() {
         return [this.variableName];
     }
-    formatMessages(values) {
-        return Promise.resolve(values[this.variableName]);
+    validateInputOrThrow(input, variableName) {
+        let isInputBaseMessage = false;
+        if (Array.isArray(input)) {
+            isInputBaseMessage = input.every((message) => isBaseMessage(message));
+        }
+        else {
+            isInputBaseMessage = isBaseMessage(input);
+        }
+        if (!isInputBaseMessage) {
+            const readableInput = typeof input === "string" ? input : JSON.stringify(input, null, 2);
+            const error = new Error(`Error: Field "${variableName}" in prompt uses a MessagesPlaceholder, which expects an array of BaseMessages as an input value. Received: ${readableInput}`);
+            error.name = "InputFormatError";
+            throw error;
+        }
+        return true;
+    }
+    async formatMessages(values) {
+        this.validateInputOrThrow(values[this.variableName], this.variableName);
+        return values[this.variableName];
     }
 }
 /**

package/dist/retrievers/self_query/base.cjs

@@ -102,7 +102,7 @@ class BasicTranslator extends BaseTranslator {
         }
         return nextArg;
     }
-    mergeFilters(defaultFilter, generatedFilter, mergeType = "and") {
+    mergeFilters(defaultFilter, generatedFilter, mergeType = "and", forceDefaultFilter = false) {
         if ((0, utils_js_1.isFilterEmpty)(defaultFilter) && (0, utils_js_1.isFilterEmpty)(generatedFilter)) {
             return undefined;
         }
@@ -113,6 +113,9 @@ class BasicTranslator extends BaseTranslator {
             return generatedFilter;
         }
         if ((0, utils_js_1.isFilterEmpty)(generatedFilter)) {
+            if (forceDefaultFilter) {
+                return defaultFilter;
+            }
             if (mergeType === "and") {
                 return undefined;
             }

package/dist/retrievers/self_query/base.d.ts

@@ -26,9 +26,10 @@ export declare abstract class BaseTranslator<T extends VectorStore = VectorStore
      * @param defaultFilter The default filter.
      * @param generatedFilter The generated filter.
      * @param mergeType The type of merge to perform. Can be 'and', 'or', or 'replace'.
+     * @param forceDefaultFilter If true, the default filter will be used even if the generated filter is not empty.
      * @returns The merged filter, or undefined if both filters are empty.
      */
-    abstract mergeFilters(defaultFilter: this["VisitStructuredQueryOutput"]["filter"] | undefined, generatedFilter: this["VisitStructuredQueryOutput"]["filter"] | undefined, mergeType?: "and" | "or" | "replace"): this["VisitStructuredQueryOutput"]["filter"] | undefined;
+    abstract mergeFilters(defaultFilter: this["VisitStructuredQueryOutput"]["filter"] | undefined, generatedFilter: this["VisitStructuredQueryOutput"]["filter"] | undefined, mergeType?: "and" | "or" | "replace", forceDefaultFilter?: boolean): this["VisitStructuredQueryOutput"]["filter"] | undefined;
 }
 /**
  * Class that extends the BaseTranslator class and provides concrete
@@ -64,5 +65,5 @@ export declare class BasicTranslator<T extends VectorStore = VectorStore> extend
      * @returns The result of visiting the structured query.
      */
     visitStructuredQuery(query: StructuredQuery): this["VisitStructuredQueryOutput"];
-    mergeFilters(defaultFilter: VisitorStructuredQueryResult["filter"] | undefined, generatedFilter: VisitorStructuredQueryResult["filter"] | undefined, mergeType?: string): VisitorStructuredQueryResult["filter"] | undefined;
+    mergeFilters(defaultFilter: VisitorStructuredQueryResult["filter"] | undefined, generatedFilter: VisitorStructuredQueryResult["filter"] | undefined, mergeType?: string, forceDefaultFilter?: boolean): VisitorStructuredQueryResult["filter"] | undefined;
 }

package/dist/retrievers/self_query/base.js

@@ -98,7 +98,7 @@ export class BasicTranslator extends BaseTranslator {
         }
         return nextArg;
     }
-    mergeFilters(defaultFilter, generatedFilter, mergeType = "and") {
+    mergeFilters(defaultFilter, generatedFilter, mergeType = "and", forceDefaultFilter = false) {
         if (isFilterEmpty(defaultFilter) && isFilterEmpty(generatedFilter)) {
             return undefined;
         }
@@ -109,6 +109,9 @@ export class BasicTranslator extends BaseTranslator {
             return generatedFilter;
         }
         if (isFilterEmpty(generatedFilter)) {
+            if (forceDefaultFilter) {
+                return defaultFilter;
+            }
             if (mergeType === "and") {
                 return undefined;
             }

package/dist/retrievers/self_query/index.cjs

@@ -56,7 +56,7 @@ class SelfQueryRetriever extends retriever_js_1.BaseRetriever {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: { k: 4 }
+            value: { k: 4, forceDefaultFilter: false }
         });
         this.vectorStore = options.vectorStore;
         this.llmChain = options.llmChain;
@@ -71,7 +71,7 @@ class SelfQueryRetriever extends retriever_js_1.BaseRetriever {
         }, runManager?.getChild("llm_chain"));
         const generatedStructuredQuery = output;
         const nextArg = this.structuredQueryTranslator.visitStructuredQuery(generatedStructuredQuery);
-        const filter = this.structuredQueryTranslator.mergeFilters(this.searchParams?.filter, nextArg.filter, this.searchParams?.mergeFiltersOperator);
+        const filter = this.structuredQueryTranslator.mergeFilters(this.searchParams?.filter, nextArg.filter, this.searchParams?.mergeFiltersOperator, this.searchParams?.forceDefaultFilter);
         const generatedQuery = generatedStructuredQuery.query;
         let myQuery = query;
         if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {

package/dist/retrievers/self_query/index.d.ts

@@ -21,6 +21,7 @@ export interface SelfQueryRetrieverArgs<T extends VectorStore> extends BaseRetri
         k?: number;
         filter?: T["FilterType"];
         mergeFiltersOperator?: "or" | "and" | "replace";
+        forceDefaultFilter?: boolean;
     };
 }
 /**
@@ -40,6 +41,7 @@ export declare class SelfQueryRetriever<T extends VectorStore> extends BaseRetri
         k?: number;
         filter?: T["FilterType"];
         mergeFiltersOperator?: "or" | "and" | "replace";
+        forceDefaultFilter?: boolean;
     };
     constructor(options: SelfQueryRetrieverArgs<T>);
     _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, unknown>>[]>;

package/dist/retrievers/self_query/index.js

@@ -51,7 +51,7 @@ export class SelfQueryRetriever extends BaseRetriever {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: { k: 4 }
+            value: { k: 4, forceDefaultFilter: false }
         });
         this.vectorStore = options.vectorStore;
         this.llmChain = options.llmChain;
@@ -66,7 +66,7 @@ export class SelfQueryRetriever extends BaseRetriever {
         }, runManager?.getChild("llm_chain"));
         const generatedStructuredQuery = output;
         const nextArg = this.structuredQueryTranslator.visitStructuredQuery(generatedStructuredQuery);
-        const filter = this.structuredQueryTranslator.mergeFilters(this.searchParams?.filter, nextArg.filter, this.searchParams?.mergeFiltersOperator);
+        const filter = this.structuredQueryTranslator.mergeFilters(this.searchParams?.filter, nextArg.filter, this.searchParams?.mergeFiltersOperator, this.searchParams?.forceDefaultFilter);
         const generatedQuery = generatedStructuredQuery.query;
         let myQuery = query;
         if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {