Package org.apache.camel.builder.endpoint.dsl

Interface LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
LangChain4jWebSearchEndpointBuilderFactory
public static interface LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the LangChain4j Web Search component.

  • Method Details

    • advanced

      default LangChain4jWebSearchEndpointBuilderFactory.AdvancedLangChain4jWebSearchEndpointBuilder advanced()

    • additionalParams

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder additionalParams(Map<String,Object> additionalParams)
      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. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. Group: producer
      Parameters:
      additionalParams - the value to set
      Returns:
      the dsl builder

    • additionalParams

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder additionalParams(String additionalParams)
      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. The option will be converted to a java.util.Map<java.lang.String, java.lang.Object> type. Group: producer
      Parameters:
      additionalParams - the value to set
      Returns:
      the dsl builder

    • geoLocation

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder geoLocation(String geoLocation)
      The geoLocation is the desired geolocation for search results. Each search engine may have a different set of supported geolocations. The option is a: java.lang.String type. Group: producer
      Parameters:
      geoLocation - the value to set
      Returns:
      the dsl builder

    • language

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder language(String language)
      The language is the desired language for search results. The expected values may vary depending on the search engine. The option is a: java.lang.String type. Group: producer
      Parameters:
      language - the value to set
      Returns:
      the dsl builder

    • maxResults

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder maxResults(Integer maxResults)
      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. The option is a: java.lang.Integer type. Required: true Default: 1 Group: producer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • maxResults

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder maxResults(String maxResults)
      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. The option will be converted to a java.lang.Integer type. Required: true Default: 1 Group: producer
      Parameters:
      maxResults - the value to set
      Returns:
      the dsl builder

    • resultType

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder resultType(org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchResultType resultType)
      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. The option is a: org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchResultType type. Required: true Default: CONTENT Group: producer
      Parameters:
      resultType - the value to set
      Returns:
      the dsl builder

    • resultType

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder resultType(String resultType)
      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. The option will be converted to a org.apache.camel.component.langchain4j.web.search.LangChain4jWebSearchResultType type. Required: true Default: CONTENT Group: producer
      Parameters:
      resultType - the value to set
      Returns:
      the dsl builder

    • safeSearch

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder safeSearch(Boolean safeSearch)
      The safeSearch is the safe search flag, indicating whether to enable or disable safe search. The option is a: java.lang.Boolean type. Group: producer
      Parameters:
      safeSearch - the value to set
      Returns:
      the dsl builder

    • safeSearch

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder safeSearch(String safeSearch)
      The safeSearch is the safe search flag, indicating whether to enable or disable safe search. The option will be converted to a java.lang.Boolean type. Group: producer
      Parameters:
      safeSearch - the value to set
      Returns:
      the dsl builder

    • startIndex

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder startIndex(Integer startIndex)
      The startIndex is the start index for search results, which may vary depending on the search engine. The option is a: java.lang.Integer type. Group: producer
      Parameters:
      startIndex - the value to set
      Returns:
      the dsl builder

    • startIndex

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder startIndex(String startIndex)
      The startIndex is the start index for search results, which may vary depending on the search engine. The option will be converted to a java.lang.Integer type. Group: producer
      Parameters:
      startIndex - the value to set
      Returns:
      the dsl builder

    • startPage

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder startPage(Integer startPage)
      The startPage is the start page number for search results. The option is a: java.lang.Integer type. Group: producer
      Parameters:
      startPage - the value to set
      Returns:
      the dsl builder

    • startPage

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder startPage(String startPage)
      The startPage is the start page number for search results. The option will be converted to a java.lang.Integer type. Group: producer
      Parameters:
      startPage - the value to set
      Returns:
      the dsl builder

    • webSearchEngine

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder webSearchEngine(dev.langchain4j.web.search.WebSearchEngine webSearchEngine)
      The WebSearchEngine engine to use. This is mandatory. Use one of the implementations from Langchain4j web search engines. The option is a: dev.langchain4j.web.search.WebSearchEngine type. Required: true Group: producer
      Parameters:
      webSearchEngine - the value to set
      Returns:
      the dsl builder

    • webSearchEngine

      default LangChain4jWebSearchEndpointBuilderFactory.LangChain4jWebSearchEndpointBuilder webSearchEngine(String webSearchEngine)
      The WebSearchEngine engine to use. This is mandatory. Use one of the implementations from Langchain4j web search engines. The option will be converted to a dev.langchain4j.web.search.WebSearchEngine type. Required: true Group: producer
      Parameters:
      webSearchEngine - the value to set
      Returns:
      the dsl builder