Package dev.langchain4j.web.search.searchapi

Class SearchApiWebSearchEngine

java.lang.Object

dev.langchain4j.web.search.searchapi.SearchApiWebSearchEngine

All Implemented Interfaces:

WebSearchEngine

public class SearchApiWebSearchEngine
extends Object
implements WebSearchEngine

An implementation of a WebSearchEngine that uses Search API for performing web searches.

Search API supports not only Google Search, but many other engines

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchApiWebSearchEngine.SearchApiWebSearchEngineBuilder

Constructor Summary

Constructors

Constructor	Description
SearchApiWebSearchEngine(String apiKey, String baseUrl, Duration timeout, String engine, Map<String,Object> optionalParameters)

Method Summary

Modifier and Type	Method	Description
static SearchApiWebSearchEngine.SearchApiWebSearchEngineBuilder	builder()
WebSearchResults	search(WebSearchRequest webSearchRequest)	Performs a search request on the web search engine and returns the search results.
static WebSearchEngine	withApiKey(String apiKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.web.search.WebSearchEngine

search

Constructor Details

SearchApiWebSearchEngine

public SearchApiWebSearchEngine(String apiKey,
 String baseUrl,
 Duration timeout,
 String engine,
 Map<String,Object> optionalParameters)

Parameters:

apiKey - Required - the Search API key for accessing their API

baseUrl - overrides the default SearchApi base url

timeout - the timeout duration for API requests

Default value is 30 seconds.

engine - the engine used by Search API to execute the search

Default engine is Google Search.

optionalParameters - parameters to be passed on every request of this the engine, they can be overridden by the WebSearchRequest additional parameters for matching keys

Check Search API for more information on available parameters for each engine

Method Details

builder

public static SearchApiWebSearchEngine.SearchApiWebSearchEngineBuilder builder()

search

public WebSearchResults search(WebSearchRequest webSearchRequest)

Description copied from interface: WebSearchEngine

Performs a search request on the web search engine and returns the search results.

Specified by:

search in interface WebSearchEngine

Parameters:

webSearchRequest - Check Search API for more information on available additional parameters for each engine that can be inside the request

Returns:

the web search results

withApiKey

public static WebSearchEngine withApiKey(String apiKey)