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

Example

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`,
});

Hierarchy

Constructors

constructor

Properties

description name returnDirect schema verbose callbacks? metadata? tags? apiBase? headers? params?

Methods

assign batch bind call getName invoke map pick pipe stream streamLog toJSON toJSONNotImplemented transform withConfig withFallbacks withListeners withRetry isRunnable buildUrl

Constructors

constructor

Properties

description

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

name: string = "searxng-search"

returnDirect

returnDirect: boolean

schema

schema: ZodEffects<ZodObject<{
    input: ZodOptional<ZodString>;
}, "strip", ZodTypeAny, {
    input?: string;
}, {
    input?: string;
}>, undefined | string, {
    input?: string;
}>

Type declaration

  • Optional input?: string

verbose

verbose: boolean

Whether to print out response text.

Optional callbacks

callbacks?: Callbacks

Optional metadata

metadata?: Record<string, unknown>

Optional tags

tags?: string[]

Protected Optional apiBase

apiBase?: string

Protected Optional headers

headers?: SearxngCustomHeaders

Protected Optional params

params?: SearxngSearchParams = ...

Methods

assign

  • Assigns new fields to the dict output of this runnable. Returns a new runnable.

    Parameters

    • mapping: RunnableMapLike<Record<string, unknown>, Record<string, unknown>>

    Returns Runnable<any, any, RunnableConfig>

batch

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: (string | {})[]

      Array of inputs to each batch call.

    • Optional options: Partial<RunnableConfig> | Partial<RunnableConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<string[]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(string | Error)[]>

  • Parameters

    Returns Promise<(string | Error)[]>

bind

  • Bind arguments to a Runnable, returning a new Runnable.

    Parameters

    Returns Runnable<string | {}, string, RunnableConfig>

    A new RunnableBinding that, when invoked, will apply the bound args.

call

  • 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: RunnableConfig | Callbacks

      Optional callbacks for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

getName

  • Parameters

    • Optional suffix: string

    Returns string

invoke

  • Invokes the tool with the provided input and configuration.

    Parameters

    • input: string | {}

      The input for the tool.

    • Optional config: RunnableConfig

      Optional configuration for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

map

  • Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

    Returns Runnable<(string | {})[], string[], RunnableConfig>

pick

  • Pick keys from the dict output of this runnable. Returns a new runnable.

    Parameters

    • keys: string | string[]

    Returns Runnable<any, any, RunnableConfig>

pipe

  • 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 Runnable<string | {}, Exclude<NewRunOutput, Error>, RunnableConfig>

    A new runnable sequence.

stream

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<string>>

    A readable stream that is also an iterable.

streamLog

  • 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<RunnableConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

toJSON

toJSONNotImplemented

transform

  • 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<RunnableConfig>

    Returns AsyncGenerator<string, any, unknown>

withConfig

withFallbacks

  • Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

    Parameters

    Returns RunnableWithFallbacks<string | {}, string>

    A new RunnableWithFallbacks.

withListeners

  • Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

    Parameters

    • params: {
          onEnd?: ((run, config?) => void | Promise<void>);
          onError?: ((run, config?) => void | Promise<void>);
          onStart?: ((run, config?) => void | Promise<void>);
      }

      The object containing the callback functions.

      • Optional onEnd?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called after the runnable finishes running, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onError?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called if the runnable throws an error, with the Run object.

            Parameters

            Returns void | Promise<void>

      • Optional onStart?: ((run, config?) => void | Promise<void>)
          • (run, config?): void | Promise<void>

          • Called before the runnable starts running, with the Run object.

            Parameters

            Returns void | Promise<void>

    Returns Runnable<string | {}, string, RunnableConfig>

withRetry

Static isRunnable

Protected buildUrl

  • 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc