GoogleSerperAPIWrapper#

class langchain_community.utilities.google_serper.GoogleSerperAPIWrapper[source]#

Bases: BaseModel

Wrapper around the Serper.dev Google Search API.

You can create a free API key at https://serper.dev.

To use, you should have the environment variable SERPER_API_KEY set with your API key, or pass serper_api_key as a named parameter to the constructor.

Example

from langchain_community.utilities import GoogleSerperAPIWrapper
google_serper = GoogleSerperAPIWrapper()

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

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

param aiosession: ClientSession | None = None#

param gl: str = 'us'#

param hl: str = 'en'#

param k: int = 10#

param result_key_for_type: dict = {'images': 'images', 'news': 'news', 'places': 'places', 'search': 'organic'}#

param serper_api_key: str | None = None#

param tbs: str | None = None#

param type: Literal['news', 'search', 'places', 'images'] = 'search'#

async aresults(query: str, **kwargs: Any) → Dict[source]#

Run query through GoogleSearch.

Parameters:

query (str)
kwargs (Any)

Return type:

Dict

async arun(query: str, **kwargs: Any) → str[source]#

Run query through GoogleSearch and parse result async.

Parameters:

query (str)
kwargs (Any)

Return type:

str

results(query: str, **kwargs: Any) → Dict[source]#

Run query through GoogleSearch.

Parameters:

query (str)
kwargs (Any)

Return type:

Dict

run(query: str, **kwargs: Any) → str[source]#

Run query through GoogleSearch and parse result.

Parameters:

query (str)
kwargs (Any)

Return type:

str

Examples using GoogleSerperAPIWrapper