LangChain4j Web Search

LangChain4j Web Search Engine

Metadata

Property	Value
Scheme	`langchain4j-web-search`
Support Level	Stable
Labels	ai
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-langchain4j-web-search</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`searchId`	string	✓		The id
`additionalParams`	object			The additionalParams is the additional parameters for the search request are a map of key-value pairs that represent additional parameters for the search request.
`geoLocation`	string			The geoLocation is the desired geolocation for search results. Each search engine may have a different set of supported geolocations.
`language`	string			The language is the desired language for search results. The expected values may vary depending on the search engine.
`maxResults`	integer	✓	`1`	The maxResults is the expected number of results to be found if the search request were made. Each search engine may have a different limit for the maximum number of results that can be returned.
`resultType`	object	✓	`CONTENT`	The resultType is the result type of the request. Valid values are LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT, CONTENT, or SNIPPET. CONTENT is the default value; it will return a list of String . You can also specify to return either the Langchain4j Web Search Organic Result object (using LANGCHAIN4J_WEB_SEARCH_ORGANIC_RESULT) or snippet (using SNIPPET) for each result. If maxResults is equal to 1, the response will be a single object instead of a list.
`safeSearch`	boolean			The safeSearch is the safe search flag, indicating whether to enable or disable safe search.
`startIndex`	integer			The startIndex is the start index for search results, which may vary depending on the search engine.
`startPage`	integer			The startPage is the start page number for search results
`webSearchEngine`	object	✓		The WebSearchEngine engine to use. This is mandatory. Use one of the implementations from Langchain4j web search engines.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`webSearchRequest`	object			The webSearchRequest is the custom WebSearchRequest - advanced