langchain 0.0.202 → 0.0.204-rc.0

package/dist/retrievers/tavily_search_api.cjs

@@ -1,144 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TavilySearchAPIRetriever = void 0;
-const document_js_1 = require("../document.cjs");
-const retriever_js_1 = require("../schema/retriever.cjs");
-const env_js_1 = require("../util/env.cjs");
-/**
- * A class for retrieving documents related to a given search term
- * using the Tavily Search API.
- */
-class TavilySearchAPIRetriever extends retriever_js_1.BaseRetriever {
-    static lc_name() {
-        return "TavilySearchAPIRetriever";
-    }
-    get lc_namespace() {
-        return ["langchain", "retrievers", "tavily_search_api"];
-    }
-    constructor(fields) {
-        super(fields);
-        Object.defineProperty(this, "k", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 10
-        });
-        Object.defineProperty(this, "includeGeneratedAnswer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "includeRawContent", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "includeImages", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "searchDepth", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "basic"
-        });
-        Object.defineProperty(this, "includeDomains", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "excludeDomains", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "kwargs", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {}
-        });
-        Object.defineProperty(this, "apiKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.k = fields?.k ?? this.k;
-        this.includeGeneratedAnswer =
-            fields?.includeGeneratedAnswer ?? this.includeGeneratedAnswer;
-        this.includeRawContent =
-            fields?.includeRawContent ?? this.includeRawContent;
-        this.includeImages = fields?.includeImages ?? this.includeImages;
-        this.searchDepth = fields?.searchDepth ?? this.searchDepth;
-        this.includeDomains = fields?.includeDomains ?? this.includeDomains;
-        this.excludeDomains = fields?.excludeDomains ?? this.excludeDomains;
-        this.kwargs = fields?.kwargs ?? this.kwargs;
-        this.apiKey = fields?.apiKey ?? (0, env_js_1.getEnvironmentVariable)("TAVILY_API_KEY");
-        if (this.apiKey === undefined) {
-            throw new Error(`No Tavily API key found. Either set an environment variable named "TAVILY_API_KEY" or pass an API key as "apiKey".`);
-        }
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    async _getRelevantDocuments(query, _runManager) {
-        const body = {
-            query,
-            include_answer: this.includeGeneratedAnswer,
-            include_raw_content: this.includeRawContent,
-            include_images: this.includeImages,
-            max_results: this.k,
-            search_depth: this.searchDepth,
-            api_key: this.apiKey,
-        };
-        if (this.includeDomains) {
-            body.include_domains = this.includeDomains;
-        }
-        if (this.excludeDomains) {
-            body.exclude_domains = this.excludeDomains;
-        }
-        const response = await fetch("https://api.tavily.com/search", {
-            method: "POST",
-            headers: {
-                "content-type": "application/json",
-            },
-            body: JSON.stringify({ ...body, ...this.kwargs }),
-        });
-        const json = await response.json();
-        if (!response.ok) {
-            throw new Error(`Request failed with status code ${response.status}: ${json.error}`);
-        }
-        if (!Array.isArray(json.results)) {
-            throw new Error(`Could not parse Tavily results. Please try again.`);
-        }
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const docs = json.results.map((result) => {
-            const pageContent = this.includeRawContent
-                ? result.raw_content
-                : result.content;
-            const metadata = {
-                title: result.title,
-                source: result.url,
-                ...Object.fromEntries(Object.entries(result).filter(([k]) => !["content", "title", "url", "raw_content"].includes(k))),
-                images: json.images,
-            };
-            return new document_js_1.Document({ pageContent, metadata });
-        });
-        if (this.includeGeneratedAnswer) {
-            docs.push(new document_js_1.Document({
-                pageContent: json.answer,
-                metadata: {
-                    title: "Suggested Answer",
-                    source: "https://tavily.com/",
-                },
-            }));
-        }
-        return docs;
-    }
-}
-exports.TavilySearchAPIRetriever = TavilySearchAPIRetriever;
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@langchain/community/retrievers/tavily_search_api"), exports);

package/dist/retrievers/tavily_search_api.d.ts

@@ -1,38 +1 @@
-import { Document } from "../document.js";
-import { CallbackManagerForRetrieverRun } from "../callbacks/manager.js";
-import { BaseRetriever, type BaseRetrieverInput } from "../schema/retriever.js";
-/**
- * Options for the HydeRetriever class, which includes a BaseLanguageModel
- * instance, a VectorStore instance, and an optional promptTemplate which
- * can either be a BasePromptTemplate instance or a PromptKey.
- */
-export type TavilySearchAPIRetrieverFields = BaseRetrieverInput & {
-    k?: number;
-    includeGeneratedAnswer?: boolean;
-    includeRawContent?: boolean;
-    includeImages?: boolean;
-    searchDepth?: "basic" | "advanced";
-    includeDomains?: string[];
-    excludeDomains?: string[];
-    kwargs?: Record<string, unknown>;
-    apiKey?: string;
-};
-/**
- * A class for retrieving documents related to a given search term
- * using the Tavily Search API.
- */
-export declare class TavilySearchAPIRetriever extends BaseRetriever {
-    static lc_name(): string;
-    get lc_namespace(): string[];
-    k: number;
-    includeGeneratedAnswer: boolean;
-    includeRawContent: boolean;
-    includeImages: boolean;
-    searchDepth: string;
-    includeDomains?: string[];
-    excludeDomains?: string[];
-    kwargs: Record<string, unknown>;
-    apiKey?: string;
-    constructor(fields?: TavilySearchAPIRetrieverFields);
-    _getRelevantDocuments(query: string, _runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
-}
+export * from "@langchain/community/retrievers/tavily_search_api";

package/dist/retrievers/tavily_search_api.js

@@ -1,140 +1 @@
-import { Document } from "../document.js";
-import { BaseRetriever } from "../schema/retriever.js";
-import { getEnvironmentVariable } from "../util/env.js";
-/**
- * A class for retrieving documents related to a given search term
- * using the Tavily Search API.
- */
-export class TavilySearchAPIRetriever extends BaseRetriever {
-    static lc_name() {
-        return "TavilySearchAPIRetriever";
-    }
-    get lc_namespace() {
-        return ["langchain", "retrievers", "tavily_search_api"];
-    }
-    constructor(fields) {
-        super(fields);
-        Object.defineProperty(this, "k", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 10
-        });
-        Object.defineProperty(this, "includeGeneratedAnswer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "includeRawContent", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "includeImages", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "searchDepth", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "basic"
-        });
-        Object.defineProperty(this, "includeDomains", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "excludeDomains", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "kwargs", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {}
-        });
-        Object.defineProperty(this, "apiKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.k = fields?.k ?? this.k;
-        this.includeGeneratedAnswer =
-            fields?.includeGeneratedAnswer ?? this.includeGeneratedAnswer;
-        this.includeRawContent =
-            fields?.includeRawContent ?? this.includeRawContent;
-        this.includeImages = fields?.includeImages ?? this.includeImages;
-        this.searchDepth = fields?.searchDepth ?? this.searchDepth;
-        this.includeDomains = fields?.includeDomains ?? this.includeDomains;
-        this.excludeDomains = fields?.excludeDomains ?? this.excludeDomains;
-        this.kwargs = fields?.kwargs ?? this.kwargs;
-        this.apiKey = fields?.apiKey ?? getEnvironmentVariable("TAVILY_API_KEY");
-        if (this.apiKey === undefined) {
-            throw new Error(`No Tavily API key found. Either set an environment variable named "TAVILY_API_KEY" or pass an API key as "apiKey".`);
-        }
-    }
-    async _getRelevantDocuments(query, _runManager) {
-        const body = {
-            query,
-            include_answer: this.includeGeneratedAnswer,
-            include_raw_content: this.includeRawContent,
-            include_images: this.includeImages,
-            max_results: this.k,
-            search_depth: this.searchDepth,
-            api_key: this.apiKey,
-        };
-        if (this.includeDomains) {
-            body.include_domains = this.includeDomains;
-        }
-        if (this.excludeDomains) {
-            body.exclude_domains = this.excludeDomains;
-        }
-        const response = await fetch("https://api.tavily.com/search", {
-            method: "POST",
-            headers: {
-                "content-type": "application/json",
-            },
-            body: JSON.stringify({ ...body, ...this.kwargs }),
-        });
-        const json = await response.json();
-        if (!response.ok) {
-            throw new Error(`Request failed with status code ${response.status}: ${json.error}`);
-        }
-        if (!Array.isArray(json.results)) {
-            throw new Error(`Could not parse Tavily results. Please try again.`);
-        }
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const docs = json.results.map((result) => {
-            const pageContent = this.includeRawContent
-                ? result.raw_content
-                : result.content;
-            const metadata = {
-                title: result.title,
-                source: result.url,
-                ...Object.fromEntries(Object.entries(result).filter(([k]) => !["content", "title", "url", "raw_content"].includes(k))),
-                images: json.images,
-            };
-            return new Document({ pageContent, metadata });
-        });
-        if (this.includeGeneratedAnswer) {
-            docs.push(new Document({
-                pageContent: json.answer,
-                metadata: {
-                    title: "Suggested Answer",
-                    source: "https://tavily.com/",
-                },
-            }));
-        }
-        return docs;
-    }
-}
+export * from "@langchain/community/retrievers/tavily_search_api";

package/dist/retrievers/zep.cjs

@@ -1,152 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZepRetriever = void 0;
-const zep_js_1 = require("@getzep/zep-js");
-const retriever_js_1 = require("../schema/retriever.cjs");
-const document_js_1 = require("../document.cjs");
-/**
- * Class for retrieving information from a Zep long-term memory store.
- * Extends the BaseRetriever class.
- * @example
- * ```typescript
- * const retriever = new ZepRetriever({
- *   url: "http:
- *   sessionId: "session_exampleUUID",
- *   topK: 3,
- * });
- * const query = "Can I drive red cars in France?";
- * const docs = await retriever.getRelevantDocuments(query);
- * ```
- */
-class ZepRetriever extends retriever_js_1.BaseRetriever {
-    static lc_name() {
-        return "ZepRetriever";
-    }
-    get lc_secrets() {
-        return {
-            apiKey: "ZEP_API_KEY",
-            url: "ZEP_API_URL",
-        };
-    }
-    get lc_aliases() {
-        return { apiKey: "api_key" };
-    }
-    constructor(config) {
-        super(config);
-        Object.defineProperty(this, "lc_namespace", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ["langchain", "retrievers", "zep"]
-        });
-        Object.defineProperty(this, "zepClientPromise", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "sessionId", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "topK", {
-            enumerable: true,
-            configurable: true,
-            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,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "mmrLambda", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "filter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        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);
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    /**
-     *  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.
-     */
-    searchMessageResultToDoc(results) {
-        return results
-            .filter((r) => r.message)
-            .map(({ message: { content, metadata: messageMetadata } = {}, dist, ...rest }) => new document_js_1.Document({
-            pageContent: content ?? "",
-            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.
-     *  @returns {Promise<Document[]>} A promise that resolves to an array of relevant Document objects.
-     */
-    async _getRelevantDocuments(query) {
-        const payload = {
-            text: query,
-            metadata: this.filter,
-            search_scope: this.searchScope,
-            search_type: this.searchType,
-            mmr_lambda: this.mmrLambda,
-        };
-        // Wait for ZepClient to be initialized
-        const zepClient = await this.zepClientPromise;
-        if (!zepClient) {
-            throw new Error("ZepClient is not initialized");
-        }
-        try {
-            const results = await zepClient.memory.searchMemory(this.sessionId, payload, this.topK);
-            return this.searchScope === "summary"
-                ? this.searchSummaryResultToDoc(results)
-                : this.searchMessageResultToDoc(results);
-        }
-        catch (error) {
-            // eslint-disable-next-line no-instanceof/no-instanceof
-            if (error instanceof zep_js_1.NotFoundError) {
-                return Promise.resolve([]); // Return an empty Document array
-            }
-            // If it's not a NotFoundError, throw the error again
-            throw error;
-        }
-    }
-}
-exports.ZepRetriever = ZepRetriever;
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("@langchain/community/retrievers/zep"), exports);

package/dist/retrievers/zep.d.ts

@@ -1,76 +1 @@
-import { ZepClient } from "@getzep/zep-js";
-import { BaseRetriever, BaseRetrieverInput } from "../schema/retriever.js";
-import { Document } from "../document.js";
-/**
- * Configuration interface for the ZepRetriever class. Extends the
- * BaseRetrieverInput interface.
- *
- * @argument {string} sessionId - The ID of the Zep session.
- * @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.
- */
-export interface ZepRetrieverConfig extends BaseRetrieverInput {
-    sessionId: string;
-    url: string;
-    topK?: number;
-    apiKey?: string;
-    searchScope?: "messages" | "summary";
-    searchType?: "similarity" | "mmr";
-    mmrLambda?: number;
-    filter?: Record<string, unknown>;
-}
-/**
- * Class for retrieving information from a Zep long-term memory store.
- * Extends the BaseRetriever class.
- * @example
- * ```typescript
- * const retriever = new ZepRetriever({
- *   url: "http:
- *   sessionId: "session_exampleUUID",
- *   topK: 3,
- * });
- * const query = "Can I drive red cars in France?";
- * const docs = await retriever.getRelevantDocuments(query);
- * ```
- */
-export declare class ZepRetriever extends BaseRetriever {
-    static lc_name(): string;
-    lc_namespace: string[];
-    get lc_secrets(): {
-        [key: string]: string;
-    } | undefined;
-    get lc_aliases(): {
-        [key: string]: string;
-    } | undefined;
-    zepClientPromise: Promise<ZepClient>;
-    private sessionId;
-    private topK?;
-    private searchScope?;
-    private searchType?;
-    private mmrLambda?;
-    private filter?;
-    constructor(config: ZepRetrieverConfig);
-    /**
-     *  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 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.
-     *  @returns {Promise<Document[]>} A promise that resolves to an array of relevant Document objects.
-     */
-    _getRelevantDocuments(query: string): Promise<Document[]>;
-}
+export * from "@langchain/community/retrievers/zep";