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

Class SpringAiChatEndpointBuilderFactory.SpringAiChatHeaderNameBuilder

java.lang.Object
org.apache.camel.builder.endpoint.dsl.SpringAiChatEndpointBuilderFactory.SpringAiChatHeaderNameBuilder
Enclosing interface:
SpringAiChatEndpointBuilderFactory
public static class SpringAiChatEndpointBuilderFactory.SpringAiChatHeaderNameBuilder extends Object
The builder of headers' name for the Spring AI Chat component.

  • Constructor Details

    • SpringAiChatHeaderNameBuilder

      public SpringAiChatHeaderNameBuilder()

  • Method Details

    • springAiChatResponse

      public String springAiChatResponse()
      The response from the chat model. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatResponse.

    • springAiInputTokenCount

      public String springAiInputTokenCount()
      The number of input tokens used. The option is a: Integer type. Group: producer
      Returns:
      the name of the header SpringAiInputTokenCount.

    • springAiOutputTokenCount

      public String springAiOutputTokenCount()
      The number of output tokens used. The option is a: Integer type. Group: producer
      Returns:
      the name of the header SpringAiOutputTokenCount.

    • springAiTotalTokenCount

      public String springAiTotalTokenCount()
      The total number of tokens used. The option is a: Integer type. Group: producer
      Returns:
      the name of the header SpringAiTotalTokenCount.

    • springAiChatPromptTemplate

      public String springAiChatPromptTemplate()
      The prompt template with placeholders for variable substitution. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatPromptTemplate.

    • springAiChatAugmentedData

      public String springAiChatAugmentedData()
      Augmented data for RAG as List. The option is a: java.util.List<org.springframework.ai.document.Document> type. Group: producer
      Returns:
      the name of the header SpringAiChatAugmentedData.

    • springAiChatSystemMessage

      public String springAiChatSystemMessage()
      System message for the conversation. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatSystemMessage.

    • springAiChatTemperature

      public String springAiChatTemperature()
      Temperature parameter for response randomness (0.0-2.0). The option is a: Double type. Group: producer
      Returns:
      the name of the header SpringAiChatTemperature.

    • springAiChatMaxTokens

      public String springAiChatMaxTokens()
      Maximum tokens in the response. The option is a: Integer type. Group: producer
      Returns:
      the name of the header SpringAiChatMaxTokens.

    • springAiChatTopP

      public String springAiChatTopP()
      Top P parameter for nucleus sampling. The option is a: Double type. Group: producer
      Returns:
      the name of the header SpringAiChatTopP.

    • springAiChatTopK

      public String springAiChatTopK()
      Top K parameter for sampling. The option is a: Integer type. Group: producer
      Returns:
      the name of the header SpringAiChatTopK.

    • springAiChatUserMessage

      public String springAiChatUserMessage()
      User message text for multimodal requests. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatUserMessage.

    • springAiChatMediaData

      public String springAiChatMediaData()
      Media data for multimodal requests (image or audio). The option is a: byte[] type. Group: producer
      Returns:
      the name of the header SpringAiChatMediaData.

    • springAiChatMediaType

      public String springAiChatMediaType()
      Media type (MIME type) for multimodal requests (e.g., image/png, audio/wav). The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatMediaType.

    • springAiChatOutputFormat

      public String springAiChatOutputFormat()
      The output format type for structured output conversion (BEAN, MAP, LIST). The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatOutputFormat.

    • springAiChatOutputClass

      public String springAiChatOutputClass()
      The Java class to use for structured output bean conversion. The option is a: Class<?> type. Group: producer
      Returns:
      the name of the header SpringAiChatOutputClass.

    • springAiChatStructuredOutput

      public String springAiChatStructuredOutput()
      The structured output converted from the chat response. The option is a: Object type. Group: producer
      Returns:
      the name of the header SpringAiChatStructuredOutput.

    • springAiChatSafeguardSensitiveWords

      public String springAiChatSafeguardSensitiveWords()
      Comma-separated list of sensitive words for SafeGuard advisor. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatSafeguardSensitiveWords.

    • springAiChatSafeguardFailureResponse

      public String springAiChatSafeguardFailureResponse()
      Failure response message for SafeGuard advisor when sensitive content is detected. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatSafeguardFailureResponse.

    • springAiChatSafeguardOrder

      public String springAiChatSafeguardOrder()
      Order of execution for SafeGuard advisor. The option is a: Integer type. Group: producer
      Returns:
      the name of the header SpringAiChatSafeguardOrder.

    • springAiChatAdvisors

      public String springAiChatAdvisors()
      List of custom advisors to add to the request. The option is a: java.util.List<org.springframework.ai.chat.client.advisor.api.Advisor> type. Group: producer
      Returns:
      the name of the header SpringAiChatAdvisors.

    • springAiChatEntityClass

      public String springAiChatEntityClass()
      The Java class to use for entity response conversion. The option is a: Class<?> type. Group: producer
      Returns:
      the name of the header SpringAiChatEntityClass.

    • springAiChatUserMetadata

      public String springAiChatUserMetadata()
      Metadata to attach to user messages. The option is a: java.util.Map<String, Object> type. Group: producer
      Returns:
      the name of the header SpringAiChatUserMetadata.

    • springAiChatSystemMetadata

      public String springAiChatSystemMetadata()
      Metadata to attach to system messages. The option is a: java.util.Map<String, Object> type. Group: producer
      Returns:
      the name of the header SpringAiChatSystemMetadata.

    • springAiChatConversationId

      public String springAiChatConversationId()
      Conversation ID for managing separate conversation contexts in chat memory. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatConversationId.

    • springAiChatMaxFileSize

      public String springAiChatMaxFileSize()
      Maximum file size in bytes for multimodal content. Overrides endpoint configuration. The option is a: Long type. Group: producer
      Returns:
      the name of the header SpringAiChatMaxFileSize.

    • springAiChatFinishReason

      public String springAiChatFinishReason()
      The reason why the chat response generation stopped (e.g., STOP, LENGTH, TOOL_CALLS). The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatFinishReason.

    • springAiChatModelName

      public String springAiChatModelName()
      The name of the AI model used to generate the response. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatModelName.

    • springAiChatResponseId

      public String springAiChatResponseId()
      The unique ID of the chat response. The option is a: String type. Group: producer
      Returns:
      the name of the header SpringAiChatResponseId.

    • springAiChatResponseMetadata

      public String springAiChatResponseMetadata()
      Full response metadata as a Map containing all available metadata fields. The option is a: java.util.Map<String, Object> type. Group: producer
      Returns:
      the name of the header SpringAiChatResponseMetadata.