Class DataForSeoAPISearch

Description

Represents a wrapper class to work with DataForSEO SERP API.

Hierarchy (view full)

Toolkit
- DataForSeoAPISearch

Index

Constructors

constructor

new DataForSeoAPISearch(config?): DataForSeoAPISearch
Parameters
- config: DataForSeoApiConfig = {}
Returns DataForSeoAPISearch
Description
Sets up the class, throws an error if the API login/password isn't provided.
Overrides Tool.constructor
- Defined in libs/langchain-community/src/tools/dataforseo_api_search.ts:141

Properties

description

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

name: string = "dataforseo-api-wrapper"

`Protected` apiLogin

apiLogin: string

`Protected` apiPassword

apiPassword: string

`Protected` defaultParams

defaultParams: Record<string, string | number | boolean> = ...

Description

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

`Protected` jsonResultFields

jsonResultFields: undefined | string[]

`Protected` jsonResultTypes

jsonResultTypes: undefined | string[]

`Protected` params

params: Record<string, string | number | boolean> = {}

`Protected` topCount

topCount: undefined | number

`Protected` useJsonOutput

useJsonOutput: boolean = false

Methods

results

results(keyword): Promise<any[]>
Parameters
- keyword: string
Returns Promise<any[]>
Method
results

Description
Fetches the results from the API for the given keyword.
- Defined in libs/langchain-community/src/tools/dataforseo_api_search.ts:181

`Protected` getResponseJson

getResponseJson(keyword): Promise<ApiResponse>
Parameters
- keyword: string
Returns Promise<ApiResponse>
Method
getResponseJson

Description
Executes a POST request to the provided URL and returns a parsed JSON response.
- Defined in libs/langchain-community/src/tools/dataforseo_api_search.ts:227

`Protected` prepareRequest

prepareRequest(keyword): {
    data: BodyInit;
    headers: HeadersInit;
    url: string;
}
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.
- Defined in libs/langchain-community/src/tools/dataforseo_api_search.ts:192

`Protected` processResponse

processResponse(res): string
Parameters
- res: ApiResponse
Returns string
Method
processResponse

Description
Processes the response to extract meaningful data.
- Defined in libs/langchain-community/src/tools/dataforseo_api_search.ts:341

Class DataForSeoAPISearch

Description

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: DataForSeoApiConfig = {}

Returns DataForSeoAPISearch

Description

Properties

description

name

Protected apiLogin

Protected apiPassword

Protected defaultParams

Description

Protected jsonResultFields

Protected jsonResultTypes

Protected params

Protected topCount

Protected useJsonOutput

Methods

results

Parameters

keyword: string

Returns Promise<any[]>

Method

Description

Protected getResponseJson

Parameters

keyword: string

Returns Promise<ApiResponse>

Method

Description

Protected prepareRequest

Parameters

keyword: string

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

data: BodyInit

headers: HeadersInit

url: string

Method

Description

Protected processResponse

Parameters

res: ApiResponse

Returns string

Method

Description

Settings

Member Visibility

Theme

On This Page

`Protected` apiLogin

`Protected` apiPassword

`Protected` defaultParams

`Protected` jsonResultFields

`Protected` jsonResultTypes

`Protected` params

`Protected` topCount

`Protected` useJsonOutput

`Protected` getResponseJson

`Protected` prepareRequest

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

`Protected` processResponse