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

Class OpenAIEndpointBuilderFactory.OpenAIHeaderNameBuilder

java.lang.Object
org.apache.camel.builder.endpoint.dsl.OpenAIEndpointBuilderFactory.OpenAIHeaderNameBuilder
Enclosing interface:
OpenAIEndpointBuilderFactory
public static class OpenAIEndpointBuilderFactory.OpenAIHeaderNameBuilder extends Object
The builder of headers' name for the OpenAI component.

  • Constructor Details

    • OpenAIHeaderNameBuilder

      public OpenAIHeaderNameBuilder()

  • Method Details

    • openAIUserMessage

      public String openAIUserMessage()
      The user message to send to the OpenAI chat completion API. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIUserMessage.

    • openAISystemMessage

      public String openAISystemMessage()
      The system message to provide context and instructions to the model. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAISystemMessage.

    • openAIDeveloperMessage

      public String openAIDeveloperMessage()
      The developer message to provide additional instructions to the model. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIDeveloperMessage.

    • openAIModel

      public String openAIModel()
      The model to use for chat completion. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIModel.

    • openAITemperature

      public String openAITemperature()
      Controls randomness in the response. Higher values (e.g., 0.8) make output more random, lower values (e.g., 0.2) make it more deterministic. The option is a: Double type. Group: producer
      Returns:
      the name of the header OpenAITemperature.

    • openAITopP

      public String openAITopP()
      An alternative to temperature for controlling randomness. Uses nucleus sampling where the model considers tokens with top_p probability mass. The option is a: Double type. Group: producer
      Returns:
      the name of the header OpenAITopP.

    • openAIMaxTokens

      public String openAIMaxTokens()
      The maximum number of tokens to generate in the completion. The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAIMaxTokens.

    • openAIStreaming

      public String openAIStreaming()
      Whether to stream the response back incrementally. The option is a: Boolean type. Group: producer
      Returns:
      the name of the header OpenAIStreaming.

    • openAIOutputClass

      public String openAIOutputClass()
      The Java class to use for structured output parsing. The option is a: Class type. Group: producer
      Returns:
      the name of the header OpenAIOutputClass.

    • openAIJsonSchema

      public String openAIJsonSchema()
      The JSON schema to use for structured output validation. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIJsonSchema.

    • openAIResponseModel

      public String openAIResponseModel()
      The model used for the completion response. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIResponseModel.

    • openAIResponseId

      public String openAIResponseId()
      The unique identifier for the completion response. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIResponseId.

    • openAIFinishReason

      public String openAIFinishReason()
      The reason the completion finished (e.g., stop, length, content_filter). The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIFinishReason.

    • openAIPromptTokens

      public String openAIPromptTokens()
      The number of tokens used in the prompt. The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAIPromptTokens.

    • openAICompletionTokens

      public String openAICompletionTokens()
      The number of tokens used in the completion. The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAICompletionTokens.

    • openAITotalTokens

      public String openAITotalTokens()
      The total number of tokens used (prompt completion). The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAITotalTokens.

    • openAIResponse

      public String openAIResponse()
      The complete OpenAI response object. The option is a: com.openai.models.ChatCompletion type. Group: producer
      Returns:
      the name of the header OpenAIResponse.

    • openAIEmbeddingModel

      public String openAIEmbeddingModel()
      The model to use for embeddings. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIEmbeddingModel.

    • openAIEmbeddingDimensions

      public String openAIEmbeddingDimensions()
      Number of output dimensions. The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAIEmbeddingDimensions.

    • openAIEmbeddingResponseModel

      public String openAIEmbeddingResponseModel()
      The embedding model used in the response. The option is a: String type. Group: producer
      Returns:
      the name of the header OpenAIEmbeddingResponseModel.

    • openAIEmbeddingCount

      public String openAIEmbeddingCount()
      Number of embeddings returned. The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAIEmbeddingCount.

    • openAIEmbeddingVectorSize

      public String openAIEmbeddingVectorSize()
      Vector dimensions of the embeddings. The option is a: Integer type. Group: producer
      Returns:
      the name of the header OpenAIEmbeddingVectorSize.

    • openAIReferenceEmbedding

      public String openAIReferenceEmbedding()
      Reference embedding vector for similarity comparison. The option is a: List<Float> type. Group: producer
      Returns:
      the name of the header OpenAIReferenceEmbedding.

    • openAISimilarityScore

      public String openAISimilarityScore()
      Calculated cosine similarity score (0.0 to 1.0). The option is a: Double type. Group: producer
      Returns:
      the name of the header OpenAISimilarityScore.

    • openAIOriginalText

      public String openAIOriginalText()
      Original text content when embeddings operation is used. The option is a: String or List<String> type. Group: producer
      Returns:
      the name of the header OpenAIOriginalText.