Skip to main content

SearchApi Tool

Description​

SearchApi is a versatile search engine API that allows developers to integrate search capabilities into their applications. It supports various search engines, making it a flexible tool for retrieving relevant information from different sources.

Enhance your agents with:

  • Multi-Engine Search: Use different search engines like Google News, Bing, and more, depending on your needs.
  • Customizable Queries: Easily configure your search queries with various parameters to tailor the results.
Try it Out in the Playground!

Before diving into the installation and coding, why not experiment directly with our interactive playground? Try it now!

Installation​

Before using the tool, ensure that you have created an API Key at SearchApi to enable search functionality.

Example​

Utilize the SearchApi tool as follows to enable your agent to perform searches with customizable engines:

import { SearchApi } from '@langchain/community/tools/searchapi';

const searchTool = new SearchApi('ENV_SEARCH_API_KEY', {
  engine: "google_news",
});

const informationRetriever = new Agent({
    name: 'Mary', 
    role: 'Information Retriever', 
    goal: 'Gather and present the most relevant and up-to-date information from various online sources.', 
    background: 'Search Specialist',
    tools: [searchTool]
});

Parameters​

  • apiKey Required. The API key generated from SearchApi. Set 'ENV_SEARCH_API_KEY' as an environment variable or replace it directly with your API key.
  • engine Optional. The search engine you want to use. Some options include "google_news", "bing", and others, depending on what is supported by SearchApi.
We Love Feedback!

Is there something unclear or quirky in the docs? Maybe you have a suggestion or spotted an issue? Help us refine and enhance our documentation by submitting an issue on GitHub. We’re all ears!