Package dev.langchain4j.web.search
Class WebSearchRequest.Builder
-
- All Implemented Interfaces:
public final class WebSearchRequest.Builder
-
-
Method Summary
Modifier and Type Method Description WebSearchRequest.BuildersearchTerms(String searchTerms)Set the search terms. WebSearchRequest.BuildermaxResults(Integer maxResults)Set the maximum number of results. WebSearchRequest.Builderlanguage(String language)Set the desired language for search results. WebSearchRequest.BuildergeoLocation(String geoLocation)Set the desired geolocation for search results. WebSearchRequest.BuilderstartPage(Integer startPage)Set the start page number for search results. WebSearchRequest.BuilderstartIndex(Integer startIndex)Set the start index for search results. WebSearchRequest.BuildersafeSearch(Boolean safeSearch)Set the safe search flag. WebSearchRequest.BuilderadditionalParams(Map<String, Object> additionalParams)Set the additional parameters for the search request. WebSearchRequestbuild()Build the web search request. -
-
Method Detail
-
searchTerms
WebSearchRequest.Builder searchTerms(String searchTerms)
Set the search terms.
- Parameters:
searchTerms- The keyword or keywords desired by the search user.- Returns:
The builder instance.
-
maxResults
WebSearchRequest.Builder maxResults(Integer maxResults)
Set the maximum number of results.
- Parameters:
maxResults- The maximum number of results.- Returns:
The builder instance.
-
language
WebSearchRequest.Builder language(String language)
Set the desired language for search results.
- Parameters:
language- The desired language for search results.- Returns:
The builder instance.
-
geoLocation
WebSearchRequest.Builder geoLocation(String geoLocation)
Set the desired geolocation for search results.
- Parameters:
geoLocation- The desired geolocation for search results.- Returns:
The builder instance.
-
startPage
WebSearchRequest.Builder startPage(Integer startPage)
Set the start page number for search results.
- Parameters:
startPage- The start page number for search results.- Returns:
The builder instance.
-
startIndex
WebSearchRequest.Builder startIndex(Integer startIndex)
Set the start index for search results.
- Parameters:
startIndex- The start index for search results.- Returns:
The builder instance.
-
safeSearch
WebSearchRequest.Builder safeSearch(Boolean safeSearch)
Set the safe search flag.
- Parameters:
safeSearch- The safe search flag.- Returns:
The builder instance.
-
additionalParams
WebSearchRequest.Builder additionalParams(Map<String, Object> additionalParams)
Set the additional parameters for the search request.
- Parameters:
additionalParams- The additional parameters for the search request.- Returns:
The builder instance.
-
build
WebSearchRequest build()
Build the web search request.
- Returns:
The web search request.
-
-
-
-