Optional input?: stringWhether to print out response text.
Optional callbacksOptional metadataOptional tagsProtected apiProtected paramsCalls the SearchAPI.
Accepts an input query and fetches the result from SearchApi.
Search query.
NOTE: This method is the core search handler and processes various types of search results including Google organic results, videos, jobs, and images.
Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
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 & { An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]Optional batchOptions: RunnableBatchOptions & { Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]Optional batchOptions: RunnableBatchOptionsBind arguments to a Runnable, returning a new Runnable.
A new RunnableBinding that, when invoked, will apply the bound args.
Calls the tool with the provided argument and callbacks. It handles string inputs specifically.
The input argument for the tool, which can be a string, undefined, or an input of the tool's schema.
Optional callbacks: CallbacksOptional callbacks for the tool.
A Promise that resolves with a string.
Invokes the tool with the provided input and configuration.
The input for the tool.
Optional config: BaseCallbackConfigOptional configuration for the tool.
A Promise that resolves with a string.
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
A runnable, function, or object whose values are functions or runnables.
A new runnable sequence.
Stream output in chunks.
Optional options: Partial<BaseCallbackConfig>A readable stream that is also an iterable.
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.
Optional options: Partial<BaseCallbackConfig>Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">Converts the SearchApi instance to JSON. This method is not implemented and will throw an error if called.
Throws an error.
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.
Bind config to a Runnable, returning a new Runnable.
New configuration parameters to attach to the new runnable.
A new RunnableBinding with a config matching what's passed.
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Other runnables to call if the runnable errors.
A new RunnableWithFallbacks.
Add retry logic to an existing runnable.
Optional fields: { Optional onOptional stopA new RunnableRetry that, when invoked, will retry according to the parameters.
Static isProtected buildGenerated using TypeDoc
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/.