zbendhiba commented on code in PR #14928: URL: https://github.com/apache/camel/pull/14928#discussion_r1691257303
########## components/camel-ai/camel-langchain4j-web-search/src/main/docs/langchain4j-web-search-component.adoc: ########## @@ -0,0 +1,159 @@ += LangChain4j Web Search Component +:doctitle: LangChain4j Web Search +:shortname: langchain4j-web-search +:artifactid: camel-langchain4j-web-search +:description: LangChain4j Web Search Engine +:since: 4.8 +:supportlevel: Preview +:tabs-sync-option: +:component-header: Only producer is supported +//Manually maintained attributes +:group: AI +:camel-spring-boot-name: langchain4j-web-search + +*Since Camel {since}* + +*{component-header}* + +The LangChain4j Web Search component provides support to perform a web search using the https://docs.langchain4j.dev/[LangChain4j] Web Search Engines. + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-langchain4j-web-search</artifactId> + <version>x.x.x</version> + <!-- use the same version as your Camel core version --> +</dependency> +---- + + +== URI format + +[source] +---- +langchain4j-web-search:searchId[?options] +---- + +Where *searchId* can be any string to uniquely identify the endpoint + + +// component-configure options: START + +// component-configure options: END + +// component options: START +include::partial$component-configure-options.adoc[] +include::partial$component-endpoint-options.adoc[] +// component options: END + +// endpoint options: START + +// endpoint options: END + +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END + +include::spring-boot:partial$starter.adoc[] + + +== Using a specific Web Search Engine +The Camel LangChain4j web search component provides an abstraction for interacting with various types of Web Search Engines supported by https://github.com/langchain4j/langchain4j[LangChain4j]. + +To integrate with a specific Web Search Engine, users should follow these steps: + +=== Example of integrating with Tavily +Add the dependency for LangChain4j Tavily Web Search Engine support : + +[source,xml] +---- +<dependency> Review Comment: I improved the doc. Let me know if that looks good to you -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@camel.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org