Class DataForSeoAPISearch

Description

Represents a wrapper class to work with DataForSEO SERP API.

Hierarchy

  • Tool
    • DataForSeoAPISearch

Constructors

Properties

description: string = "A robust Google Search API provided by DataForSeo. This tool is handy when you need information about trending topics or current events."
name: string = "dataforseo-api-wrapper"
returnDirect: boolean
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[]
apiLogin: string
apiPassword: string
defaultParams: Record<string, string | number | boolean> = ...

Description

These are the default parameters to be used when making an API request.

jsonResultFields: undefined | string[]
jsonResultTypes: undefined | string[]
params: Record<string, string | number | boolean> = {}
topCount: undefined | number
useJsonOutput: boolean = false

Methods

  • 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)[]>

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

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

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

  • Parameters

    • keyword: string

    Returns Promise<any[]>

    Method

    results

    Description

    Fetches the results from the API for the given keyword.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<string>>

    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.

    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>

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

  • Parameters

    • keyword: string

    Returns Promise<ApiResponse>

    Method

    getResponseJson

    Description

    Executes a POST request to the provided URL and returns a parsed JSON response.

  • Parameters

    • keyword: string

    Returns {
        data: BodyInit;
        headers: HeadersInit;
        url: string;
    }

    • data: BodyInit
    • headers: HeadersInit
    • url: string

    Method

    prepareRequest

    Description

    Prepares the request details for the API call.

  • Parameters

    • res: ApiResponse

    Returns string

    Method

    processResponse

    Description

    Processes the response to extract meaningful data.

Generated using TypeDoc