Class: SerpAPI

tools.SerpAPI

Wrapper around SerpAPI.

To use, you should have the serpapi package installed and the SERPAPI_API_KEY environment variable set.

Hierarchy

• Tool

  ↳ SerpAPI

Constructors

constructor

• new SerpAPI(apiKey?, params?)

Parameters

Name	Type
apiKey	undefined | string
params	Partial<GoogleParameters>

Overrides

Tool.constructor

Defined in

langchain/src/tools/serpapi.ts:304

Properties

callbackManager

• callbackManager: CallbackManager

Inherited from

Tool.callbackManager

Defined in

langchain/src/tools/base.ts:13

---

description

• description: string = "a search engine. useful for when you need to answer questions about current events. input should be a search query."

Overrides

Tool.description

Defined in

langchain/src/tools/serpapi.ts:374

---

key

• Protected key: string

Defined in

langchain/src/tools/serpapi.ts:300

---

name

• name: string = "search"

Overrides

Tool.name

Defined in

langchain/src/tools/serpapi.ts:323

---

params

• Protected params: Partial<GoogleParameters>

Defined in

langchain/src/tools/serpapi.ts:302

---

returnDirect

• returnDirect: boolean = false

Inherited from

Tool.returnDirect

Defined in

langchain/src/tools/base.ts:44

---

verbose

• verbose: boolean

Inherited from

Tool.verbose

Defined in

langchain/src/tools/base.ts:11

Methods

_call

▸ _call(input): Promise<any>

Run query through SerpAPI and parse result

Parameters

Name	Type
input	string

Returns

Promise<any>

Overrides

Tool._call

Defined in

langchain/src/tools/serpapi.ts:328

---

call

▸ call(arg, verbose?): Promise<string>

Parameters

Name	Type
arg	string
verbose?	boolean

Returns

Promise<string>

Inherited from

Tool.call

Defined in

langchain/src/tools/base.ts:22