langchain/docs/ecosystem/serpapi.md
vinoyang 5111bec540
Make serpapi base url configurable via env (#4402)
Fixes #4328

Co-authored-by: Dev 2049 <dev.dev2049@gmail.com>
2023-05-15 14:25:25 -07:00

1.0 KiB

SerpAPI

This page covers how to use the SerpAPI search APIs within LangChain. It is broken into two parts: installation and setup, and then references to the specific SerpAPI wrapper.

Installation and Setup

  • Install requirements with pip install google-search-results
  • Get a SerpAPI api key and either set it as an environment variable (SERPAPI_API_KEY)
  • Optional, if you are using a proxy, set environment variable (SERPAPI_BASE_URL) or pass it to the LLM constructor to your proxy url.

Wrappers

Utility

There exists a SerpAPI utility which wraps this API. To import this utility:

from langchain.utilities import SerpAPIWrapper

For a more detailed walkthrough of this wrapper, see this notebook.

Tool

You can also easily load this wrapper as a Tool (to use with an Agent). You can do this with:

from langchain.agents import load_tools
tools = load_tools(["serpapi"])

For more information on this, see this page