Package dev.langchain4j.web.search

Class WebSearchTool

java.lang.Object

dev.langchain4j.web.search.WebSearchTool

public class WebSearchTool
extends Object

Constructor Summary

Constructors

Constructor	Description
WebSearchTool(WebSearchEngine searchEngine)

Method Summary

Modifier and Type	Method	Description
static WebSearchTool	from(WebSearchEngine searchEngine)	Creates a new WebSearchTool with the specified web search engine.
String	searchWeb(String query)	Runs a search query on the web search engine and returns a pretty-string representation of the search results.

Methods inherited from class java.lang.Object

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

Constructor Details

WebSearchTool

public WebSearchTool(WebSearchEngine searchEngine)

Method Details

searchWeb

public String searchWeb(String query)

Runs a search query on the web search engine and returns a pretty-string representation of the search results.

Parameters:

query - the search user query

Returns:

a pretty-string representation of the search results

from

public static WebSearchTool from(WebSearchEngine searchEngine)

Creates a new WebSearchTool with the specified web search engine.

Parameters:

searchEngine - the web search engine to use for searching the web

Returns:

a new WebSearchTool