langchain 0.0.202 → 0.0.204-rc.0

package/dist/tools/searxng_search.d.ts

@@ -1,114 +1 @@
-import { Tool } from "./base.js";
-/**
- * Interface for custom headers used in the Searxng search.
- */
-interface SearxngCustomHeaders {
-    [key: string]: string;
-}
-interface SearxngSearchParams {
-    /**
-     * @default 10
-     * Number of results included in results
-     */
-    numResults?: number;
-    /** Comma separated list, specifies the active search categories
-     * https://docs.searxng.org/user/configured_engines.html#configured-engines
-     */
-    categories?: string;
-    /** Comma separated list, specifies the active search engines
-     * https://docs.searxng.org/user/configured_engines.html#configured-engines
-     */
-    engines?: string;
-    /** Code of the language. */
-    language?: string;
-    /** Search page number. */
-    pageNumber?: number;
-    /**
-     * day / month / year
-     *
-     * Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.
-     */
-    timeRange?: number;
-    /**
-     * Throws Error if format is set anything other than "json"
-     * Output format of results. Format needs to be activated in search:
-     */
-    format?: "json";
-    /** Open search results on new tab. */
-    resultsOnNewTab?: 0 | 1;
-    /** Proxy image results through SearXNG. */
-    imageProxy?: boolean;
-    autocomplete?: string;
-    /**
-     * Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.
-     */
-    safesearch?: 0 | 1 | 2;
-}
-/**
- * SearxngSearch class represents a meta search engine tool.
- * Use this class when you need to answer questions about current events.
- * The input should be a search query, and the output is a JSON array of the query results.
- *
- * note: works best with *agentType*: `structured-chat-zero-shot-react-description`
- * https://github.com/searxng/searxng
- * @example
- * ```typescript
- * const executor = AgentExecutor.fromAgentAndTools({
- *   agent,
- *   tools: [
- *     new SearxngSearch({
- *       params: {
- *         format: "json",
- *         engines: "google",
- *       },
- *       headers: {},
- *     }),
- *   ],
- * });
- * const result = await executor.invoke({
- *   input: `What is Langchain? Describe in 50 words`,
- * });
- * ```
- */
-export declare class SearxngSearch extends Tool {
-    static lc_name(): string;
-    name: string;
-    description: string;
-    protected apiBase?: string;
-    protected params?: SearxngSearchParams;
-    protected headers?: SearxngCustomHeaders;
-    get lc_secrets(): {
-        [key: string]: string;
-    } | undefined;
-    /**
-     * Constructor for the SearxngSearch class
-     * @param apiBase Base URL of the Searxng instance
-     * @param params SearxNG parameters
-     * @param headers Custom headers
-     */
-    constructor({ apiBase, params, headers, }: {
-        /** Base URL of Searxng instance */
-        apiBase?: string;
-        /** SearxNG Paramerters
-         *
-         *  https://docs.searxng.org/dev/search_api.html check here for more details
-         */
-        params?: SearxngSearchParams;
-        /**
-         * Custom headers
-         * Set custom headers if you're using a api from RapidAPI (https://rapidapi.com/iamrony777/api/searxng)
-         * No headers needed for a locally self-hosted instance
-         */
-        headers?: SearxngCustomHeaders;
-    });
-    /**
-     * Builds the URL for the Searxng search.
-     * @param path The path for the URL.
-     * @param parameters The parameters for the URL.
-     * @param baseUrl The base URL.
-     * @returns The complete URL as a string.
-     */
-    protected buildUrl<P extends SearxngSearchParams>(path: string, parameters: P, baseUrl: string): string;
-    _call(input: string): Promise<string>;
-}
-export {};
+export * from "@langchain/community/tools/searxng_search";

package/dist/tools/searxng_search.js

@@ -1,154 +1 @@
-import { getEnvironmentVariable } from "../util/env.js";
-import { Tool } from "./base.js";
-/**
- * SearxngSearch class represents a meta search engine tool.
- * Use this class when you need to answer questions about current events.
- * The input should be a search query, and the output is a JSON array of the query results.
- *
- * note: works best with *agentType*: `structured-chat-zero-shot-react-description`
- * https://github.com/searxng/searxng
- * @example
- * ```typescript
- * const executor = AgentExecutor.fromAgentAndTools({
- *   agent,
- *   tools: [
- *     new SearxngSearch({
- *       params: {
- *         format: "json",
- *         engines: "google",
- *       },
- *       headers: {},
- *     }),
- *   ],
- * });
- * const result = await executor.invoke({
- *   input: `What is Langchain? Describe in 50 words`,
- * });
- * ```
- */
-export class SearxngSearch extends Tool {
-    static lc_name() {
-        return "SearxngSearch";
-    }
-    get lc_secrets() {
-        return {
-            apiBase: "SEARXNG_API_BASE",
-        };
-    }
-    /**
-     * Constructor for the SearxngSearch class
-     * @param apiBase Base URL of the Searxng instance
-     * @param params SearxNG parameters
-     * @param headers Custom headers
-     */
-    constructor({ apiBase, params, headers, }) {
-        super(...arguments);
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "searxng-search"
-        });
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "A meta search engine. Useful for when you need to answer questions about current events. Input should be a search query. Output is a JSON array of the query results"
-        });
-        Object.defineProperty(this, "apiBase", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "params", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: {
-                numResults: 10,
-                pageNumber: 1,
-                format: "json",
-                imageProxy: true,
-                safesearch: 0,
-            }
-        });
-        Object.defineProperty(this, "headers", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.apiBase = getEnvironmentVariable("SEARXNG_API_BASE") || apiBase;
-        this.headers = { "content-type": "application/json", ...headers };
-        if (!this.apiBase) {
-            throw new Error(`SEARXNG_API_BASE not set. You can set it as "SEARXNG_API_BASE" in your environment variables.`);
-        }
-        if (params) {
-            this.params = { ...this.params, ...params };
-        }
-    }
-    /**
-     * Builds the URL for the Searxng search.
-     * @param path The path for the URL.
-     * @param parameters The parameters for the URL.
-     * @param baseUrl The base URL.
-     * @returns The complete URL as a string.
-     */
-    buildUrl(path, parameters, baseUrl) {
-        const nonUndefinedParams = Object.entries(parameters)
-            .filter(([_, value]) => value !== undefined)
-            .map(([key, value]) => [key, value.toString()]); // Avoid string conversion
-        const searchParams = new URLSearchParams(nonUndefinedParams);
-        return `${baseUrl}/${path}?${searchParams}`;
-    }
-    async _call(input) {
-        const queryParams = {
-            q: input,
-            ...this.params,
-        };
-        const url = this.buildUrl("search", queryParams, this.apiBase);
-        const resp = await fetch(url, {
-            method: "POST",
-            headers: this.headers,
-            signal: AbortSignal.timeout(5 * 1000), // 5 seconds
-        });
-        if (!resp.ok) {
-            throw new Error(resp.statusText);
-        }
-        const res = await resp.json();
-        if (!res.results.length &&
-            !res.answers.length &&
-            !res.infoboxes.length &&
-            !res.suggestions.length) {
-            return "No good results found.";
-        }
-        else if (res.results.length) {
-            const response = [];
-            res.results.forEach((r) => {
-                response.push(JSON.stringify({
-                    title: r.title || "",
-                    link: r.url || "",
-                    snippet: r.content || "",
-                }));
-            });
-            return response.slice(0, this.params?.numResults).toString();
-        }
-        else if (res.answers.length) {
-            return res.answers[0];
-        }
-        else if (res.infoboxes.length) {
-            return res.infoboxes[0]?.content.replaceAll(/<[^>]+>/gi, "");
-        }
-        else if (res.suggestions.length) {
-            let suggestions = "Suggestions: ";
-            res.suggestions.forEach((s) => {
-                suggestions += `${s}, `;
-            });
-            return suggestions;
-        }
-        else {
-            return "No good results found.";
-        }
-    }
-}
+export * from "@langchain/community/tools/searxng_search";

package/dist/tools/serpapi.cjs

@@ -1,201 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SerpAPI = void 0;
-const env_js_1 = require("../util/env.cjs");
-const base_js_1 = require("./base.cjs");
-/**
- * Wrapper around SerpAPI.
- *
- * To use, you should have the `serpapi` package installed and the SERPAPI_API_KEY environment variable set.
- */
-class SerpAPI extends base_js_1.Tool {
-    static lc_name() {
-        return "SerpAPI";
-    }
-    toJSON() {
-        return this.toJSONNotImplemented();
-    }
-    constructor(apiKey = (0, env_js_1.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;
+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 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";
-        }
-    }
-}
-exports.SerpAPI = SerpAPI;
+    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/serpapi"), exports);