langchain.utilities.serpapi.SerpAPIWrapper

class langchain.utilities.serpapi.SerpAPIWrapper(*, search_engine: Any = None, params: dict = {'engine': 'google', 'gl': 'us', 'google_domain': 'google.com', 'hl': 'en'}, serpapi_api_key: Optional[str] = None, aiosession: Optional[ClientSession] = None)

Bases: BaseModel

Wrapper around SerpAPI.

To use, you should have the google-search-results python package installed, and the environment variable SERPAPI_API_KEY set with your API key, or pass serpapi_api_key as a named parameter to the constructor.

Example

from langchain.utilities import SerpAPIWrapper
serpapi = SerpAPIWrapper()

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param aiosession: Optional[aiohttp.client.ClientSession] = None

param params: dict = {'engine': 'google', 'gl': 'us', 'google_domain': 'google.com', 'hl': 'en'}

param serpapi_api_key: Optional[str] = None

async aresults(query: str) → dict

Use aiohttp to run query through SerpAPI and return the results async.

async arun(query: str, **kwargs: Any) → str

Run query through SerpAPI and parse result async.

get_params(query: str) → Dict[str, str]

Get parameters for SerpAPI.

results(query: str) → dict

Run query through SerpAPI and return the raw result.

run(query: str, **kwargs: Any) → str

Run query through SerpAPI and parse result.

validator validate_environment  »  all fields

Validate that api key and python package exists in environment.

model Config

Bases: object

Configuration for this pydantic object.

arbitrary_types_allowed = True

extra = 'forbid'

Examples using SerpAPIWrapper

• SerpAPI

• AutoGPT