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

Example

const searchApi = new SearchApi("your-api-key", {
  engine: "google_news",
});
const agent = RunnableSequence.from([
  ChatPromptTemplate.fromMessages([
    ["ai", "Answer the following questions using a bulleted list markdown format.""],
    ["human", "{input}"],
  ]),
  new ChatOpenAI({ temperature: 0 }),
  (input: BaseMessageChunk) => ({
    log: "test",
    returnValues: {
      output: input,
    },
  }),
]);
const executor = AgentExecutor.fromAgentAndTools({
  agent,
  tools: [searchApi],
});
const res = await executor.invoke({
  input: "What's happening in Ukraine today?"",
});
console.log(res);

Hierarchy

Constructors

constructor

Properties

description name returnDirect schema verbose callbacks? metadata? tags? apiKey params

Methods

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

Constructors

constructor

Properties

description

description: string

name

name: string

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 apiKey

apiKey: string

Protected params

params: Partial<SearchApiParameters>

Methods

_call

  • _call(input): Promise<any>

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

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

  • Parameters

    Returns Promise<(string | Error)[]>

  • Parameters

    Returns Promise<(string | Error)[]>

bind

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

      Optional callbacks for the tool.

    Returns Promise<string>

    A Promise that resolves with a string.

invoke

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

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[], BaseCallbackConfig>

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 RunnableSequence<string | {}, Exclude<NewRunOutput, Error>>

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

    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, BaseCallbackConfig>

withRetry

Static isRunnable

Protected buildUrl

  • Builds a URL for the SearchApi request.

    Parameters

    • searchQuery: string

    Returns string

    A string representing the built URL.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc