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

Tool
- SearxngSearch

Index

Constructors

constructor

new SearxngSearch(__namedParameters): SearxngSearch
Constructor for the SearxngSearch class
Parameters
- __namedParameters: {
      apiBase?: string;
      headers?: SearxngCustomHeaders;
      params?: SearxngSearchParams;
  }
  - Optional apiBase?: string
    
    Base URL of Searxng instance
  - Optional headers?: SearxngCustomHeaders
    
    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
  - Optional params?: SearxngSearchParams
    
    SearxNG Paramerters
    
    https://docs.searxng.org/dev/search_api.html check here for more details
Returns SearxngSearch
Overrides Tool.constructor
- Defined in docs/api_refs/langchain/src/tools/searxng_search.ts:150

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 = false

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

batch

batch(inputs, options?, batchOptions?): Promise<string[]>
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<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
  
  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
Inherited from Tool.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:159
batch(inputs, options?, batchOptions?): Promise<(string | Error)[]>
Parameters
- inputs: (string | {})[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(string | Error)[]>
Inherited from Tool.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:165
batch(inputs, options?, batchOptions?): Promise<(string | Error)[]>
Parameters
- inputs: (string | {})[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(string | Error)[]>
Inherited from Tool.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:171

bind

bind(kwargs): Runnable<string | {}, string, BaseCallbackConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<BaseCallbackConfig>
Returns Runnable<string | {}, string, BaseCallbackConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from Tool.bind
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:67

call

call(arg, callbacks?): Promise<string>
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.
Inherited from Tool.call
- Defined in docs/api_refs/langchain/src/tools/base.ts:150

invoke

invoke(input, config?): Promise<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.
Inherited from Tool.invoke
- Defined in docs/api_refs/langchain/src/tools/base.ts:63

map

map(): Runnable<(string | {})[], string[], BaseCallbackConfig>
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[], BaseCallbackConfig>
Inherited from Tool.map
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:78

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<string | {}, Exclude<NewRunOutput, Error>>
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.
Inherited from Tool.pipe
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:461

stream

stream(input, options?): Promise<IterableReadableStream<string>>
Stream output in chunks.
Parameters
- input: string | {}
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<IterableReadableStream<string>>
A readable stream that is also an iterable.
Inherited from Tool.stream
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:225

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
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>
Inherited from Tool.streamLog
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:507

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from Tool.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from Tool.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

transform

transform(generator, options): AsyncGenerator<string, 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>
Inherited from Tool.transform
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:478

withConfig

withConfig(config): RunnableBinding<string | {}, string, BaseCallbackConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<string | {}, string, BaseCallbackConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from Tool.withConfig
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:107

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<string | {}, string>
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Parameters
- fields: {
  fallbacks: Runnable<string | {}, string, BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<string | {}, string, BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<string | {}, string>
A new RunnableWithFallbacks.
Inherited from Tool.withFallbacks
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:124

withRetry

withRetry(fields?): RunnableRetry<string | {}, string, BaseCallbackConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<string | {}, string, BaseCallbackConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from Tool.withRetry
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:88

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from Tool.isRunnable
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:557

`Protected` buildUrl

buildUrl<P>(path, parameters, baseUrl): string
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.
- Defined in docs/api_refs/langchain/src/tools/searxng_search.ts:194

Class SearxngSearch

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: { apiBase?: string; headers?: SearxngCustomHeaders; params?: SearxngSearchParams; }

Optional apiBase?: string

Optional headers?: SearxngCustomHeaders

Optional params?: SearxngSearchParams

Returns SearxngSearch

Properties

description

name

returnDirect

schema

Type declaration

Optional input?: string

verbose

Optional callbacks

Optional metadata

Optional tags

Protected Optional apiBase

Protected Optional headers

Protected Optional params

Methods

batch

Parameters

inputs: (string | {})[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

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

Returns Promise<string[]>

Parameters

inputs: (string | {})[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(string | Error)[]>

Parameters

inputs: (string | {})[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(string | Error)[]>

bind

Parameters

kwargs: Partial<BaseCallbackConfig>

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

call

Parameters

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

Optional callbacks: Callbacks

Returns Promise<string>

invoke

Parameters

input: string | {}

Optional config: BaseCallbackConfig

Returns Promise<string>

map

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

pipe

Type Parameters

NewRunOutput

Parameters

coerceable: RunnableLike<string, NewRunOutput>

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

stream

Parameters

input: string | {}

Optional options: Partial<BaseCallbackConfig>

Returns Promise<IterableReadableStream<string>>

streamLog

Parameters

input: string | {}

Optional options: Partial<BaseCallbackConfig>

Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

Returns AsyncGenerator<RunLogPatch, any, unknown>

toJSON

__namedParameters: {
apiBase?: string;
headers?: SearxngCustomHeaders;
params?: SearxngSearchParams;
}

`Optional` apiBase?: string

`Optional` headers?: SearxngCustomHeaders

`Optional` params?: SearxngSearchParams

`Optional` input?: string

`Optional` callbacks

`Optional` metadata

`Optional` tags

`Protected` `Optional` apiBase

`Protected` `Optional` headers

`Protected` `Optional` params

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

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

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions

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

`Optional` callbacks: Callbacks

`Optional` config: BaseCallbackConfig

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

fields: {
fallbacks: Runnable<string | {}, string, BaseCallbackConfig>[];
}

`Optional` fields: {
onFailedAttempt?: RunnableRetryFailedAttemptHandler;
stopAfterAttempt?: number;
}

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` isRunnable

`Protected` buildUrl