Class TavilyWebSearchEngine

java.lang.Object

dev.langchain4j.web.search.tavily.TavilyWebSearchEngine

All Implemented Interfaces:

WebSearchEngine

public class TavilyWebSearchEngine
extends Object
implements WebSearchEngine

Represents Tavily Search API as a WebSearchEngine. See more details here.
When includeRawContent is set to true, the raw content will appear in the WebSearchOrganicResult.content() field of each result.
When includeAnswer is set to true, the answer will appear in the WebSearchOrganicResult.snippet() field of the first result. In this case, the WebSearchOrganicResult.url() of the first result will always be "https://tavily.com/" and the WebSearchOrganicResult.title() will always be "Tavily Search API".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TavilyWebSearchEngine.TavilyWebSearchEngineBuilder

Constructor Summary

Constructors

Constructor	Description
TavilyWebSearchEngine(TavilyWebSearchEngine.TavilyWebSearchEngineBuilder builder)
TavilyWebSearchEngine(String baseUrl, String apiKey, Duration timeout, String searchDepth, Boolean includeAnswer, Boolean includeRawContent, List<String> includeDomains, List<String> excludeDomains)

Method Summary

Modifier and Type	Method	Description
static TavilyWebSearchEngine.TavilyWebSearchEngineBuilder	builder()
WebSearchResults	search(WebSearchRequest webSearchRequest)	Performs a search request on the web search engine and returns the search results.
CompletableFuture<WebSearchResults>	searchAsync(WebSearchRequest webSearchRequest)	Genuinely non-blocking counterpart of search(WebSearchRequest), used by the asynchronous and reactive RAG flow.
static TavilyWebSearchEngine	withApiKey(String apiKey)

Methods inherited from class Object

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

Methods inherited from interface WebSearchEngine

search

Constructor Details

TavilyWebSearchEngine

public TavilyWebSearchEngine(String baseUrl,
 String apiKey,
 Duration timeout,
 String searchDepth,
 Boolean includeAnswer,
 Boolean includeRawContent,
 List<String> includeDomains,
 List<String> excludeDomains)

TavilyWebSearchEngine

public TavilyWebSearchEngine(TavilyWebSearchEngine.TavilyWebSearchEngineBuilder builder)

Method Details

builder

public static TavilyWebSearchEngine.TavilyWebSearchEngineBuilder 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 - the search request

Returns:

the web search results

searchAsync

public CompletableFuture<WebSearchResults> searchAsync(WebSearchRequest webSearchRequest)

Genuinely non-blocking counterpart of search(WebSearchRequest), used by the asynchronous and reactive RAG flow. The underlying HTTP call is dispatched asynchronously (no thread is parked while it is in flight), and cancelling the returned future aborts the in-flight call (best-effort).

Specified by:

searchAsync in interface WebSearchEngine

Parameters:

webSearchRequest - the search request

Returns:

a CompletableFuture of the web search results

withApiKey

public static TavilyWebSearchEngine withApiKey(String apiKey)