langchain.utilities.google_serper.GoogleSerperAPIWrapper¶

class langchain.utilities.google_serper.GoogleSerperAPIWrapper(*, k: int = 10, gl: str = 'us', hl: str = 'en', type: Literal['news', 'search', 'places', 'images'] = 'search', tbs: Optional[str] = None, serper_api_key: Optional[str] = None, aiosession: Optional[ClientSession] = None, result_key_for_type: dict = {'images': 'images', 'news': 'news', 'places': 'places', 'search': 'organic'})[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 import GoogleSerperAPIWrapper
google_serper = GoogleSerperAPIWrapper()

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 gl: str = 'us'¶
param hl: str = 'en'¶
param k: int = 10¶
param serper_api_key: Optional[str] = None¶
param tbs: Optional[str] = None¶
param type: Literal['news', 'search', 'places', 'images'] = 'search'¶
async aresults(query: str, **kwargs: Any) → Dict[source]¶

Run query through GoogleSearch.

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

Run query through GoogleSearch and parse result async.

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

Run query through GoogleSearch.

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

Run query through GoogleSearch and parse result.

validator validate_environment  »  all fields[source]¶

Validate that api key exists in environment.

model Config[source]¶

Bases: object

Configuration for this pydantic object.

arbitrary_types_allowed = True¶

Examples using GoogleSerperAPIWrapper¶