langchain 0.0.203 → 0.0.204-rc.1

package/dist/tools/searchapi.js

@@ -1,162 +1 @@
-import { getEnvironmentVariable } from "../util/env.js";
-import { Tool } from "./base.js";
-function isJSONObject(value) {
-    return value !== null && typeof value === "object" && !Array.isArray(value);
-}
-/**
- * SearchApi Class Definition.
- *
- * Provides a wrapper around the SearchApi.
- *
- * Ensure you've set the SEARCHAPI_API_KEY environment variable for authentication.
- * You can obtain a free API key from https://www.searchapi.io/.
- * @example
- * ```typescript
- * const searchApi = new SearchApi("your-api-key", {
- *   engine: "google_news",
- * });
- * const agent = RunnableSequence.from([
- *   ChatPromptTemplate.fromMessages([
- *     ["ai", "Answer the following questions using a bulleted list markdown format.""],
- *     ["human", "{input}"],
- *   ]),
- *   new ChatOpenAI({ temperature: 0 }),
- *   (input: BaseMessageChunk) => ({
- *     log: "test",
- *     returnValues: {
- *       output: input,
- *     },
- *   }),
- * ]);
- * const executor = AgentExecutor.fromAgentAndTools({
- *   agent,
- *   tools: [searchApi],
- * });
- * const res = await executor.invoke({
- *   input: "What's happening in Ukraine today?"",
- * });
- * console.log(res);
- * ```
- */
-export class SearchApi extends Tool {
-    static lc_name() {
-        return "SearchApi";
-    }
-    /**
-     * Converts the SearchApi 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("SEARCHAPI_API_KEY"), params = {}) {
-        super(...arguments);
-        Object.defineProperty(this, "apiKey", {
-            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("SearchApi requires an API key. Please set it as SEARCHAPI_API_KEY in your .env file, or pass it as a parameter to the SearchApi constructor.");
-        }
-        this.apiKey = apiKey;
-        this.params = params;
-    }
-    /**
-     * Builds a URL for the SearchApi request.
-     * @param parameters The parameters for the request.
-     * @returns A string representing the built URL.
-     */
-    buildUrl(searchQuery) {
-        const preparedParams = Object.entries({
-            engine: "google",
-            api_key: this.apiKey,
-            ...this.params,
-            q: searchQuery,
-        })
-            .filter(([key, value]) => value !== undefined && value !== null && key !== "apiKey")
-            .map(([key, value]) => [key, `${value}`]);
-        const searchParams = new URLSearchParams(preparedParams);
-        return `https://www.searchapi.io/api/v1/search?${searchParams}`;
-    }
-    /** @ignore */
-    /**
-     * Calls the SearchAPI.
-     *
-     * Accepts an input query and fetches the result from SearchApi.
-     *
-     * @param {string} input - Search query.
-     * @returns {string} - Formatted search results or an error message.
-     *
-     * NOTE: This method is the core search handler and processes various types
-     * of search results including Google organic results, videos, jobs, and images.
-     */
-    async _call(input) {
-        const resp = await fetch(this.buildUrl(input));
-        const json = await resp.json();
-        if (json.error) {
-            throw new Error(`Failed to load search results from SearchApi due to: ${json.error}`);
-        }
-        // Google Search results
-        if (json.answer_box?.answer) {
-            return json.answer_box.answer;
-        }
-        if (json.answer_box?.snippet) {
-            return json.answer_box.snippet;
-        }
-        if (json.knowledge_graph?.description) {
-            return json.knowledge_graph.description;
-        }
-        // Organic results (Google, Google News)
-        if (json.organic_results) {
-            const snippets = json.organic_results
-                .filter((r) => r.snippet)
-                .map((r) => r.snippet);
-            return snippets.join("\n");
-        }
-        // Google Jobs results
-        if (json.jobs) {
-            const jobDescriptions = json.jobs
-                .slice(0, 1)
-                .filter((r) => r.description)
-                .map((r) => r.description);
-            return jobDescriptions.join("\n");
-        }
-        // Google Videos results
-        if (json.videos) {
-            const videoInfo = json.videos
-                .filter((r) => r.title && r.link)
-                .map((r) => `Title: "${r.title}" Link: ${r.link}`);
-            return videoInfo.join("\n");
-        }
-        // Google Images results
-        if (json.images) {
-            const image_results = json.images.slice(0, 15);
-            const imageInfo = image_results
-                .filter((r) => r.title && r.original && isJSONObject(r.original) && r.original.link)
-                .map((r) => `Title: "${r.title}" Link: ${r.original.link}`);
-            return imageInfo.join("\n");
-        }
-        return "No good search result found";
-    }
-}
+export * from "@langchain/community/tools/searchapi";

package/dist/tools/searxng_search.cjs

@@ -1,158 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearxngSearch = void 0;
-const env_js_1 = require("../util/env.cjs");
-const base_js_1 = require("./base.cjs");
-/**
- * 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`,
- * });
- * ```
- */
-class SearxngSearch extends base_js_1.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 = (0, env_js_1.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 };
-        }
+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 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.";
-        }
-    }
-}
-exports.SearxngSearch = SearxngSearch;
+    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/searxng_search"), exports);

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";