Class SearchApi

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

Hierarchy

Constructors

Properties

description: string = "a search engine. useful for when you need to answer questions about current events. input should be a search query."
name: string = "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[]
apiKey: string
params: Partial<SearchApiParameters>

Methods

  • Calls the SearchAPI.

    Accepts an input query and fetches the result from SearchApi.

    Parameters

    • input: string

      Search query.

    Returns Promise<any>

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

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

  • Builds a URL for the SearchApi request.

    Parameters

    • searchQuery: string

    Returns string

    A string representing the built URL.

Generated using TypeDoc