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

Interface SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
SpringAiChatEndpointBuilderFactory
public static interface SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Spring AI Chat component.

  • Method Details

    • advanced

      default SpringAiChatEndpointBuilderFactory.AdvancedSpringAiChatEndpointBuilder advanced()

    • chatClient

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder chatClient(org.springframework.ai.chat.client.ChatClient chatClient)
      The ChatClient instance to use for chat operations. ChatClient provides advanced features like memory management and advisors. If not provided, a ChatClient will be created from the ChatModel. The option is a: org.springframework.ai.chat.client.ChatClient type. Group: producer
      Parameters:
      chatClient - the value to set
      Returns:
      the dsl builder

    • chatClient

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder chatClient(String chatClient)
      The ChatClient instance to use for chat operations. ChatClient provides advanced features like memory management and advisors. If not provided, a ChatClient will be created from the ChatModel. The option will be converted to a org.springframework.ai.chat.client.ChatClient type. Group: producer
      Parameters:
      chatClient - the value to set
      Returns:
      the dsl builder

    • chatModel

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder chatModel(org.springframework.ai.chat.model.ChatModel chatModel)
      The ChatModel instance to use for chat operations. This is used to create a ChatClient if one is not explicitly provided. The option is a: org.springframework.ai.chat.model.ChatModel type. Group: producer
      Parameters:
      chatModel - the value to set
      Returns:
      the dsl builder

    • chatModel

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder chatModel(String chatModel)
      The ChatModel instance to use for chat operations. This is used to create a ChatClient if one is not explicitly provided. The option will be converted to a org.springframework.ai.chat.model.ChatModel type. Group: producer
      Parameters:
      chatModel - the value to set
      Returns:
      the dsl builder

    • chatOperation

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder chatOperation(org.apache.camel.component.springai.chat.SpringAiChatOperations chatOperation)
      The chat operation to perform. The option is a: org.apache.camel.component.springai.chat.SpringAiChatOperations type. Required: true Default: CHAT_SINGLE_MESSAGE Group: producer
      Parameters:
      chatOperation - the value to set
      Returns:
      the dsl builder

    • chatOperation

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder chatOperation(String chatOperation)
      The chat operation to perform. The option will be converted to a org.apache.camel.component.springai.chat.SpringAiChatOperations type. Required: true Default: CHAT_SINGLE_MESSAGE Group: producer
      Parameters:
      chatOperation - the value to set
      Returns:
      the dsl builder

    • systemMessage

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder systemMessage(String systemMessage)
      Default system message to set context for the conversation. Can be overridden by the CamelSpringAiChatSystemMessage header. The option is a: java.lang.String type. Group: producer
      Parameters:
      systemMessage - the value to set
      Returns:
      the dsl builder

    • tags

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder tags(String tags)
      Tags for discovering and calling Camel route tools. The option is a: java.lang.String type. Group: producer
      Parameters:
      tags - the value to set
      Returns:
      the dsl builder

    • userMessage

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder userMessage(String userMessage)
      Default user message text for multimodal requests. Can be combined with media data in the message body. The option is a: java.lang.String type. Group: producer
      Parameters:
      userMessage - the value to set
      Returns:
      the dsl builder

    • ragTemplate

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder ragTemplate(String ragTemplate)
      Template for formatting RAG (Retrieval Augmented Generation) prompts when augmented data is provided. The template supports two placeholders: {context} for the retrieved documents and {question} for the user's question. Default template is Context:\n{context}\n\nQuestion: {question}. The option is a: java.lang.String type. Default: Context:\n\{context}\n\nQuestion: \{question} Group: rag
      Parameters:
      ragTemplate - the value to set
      Returns:
      the dsl builder

    • similarityThreshold

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder similarityThreshold(double similarityThreshold)
      Similarity threshold for RAG retrieval (default: 0.7). The option is a: double type. Default: 0.7 Group: rag
      Parameters:
      similarityThreshold - the value to set
      Returns:
      the dsl builder

    • similarityThreshold

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder similarityThreshold(String similarityThreshold)
      Similarity threshold for RAG retrieval (default: 0.7). The option will be converted to a double type. Default: 0.7 Group: rag
      Parameters:
      similarityThreshold - the value to set
      Returns:
      the dsl builder

    • topK

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder topK(int topK)
      Number of top documents to retrieve for RAG (default: 5). The option is a: int type. Default: 5 Group: rag
      Parameters:
      topK - the value to set
      Returns:
      the dsl builder

    • topK

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder topK(String topK)
      Number of top documents to retrieve for RAG (default: 5). The option will be converted to a int type. Default: 5 Group: rag
      Parameters:
      topK - the value to set
      Returns:
      the dsl builder

    • vectorStore

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder vectorStore(org.springframework.ai.vectorstore.VectorStore vectorStore)
      VectorStore for automatic RAG retrieval. The option is a: org.springframework.ai.vectorstore.VectorStore type. Group: rag
      Parameters:
      vectorStore - the value to set
      Returns:
      the dsl builder

    • vectorStore

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder vectorStore(String vectorStore)
      VectorStore for automatic RAG retrieval. The option will be converted to a org.springframework.ai.vectorstore.VectorStore type. Group: rag
      Parameters:
      vectorStore - the value to set
      Returns:
      the dsl builder

    • safeguardFailureResponse

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder safeguardFailureResponse(String safeguardFailureResponse)
      Failure response message for SafeGuard advisor when sensitive content is detected. If not specified, a default message will be used. The option is a: java.lang.String type. Group: security
      Parameters:
      safeguardFailureResponse - the value to set
      Returns:
      the dsl builder

    • safeguardSensitiveWords

      default SpringAiChatEndpointBuilderFactory.SpringAiChatEndpointBuilder safeguardSensitiveWords(String safeguardSensitiveWords)
      Comma-separated list of sensitive words for SafeGuard advisor. When provided, the SafeGuard advisor will be enabled to prevent generation of content containing these words. The option is a: java.lang.String type. Group: security
      Parameters:
      safeguardSensitiveWords - the value to set
      Returns:
      the dsl builder