langchain 0.0.203 → 0.0.204-rc.1

package/dist/tools/serpapi.js

@@ -1,197 +1 @@
-import { getEnvironmentVariable } from "../util/env.js";
-import { Tool } from "./base.js";
-/**
- * Wrapper around SerpAPI.
- *
- * To use, you should have the `serpapi` package installed and the SERPAPI_API_KEY environment variable set.
- */
-export class SerpAPI extends Tool {
-    static lc_name() {
-        return "SerpAPI";
-    }
-    toJSON() {
-        return this.toJSONNotImplemented();
-    }
-    constructor(apiKey = getEnvironmentVariable("SERPAPI_API_KEY"), params = {}, baseUrl = "https://serpapi.com") {
-        super(...arguments);
-        Object.defineProperty(this, "key", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "baseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "search"
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "a search engine. useful for when you need to answer questions about current events. input should be a search query."
-        });
-        if (!apiKey) {
-            throw new Error("SerpAPI API key not set. You can set it as SERPAPI_API_KEY in your .env file, or pass it to SerpAPI.");
-        }
-        this.key = apiKey;
-        this.params = params;
-        this.baseUrl = baseUrl;
-    }
-    /**
-     * Builds a URL for the SerpAPI request.
-     * @param path The path for the request.
-     * @param parameters The parameters for the request.
-     * @param baseUrl The base URL for the request.
-     * @returns A string representing the built URL.
-     */
-    buildUrl(path, parameters, baseUrl) {
-        const nonUndefinedParams = Object.entries(parameters)
-            .filter(([_, value]) => value !== undefined)
-            .map(([key, value]) => [key, `${value}`]);
-        const searchParams = new URLSearchParams(nonUndefinedParams);
-        return `${baseUrl}/${path}?${searchParams}`;
-    }
-    /** @ignore */
-    async _call(input) {
-        const { timeout, ...params } = this.params;
-        const resp = await fetch(this.buildUrl("search", {
-            ...params,
-            api_key: this.key,
-            q: input,
-        }, this.baseUrl), {
-            signal: timeout ? AbortSignal.timeout(timeout) : undefined,
-        });
-        const res = await resp.json();
-        if (res.error) {
-            throw new Error(`Got error from serpAPI: ${res.error}`);
-        }
-        const answer_box = res.answer_box_list
-            ? res.answer_box_list[0]
-            : res.answer_box;
-        if (answer_box) {
-            if (answer_box.result) {
-                return answer_box.result;
-            }
-            else if (answer_box.answer) {
-                return answer_box.answer;
-            }
-            else if (answer_box.snippet) {
-                return answer_box.snippet;
-            }
-            else if (answer_box.snippet_highlighted_words) {
-                return answer_box.snippet_highlighted_words.toString();
-            }
-            else {
-                const answer = {};
-                Object.keys(answer_box)
-                    .filter((k) => !Array.isArray(answer_box[k]) &&
-                    typeof answer_box[k] !== "object" &&
-                    !(typeof answer_box[k] === "string" &&
-                        answer_box[k].startsWith("http")))
-                    .forEach((k) => {
-                    answer[k] = answer_box[k];
-                });
-                return JSON.stringify(answer);
-            }
-        }
-        if (res.events_results) {
-            return JSON.stringify(res.events_results);
-        }
-        if (res.sports_results) {
-            return JSON.stringify(res.sports_results);
-        }
-        if (res.top_stories) {
-            return JSON.stringify(res.top_stories);
-        }
-        if (res.news_results) {
-            return JSON.stringify(res.news_results);
-        }
-        if (res.jobs_results?.jobs) {
-            return JSON.stringify(res.jobs_results.jobs);
-        }
-        if (res.questions_and_answers) {
-            return JSON.stringify(res.questions_and_answers);
-        }
-        if (res.popular_destinations?.destinations) {
-            return JSON.stringify(res.popular_destinations.destinations);
-        }
-        if (res.top_sights?.sights) {
-            const sights = res.top_sights.sights
-                .map((s) => ({
-                title: s.title,
-                description: s.description,
-                price: s.price,
-            }))
-                .slice(0, 8);
-            return JSON.stringify(sights);
-        }
-        if (res.shopping_results && res.shopping_results[0]?.title) {
-            return JSON.stringify(res.shopping_results.slice(0, 3));
-        }
-        if (res.images_results && res.images_results[0]?.thumbnail) {
-            return res.images_results
-                .map((ir) => ir.thumbnail)
-                .slice(0, 10)
-                .toString();
-        }
-        const snippets = [];
-        if (res.knowledge_graph) {
-            if (res.knowledge_graph.description) {
-                snippets.push(res.knowledge_graph.description);
-            }
-            const title = res.knowledge_graph.title || "";
-            Object.keys(res.knowledge_graph)
-                .filter((k) => typeof res.knowledge_graph[k] === "string" &&
-                k !== "title" &&
-                k !== "description" &&
-                !k.endsWith("_stick") &&
-                !k.endsWith("_link") &&
-                !k.startsWith("http"))
-                .forEach((k) => snippets.push(`${title} ${k}: ${res.knowledge_graph[k]}`));
-        }
-        const first_organic_result = res.organic_results?.[0];
-        if (first_organic_result) {
-            if (first_organic_result.snippet) {
-                snippets.push(first_organic_result.snippet);
-            }
-            else if (first_organic_result.snippet_highlighted_words) {
-                snippets.push(first_organic_result.snippet_highlighted_words);
-            }
-            else if (first_organic_result.rich_snippet) {
-                snippets.push(first_organic_result.rich_snippet);
-            }
-            else if (first_organic_result.rich_snippet_table) {
-                snippets.push(first_organic_result.rich_snippet_table);
-            }
-            else if (first_organic_result.link) {
-                snippets.push(first_organic_result.link);
-            }
-        }
-        if (res.buying_guide) {
-            snippets.push(res.buying_guide);
-        }
-        if (res.local_results?.places) {
-            snippets.push(res.local_results.places);
-        }
-        if (snippets.length > 0) {
-            return JSON.stringify(snippets);
-        }
-        else {
-            return "No good search result found";
-        }
-    }
-}
+export * from "@langchain/community/tools/serpapi";

package/dist/tools/serper.cjs

@@ -1,96 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Serper = void 0;
-const env_js_1 = require("../util/env.cjs");
-const base_js_1 = require("./base.cjs");
-/**
- * Wrapper around serper.
- *
- * You can create a free API key at https://serper.dev.
- *
- * To use, you should have the SERPER_API_KEY environment variable set.
- */
-class Serper extends base_js_1.Tool {
-    static lc_name() {
-        return "Serper";
-    }
-    /**
-     * Converts the Serper instance to JSON. This method is not implemented
-     * and will throw an error if called.
-     * @returns Throws an error.
-     */
-    toJSON() {
-        return this.toJSONNotImplemented();
-    }
-    constructor(apiKey = (0, env_js_1.getEnvironmentVariable)("SERPER_API_KEY"), params = {}) {
-        super();
-        Object.defineProperty(this, "key", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "search"
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "a search engine. useful for when you need to answer questions about current events. input should be a search query."
-        });
-        if (!apiKey) {
-            throw new Error("Serper API key not set. You can set it as SERPER_API_KEY in your .env file, or pass it to Serper.");
-        }
-        this.key = apiKey;
-        this.params = params;
+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]; } };
     }
-    /** @ignore */
-    async _call(input) {
-        const options = {
-            method: "POST",
-            headers: {
-                "X-API-KEY": this.key,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                q: input,
-                ...this.params,
-            }),
-        };
-        const res = await fetch("https://google.serper.dev/search", options);
-        if (!res.ok) {
-            throw new Error(`Got ${res.status} error from serper: ${res.statusText}`);
-        }
-        const json = await res.json();
-        if (json.answerBox?.answer) {
-            return json.answerBox.answer;
-        }
-        if (json.answerBox?.snippet) {
-            return json.answerBox.snippet;
-        }
-        if (json.answerBox?.snippet_highlighted_words) {
-            return json.answerBox.snippet_highlighted_words[0];
-        }
-        if (json.sportsResults?.game_spotlight) {
-            return json.sportsResults.game_spotlight;
-        }
-        if (json.knowledgeGraph?.description) {
-            return json.knowledgeGraph.description;
-        }
-        if (json.organic?.[0]?.snippet) {
-            return json.organic[0].snippet;
-        }
-        return "No good search result found";
-    }
-}
-exports.Serper = Serper;
+    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/tools/serper"), exports);

package/dist/tools/serper.d.ts

@@ -1,32 +1 @@
-import { Tool } from "./base.js";
-/**
- * Defines the parameters that can be passed to the Serper class during
- * instantiation. It includes `gl` and `hl` which are optional.
- */
-export type SerperParameters = {
-    gl?: string;
-    hl?: string;
-};
-/**
- * Wrapper around serper.
- *
- * You can create a free API key at https://serper.dev.
- *
- * To use, you should have the SERPER_API_KEY environment variable set.
- */
-export declare class Serper extends Tool {
-    static lc_name(): string;
-    /**
-     * Converts the Serper instance to JSON. This method is not implemented
-     * and will throw an error if called.
-     * @returns Throws an error.
-     */
-    toJSON(): import("@langchain/core/load/serializable").SerializedNotImplemented;
-    protected key: string;
-    protected params: Partial<SerperParameters>;
-    constructor(apiKey?: string | undefined, params?: Partial<SerperParameters>);
-    name: string;
-    /** @ignore */
-    _call(input: string): Promise<any>;
-    description: string;
-}
+export * from "@langchain/community/tools/serper";

package/dist/tools/serper.js

@@ -1,92 +1 @@
-import { getEnvironmentVariable } from "../util/env.js";
-import { Tool } from "./base.js";
-/**
- * Wrapper around serper.
- *
- * You can create a free API key at https://serper.dev.
- *
- * To use, you should have the SERPER_API_KEY environment variable set.
- */
-export class Serper extends Tool {
-    static lc_name() {
-        return "Serper";
-    }
-    /**
-     * Converts the Serper instance to JSON. This method is not implemented
-     * and will throw an error if called.
-     * @returns Throws an error.
-     */
-    toJSON() {
-        return this.toJSONNotImplemented();
-    }
-    constructor(apiKey = getEnvironmentVariable("SERPER_API_KEY"), params = {}) {
-        super();
-        Object.defineProperty(this, "key", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "search"
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "a search engine. useful for when you need to answer questions about current events. input should be a search query."
-        });
-        if (!apiKey) {
-            throw new Error("Serper API key not set. You can set it as SERPER_API_KEY in your .env file, or pass it to Serper.");
-        }
-        this.key = apiKey;
-        this.params = params;
-    }
-    /** @ignore */
-    async _call(input) {
-        const options = {
-            method: "POST",
-            headers: {
-                "X-API-KEY": this.key,
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify({
-                q: input,
-                ...this.params,
-            }),
-        };
-        const res = await fetch("https://google.serper.dev/search", options);
-        if (!res.ok) {
-            throw new Error(`Got ${res.status} error from serper: ${res.statusText}`);
-        }
-        const json = await res.json();
-        if (json.answerBox?.answer) {
-            return json.answerBox.answer;
-        }
-        if (json.answerBox?.snippet) {
-            return json.answerBox.snippet;
-        }
-        if (json.answerBox?.snippet_highlighted_words) {
-            return json.answerBox.snippet_highlighted_words[0];
-        }
-        if (json.sportsResults?.game_spotlight) {
-            return json.sportsResults.game_spotlight;
-        }
-        if (json.knowledgeGraph?.description) {
-            return json.knowledgeGraph.description;
-        }
-        if (json.organic?.[0]?.snippet) {
-            return json.organic[0].snippet;
-        }
-        return "No good search result found";
-    }
-}
+export * from "@langchain/community/tools/serper";

package/dist/tools/wikipedia_query_run.cjs

@@ -1,135 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WikipediaQueryRun = void 0;
-const base_js_1 = require("./base.cjs");
-/**
- * Class for interacting with and fetching data from the Wikipedia API. It
- * extends the Tool class.
- * @example
- * ```typescript
- * const wikipediaQuery = new WikipediaQueryRun({
- *   topKResults: 3,
- *   maxDocContentLength: 4000,
- * });
- * const result = await wikipediaQuery.call("Langchain");
- * ```
- */
-class WikipediaQueryRun extends base_js_1.Tool {
-    static lc_name() {
-        return "WikipediaQueryRun";
-    }
-    constructor(params = {}) {
-        super();
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "wikipedia-api"
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "A tool for interacting with and fetching data from the Wikipedia API."
-        });
-        Object.defineProperty(this, "topKResults", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 3
-        });
-        Object.defineProperty(this, "maxDocContentLength", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 4000
-        });
-        Object.defineProperty(this, "baseUrl", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "https://en.wikipedia.org/w/api.php"
-        });
-        this.topKResults = params.topKResults ?? this.topKResults;
-        this.maxDocContentLength =
-            params.maxDocContentLength ?? this.maxDocContentLength;
-        this.baseUrl = params.baseUrl ?? this.baseUrl;
-    }
-    async _call(query) {
-        const searchResults = await this._fetchSearchResults(query);
-        const summaries = [];
-        for (let i = 0; i < Math.min(this.topKResults, searchResults.query.search.length); i += 1) {
-            const page = searchResults.query.search[i].title;
-            const pageDetails = await this._fetchPage(page, true);
-            if (pageDetails) {
-                const summary = `Page: ${page}\nSummary: ${pageDetails.extract}`;
-                summaries.push(summary);
-            }
-        }
-        if (summaries.length === 0) {
-            return "No good Wikipedia Search Result was found";
-        }
-        else {
-            return summaries.join("\n\n").slice(0, this.maxDocContentLength);
-        }
-    }
-    /**
-     * Fetches the content of a specific Wikipedia page. It returns the
-     * extracted content as a string.
-     * @param page The specific Wikipedia page to fetch its content.
-     * @param redirect A boolean value to indicate whether to redirect or not.
-     * @returns The extracted content of the specific Wikipedia page as a string.
-     */
-    async content(page, redirect = true) {
-        try {
-            const result = await this._fetchPage(page, redirect);
-            return result.extract;
-        }
-        catch (error) {
-            throw new Error(`Failed to fetch content for page "${page}": ${error}`);
-        }
+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]; } };
     }
-    /**
-     * Builds a URL for the Wikipedia API using the provided parameters.
-     * @param parameters The parameters to be used in building the URL.
-     * @returns A string representing the built URL.
-     */
-    buildUrl(parameters) {
-        const nonUndefinedParams = Object.entries(parameters)
-            .filter(([_, value]) => value !== undefined)
-            .map(([key, value]) => [key, `${value}`]);
-        const searchParams = new URLSearchParams(nonUndefinedParams);
-        return `${this.baseUrl}?${searchParams}`;
-    }
-    async _fetchSearchResults(query) {
-        const searchParams = new URLSearchParams({
-            action: "query",
-            list: "search",
-            srsearch: query,
-            format: "json",
-        });
-        const response = await fetch(`${this.baseUrl}?${searchParams.toString()}`);
-        if (!response.ok)
-            throw new Error("Network response was not ok");
-        const data = await response.json();
-        return data;
-    }
-    async _fetchPage(page, redirect) {
-        const params = new URLSearchParams({
-            action: "query",
-            prop: "extracts",
-            explaintext: "true",
-            redirects: redirect ? "1" : "0",
-            format: "json",
-            titles: page,
-        });
-        const response = await fetch(`${this.baseUrl}?${params.toString()}`);
-        if (!response.ok)
-            throw new Error("Network response was not ok");
-        const data = await response.json();
-        const { pages } = data.query;
-        const pageId = Object.keys(pages)[0];
-        return pages[pageId];
-    }
-}
-exports.WikipediaQueryRun = WikipediaQueryRun;
+    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/tools/wikipedia_query_run"), exports);

package/dist/tools/wikipedia_query_run.d.ts

@@ -1,54 +1 @@
-import { Tool } from "./base.js";
-/**
- * Interface for the parameters that can be passed to the
- * WikipediaQueryRun constructor.
- */
-export interface WikipediaQueryRunParams {
-    topKResults?: number;
-    maxDocContentLength?: number;
-    baseUrl?: string;
-}
-/**
- * Type alias for URL parameters. Represents a record where keys are
- * strings and values can be string, number, boolean, undefined, or null.
- */
-type UrlParameters = Record<string, string | number | boolean | undefined | null>;
-/**
- * Class for interacting with and fetching data from the Wikipedia API. It
- * extends the Tool class.
- * @example
- * ```typescript
- * const wikipediaQuery = new WikipediaQueryRun({
- *   topKResults: 3,
- *   maxDocContentLength: 4000,
- * });
- * const result = await wikipediaQuery.call("Langchain");
- * ```
- */
-export declare class WikipediaQueryRun extends Tool {
-    static lc_name(): string;
-    name: string;
-    description: string;
-    protected topKResults: number;
-    protected maxDocContentLength: number;
-    protected baseUrl: string;
-    constructor(params?: WikipediaQueryRunParams);
-    _call(query: string): Promise<string>;
-    /**
-     * Fetches the content of a specific Wikipedia page. It returns the
-     * extracted content as a string.
-     * @param page The specific Wikipedia page to fetch its content.
-     * @param redirect A boolean value to indicate whether to redirect or not.
-     * @returns The extracted content of the specific Wikipedia page as a string.
-     */
-    content(page: string, redirect?: boolean): Promise<string>;
-    /**
-     * Builds a URL for the Wikipedia API using the provided parameters.
-     * @param parameters The parameters to be used in building the URL.
-     * @returns A string representing the built URL.
-     */
-    protected buildUrl<P extends UrlParameters>(parameters: P): string;
-    private _fetchSearchResults;
-    private _fetchPage;
-}
-export {};
+export * from "@langchain/community/tools/wikipedia_query_run";