Class SearxngSearch

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

Hierarchy

Constructors

Properties

description: string = "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"
name: string = "searxng-search"
returnDirect: boolean = false
schema: ZodEffects<ZodObject<{
    input: ZodOptional<ZodString>;
}, "strip", ZodTypeAny, {
    input?: string;
}, {
    input?: string;
}>, undefined | string, {
    input?: string;
}> = ...

Type declaration

  • Optional input?: string
verbose: boolean

Whether to print out response text.

callbacks?: Callbacks
metadata?: Record<string, unknown>
tags?: string[]
lc_runnable: boolean = true
apiBase?: string
headers?: SearxngCustomHeaders
params?: SearxngSearchParams = ...

Methods

  • Calls the tool with the provided argument and callbacks. It handles string inputs specifically.

    Parameters

    • arg: undefined | string | {
          input?: string;
      }

      The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.

    • Optional callbacks: Callbacks

      Optional callbacks for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Invokes the tool with the provided input and configuration.

    Parameters

    • input: string | {}

      The input for the tool.

    • Optional config: BaseCallbackConfig

      Optional configuration for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<string, NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<string | {}, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: string | {}
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    • generator: AsyncGenerator<string | {}, any, unknown>
    • options: Partial<BaseCallbackConfig>

    Returns AsyncGenerator<string, any, unknown>

  • Type Parameters

    • T extends string | {}

    Parameters

    • func: ((input) => Promise<string>) | ((input, config?, runManager?) => Promise<string>)
    • input: T
    • Optional options: Partial<BaseCallbackConfig> & {
          runType?: string;
      }

    Returns Promise<string>

  • Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

    Type Parameters

    • I extends string | {}

    • O extends string

    Parameters

    • inputGenerator: AsyncGenerator<I, any, unknown>
    • transformer: ((generator, runManager?, options?) => AsyncGenerator<O, any, unknown>)
        • (generator, runManager?, options?): AsyncGenerator<O, any, unknown>
        • Parameters

          Returns AsyncGenerator<O, any, unknown>

    • Optional options: BaseCallbackConfig & {
          runType?: string;
      }

    Returns AsyncGenerator<O, any, unknown>

  • Builds the URL for the Searxng search.

    Type Parameters

    • P extends SearxngSearchParams

    Parameters

    • path: string

      The path for the URL.

    • parameters: P

      The parameters for the URL.

    • baseUrl: string

      The base URL.

    Returns string

    The complete URL as a string.

Generated using TypeDoc