Module io.helidon.integrations.langchain4j.providers.openai
Package io.helidon.integrations.langchain4j.providers.openai

Class OpenAiStreamingChatModelConfig.BuilderBase<BUILDER extends OpenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiStreamingChatModelConfig>

java.lang.Object
io.helidon.integrations.langchain4j.providers.openai.OpenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
OpenAiStreamingChatModelConfig.Builder
Enclosing interface:
OpenAiStreamingChatModelConfig
public abstract static class OpenAiStreamingChatModelConfig.BuilderBase<BUILDER extends OpenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiStreamingChatModelConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for OpenAiStreamingChatModelConfig.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    OpenAiStreamingChatModelConfig.BuilderBase.OpenAiStreamingChatModelConfigImpl
    Generated implementation of the prototype, can be extended by descendant prototype implementations.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    BuilderBase()
    Protected to support extensibility.

  • Method Summary

    Modifier and Type
    Method
    Description
    BUILDER
    addCustomHeaders(Map<String,String> customHeaders)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map) This method keeps existing values, then puts all new values into the map.
    BUILDER
    addListener(dev.langchain4j.model.chat.listener.ChatModelListener listener)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
    BUILDER
    addListeners(List<? extends dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
    BUILDER
    addLogitBias(Map<String,Integer> logitBias)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map) This method keeps existing values, then puts all new values into the map.
    BUILDER
    addMetadata(Map<String,String> metadata)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map) This method keeps existing values, then puts all new values into the map.
    BUILDER
    addStop(String stop)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
    BUILDER
    addStop(List<String> stop)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
    Optional<String>
    apiKey()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.apiKey(java.lang.String)
    BUILDER
    apiKey(String apiKey)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.apiKey(java.lang.String)
    Optional<String>
    baseUrl()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.baseUrl(java.lang.String)
    BUILDER
    baseUrl(String baseUrl)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.baseUrl(java.lang.String)
    BUILDER
    clearApiKey()
    Clear existing value of this property.
    BUILDER
    clearBaseUrl()
    Clear existing value of this property.
    BUILDER
    clearDefaultRequestParameters()
    Clear existing value of this property.
    BUILDER
    clearFrequencyPenalty()
    Clear existing value of this property.
    BUILDER
    clearHttpClientBuilder()
    Clear existing value of this property.
    BUILDER
    clearLogger()
    Clear existing value of this property.
    BUILDER
    clearLogRequests()
    Clear existing value of this property.
    BUILDER
    clearLogResponses()
    Clear existing value of this property.
    BUILDER
    clearMaxCompletionTokens()
    Clear existing value of this property.
    BUILDER
    clearMaxTokens()
    Clear existing value of this property.
    BUILDER
    clearModelName()
    Clear existing value of this property.
    BUILDER
    clearOrganizationId()
    Clear existing value of this property.
    BUILDER
    clearParallelToolCalls()
    Clear existing value of this property.
    BUILDER
    clearPresencePenalty()
    Clear existing value of this property.
    BUILDER
    clearProjectId()
    Clear existing value of this property.
    BUILDER
    clearResponseFormat()
    Clear existing value of this property.
    BUILDER
    clearReturnThinking()
    Clear existing value of this property.
    BUILDER
    clearSeed()
    Clear existing value of this property.
    BUILDER
    clearServiceTier()
    Clear existing value of this property.
    BUILDER
    clearStore()
    Clear existing value of this property.
    BUILDER
    clearStrictJsonSchema()
    Clear existing value of this property.
    BUILDER
    clearStrictTools()
    Clear existing value of this property.
    BUILDER
    clearTemperature()
    Clear existing value of this property.
    BUILDER
    clearTimeout()
    Clear existing value of this property.
    BUILDER
    clearTopP()
    Clear existing value of this property.
    BUILDER
    clearUser()
    Clear existing value of this property.
    Optional<Config>
    config()
    If this instance was configured, this would be the config instance used.
    BUILDER
    config(Config config)
    Deprecated.
    use config(io.helidon.config.Config)
    BUILDER
    config(Config config)
    Update builder from configuration (node of this type).
    Map<String,String>
    customHeaders()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map)
    BUILDER
    customHeaders(Map<String,String> customHeaders)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map) This method replaces all values with the new ones.
    Optional<dev.langchain4j.model.chat.request.ChatRequestParameters>
    defaultRequestParameters()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
    BUILDER
    defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
    BUILDER
    defaultRequestParameters(Consumer<dev.langchain4j.model.chat.request.DefaultChatRequestParameters.Builder<?>> consumer)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
    boolean
    enabled()
    If set to false (default), OpenAiStreamingChatModel will not be available even if configured.
    BUILDER
    enabled(boolean enabled)
    If set to false (default), OpenAiStreamingChatModel will not be available even if configured.
    Optional<Double>
    frequencyPenalty()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.frequencyPenalty(java.lang.Double)
    BUILDER
    frequencyPenalty(double frequencyPenalty)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.frequencyPenalty(java.lang.Double)
    BUILDER
    from(OpenAiStreamingChatModelConfig prototype)
    Update this builder from an existing prototype instance.
    BUILDER
    from(OpenAiStreamingChatModelConfig.BuilderBase<?,?> builder)
    Update this builder from an existing prototype builder instance.
    Optional<dev.langchain4j.http.client.HttpClientBuilder>
    httpClientBuilder()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
    BUILDER
    httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder httpClientBuilder)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
    List<dev.langchain4j.model.chat.listener.ChatModelListener>
    listeners()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
    BUILDER
    listeners(List<? extends dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
    BUILDER
    listenersDiscoverServices(boolean discoverServices)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
    Optional<org.slf4j.Logger>
    logger()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logger(org.slf4j.Logger)
    BUILDER
    logger(org.slf4j.Logger logger)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logger(org.slf4j.Logger)
    Map<String,Integer>
    logitBias()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map)
    BUILDER
    logitBias(Map<String,Integer> logitBias)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map) This method replaces all values with the new ones.
    Optional<Boolean>
    logRequests()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logRequests(java.lang.Boolean)
    BUILDER
    logRequests(boolean logRequests)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logRequests(java.lang.Boolean)
    Optional<Boolean>
    logResponses()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logResponses(java.lang.Boolean)
    BUILDER
    logResponses(boolean logResponses)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logResponses(java.lang.Boolean)
    Optional<Integer>
    maxCompletionTokens()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxCompletionTokens(java.lang.Integer)
    BUILDER
    maxCompletionTokens(int maxCompletionTokens)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxCompletionTokens(java.lang.Integer)
    Optional<Integer>
    maxTokens()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxTokens(java.lang.Integer)
    BUILDER
    maxTokens(int maxTokens)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxTokens(java.lang.Integer)
    Map<String,String>
    metadata()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map)
    BUILDER
    metadata(Map<String,String> metadata)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map) This method replaces all values with the new ones.
    Optional<String>
    modelName()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.modelName(java.lang.String)
    BUILDER
    modelName(String modelName)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.modelName(java.lang.String)
    Optional<String>
    organizationId()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.organizationId(java.lang.String)
    BUILDER
    organizationId(String organizationId)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.organizationId(java.lang.String)
    Optional<Boolean>
    parallelToolCalls()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.parallelToolCalls(java.lang.Boolean)
    BUILDER
    parallelToolCalls(boolean parallelToolCalls)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.parallelToolCalls(java.lang.Boolean)
    protected void
    preBuildPrototype()
    Handles providers and decorators.
    Optional<Double>
    presencePenalty()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.presencePenalty(java.lang.Double)
    BUILDER
    presencePenalty(double presencePenalty)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.presencePenalty(java.lang.Double)
    Optional<String>
    projectId()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.projectId(java.lang.String)
    BUILDER
    projectId(String projectId)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.projectId(java.lang.String)
    BUILDER
    putCustomHeader(String key, String customHeader)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
    BUILDER
    putLogitBia(String key, Integer logitBia)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
    BUILDER
    putMetadata(String key, String metadata)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
    Optional<String>
    responseFormat()
    Enable a "JSON mode" in the model configuration.
    BUILDER
    responseFormat(String responseFormat)
    Enable a "JSON mode" in the model configuration.
    Optional<Boolean>
    returnThinking()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.returnThinking(java.lang.Boolean)
    BUILDER
    returnThinking(boolean returnThinking)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.returnThinking(java.lang.Boolean)
    Optional<Integer>
    seed()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.seed(java.lang.Integer)
    BUILDER
    seed(int seed)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.seed(java.lang.Integer)
    BUILDER
    serviceRegistry(ServiceRegistry registry)
    Provide an explicit registry instance to use.
    Optional<String>
    serviceTier()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.serviceTier(java.lang.String)
    BUILDER
    serviceTier(String serviceTier)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.serviceTier(java.lang.String)
    List<String>
    stop()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
    BUILDER
    stop(List<String> stop)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
    Optional<Boolean>
    store()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.store(java.lang.Boolean)
    BUILDER
    store(boolean store)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.store(java.lang.Boolean)
    Optional<Boolean>
    strictJsonSchema()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictJsonSchema(java.lang.Boolean)
    BUILDER
    strictJsonSchema(boolean strictJsonSchema)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictJsonSchema(java.lang.Boolean)
    Optional<Boolean>
    strictTools()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictTools(java.lang.Boolean)
    BUILDER
    strictTools(boolean strictTools)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictTools(java.lang.Boolean)
    Optional<Double>
    temperature()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.temperature(java.lang.Double)
    BUILDER
    temperature(double temperature)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.temperature(java.lang.Double)
    Optional<Duration>
    timeout()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.timeout(java.time.Duration)
    BUILDER
    timeout(Duration timeout)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.timeout(java.time.Duration)
    Optional<Double>
    topP()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.topP(java.lang.Double)
    BUILDER
    topP(double topP)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.topP(java.lang.Double)
    String
    toString()
     
    Optional<String>
    user()
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.user(java.lang.String)
    BUILDER
    user(String user)
    Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.user(java.lang.String)
    protected void
    validatePrototype()
    Validates required properties.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface io.helidon.builder.api.Prototype.Builder

    buildPrototype, self

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenAiStreamingChatModelConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(OpenAiStreamingChatModelConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiStreamingChatModelConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends OpenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiStreamingChatModelConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • serviceRegistry

      public BUILDER serviceRegistry(ServiceRegistry registry)
      Provide an explicit registry instance to use.

      If not configured, the GlobalServiceRegistry would be used to discover services.

      Parameters:
      registry - service registry instance
      Returns:
      updated builder instance

    • enabled

      public BUILDER enabled(boolean enabled)
      If set to false (default), OpenAiStreamingChatModel will not be available even if configured.
      Parameters:
      enabled - whether OpenAiStreamingChatModel is enabled, defaults to false
      Returns:
      updated builder instance
      See Also:

    • clearParallelToolCalls

      public BUILDER clearParallelToolCalls()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • parallelToolCalls

      public BUILDER parallelToolCalls(boolean parallelToolCalls)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.parallelToolCalls(java.lang.Boolean)
      Parameters:
      parallelToolCalls - Boolean property
      Returns:
      updated builder instance
      See Also:

    • metadata

      public BUILDER metadata(Map<String,String> metadata)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map) This method replaces all values with the new ones.
      Parameters:
      metadata - Map property
      Returns:
      updated builder instance
      See Also:

    • addMetadata

      public BUILDER addMetadata(Map<String,String> metadata)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map) This method keeps existing values, then puts all new values into the map.
      Parameters:
      metadata - Map property
      Returns:
      updated builder instance
      See Also:

    • putMetadata

      public BUILDER putMetadata(String key, String metadata)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      metadata - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearApiKey

      public BUILDER clearApiKey()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • apiKey

      public BUILDER apiKey(String apiKey)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.apiKey(java.lang.String)
      Parameters:
      apiKey - String property
      Returns:
      updated builder instance
      See Also:

    • clearStrictJsonSchema

      public BUILDER clearStrictJsonSchema()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • strictJsonSchema

      public BUILDER strictJsonSchema(boolean strictJsonSchema)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictJsonSchema(java.lang.Boolean)
      Parameters:
      strictJsonSchema - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearSeed

      public BUILDER clearSeed()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • seed

      public BUILDER seed(int seed)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.seed(java.lang.Integer)
      Parameters:
      seed - Integer property
      Returns:
      updated builder instance
      See Also:

    • clearLogger

      public BUILDER clearLogger()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • logger

      public BUILDER logger(org.slf4j.Logger logger)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logger(org.slf4j.Logger)
      Parameters:
      logger - Logger property
      Returns:
      updated builder instance
      See Also:

    • clearDefaultRequestParameters

      public BUILDER clearDefaultRequestParameters()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • defaultRequestParameters

      public BUILDER defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters defaultRequestParameters)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
      Parameters:
      defaultRequestParameters - ChatRequestParameters property
      Returns:
      updated builder instance
      See Also:

    • defaultRequestParameters

      public BUILDER defaultRequestParameters(Consumer<dev.langchain4j.model.chat.request.DefaultChatRequestParameters.Builder<?>> consumer)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
      Parameters:
      consumer - ChatRequestParameters property
      Returns:
      updated builder instance
      See Also:

    • clearTimeout

      public BUILDER clearTimeout()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • timeout

      public BUILDER timeout(Duration timeout)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.timeout(java.time.Duration)
      Parameters:
      timeout - Duration property
      Returns:
      updated builder instance
      See Also:

    • clearOrganizationId

      public BUILDER clearOrganizationId()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • organizationId

      public BUILDER organizationId(String organizationId)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.organizationId(java.lang.String)
      Parameters:
      organizationId - String property
      Returns:
      updated builder instance
      See Also:

    • clearPresencePenalty

      public BUILDER clearPresencePenalty()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • presencePenalty

      public BUILDER presencePenalty(double presencePenalty)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.presencePenalty(java.lang.Double)
      Parameters:
      presencePenalty - Double property
      Returns:
      updated builder instance
      See Also:

    • clearHttpClientBuilder

      public BUILDER clearHttpClientBuilder()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • httpClientBuilder

      public BUILDER httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder httpClientBuilder)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Parameters:
      httpClientBuilder - HttpClientBuilder property
      Returns:
      updated builder instance
      See Also:

    • clearTemperature

      public BUILDER clearTemperature()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • temperature

      public BUILDER temperature(double temperature)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.temperature(java.lang.Double)
      Parameters:
      temperature - Double property
      Returns:
      updated builder instance
      See Also:

    • clearMaxTokens

      public BUILDER clearMaxTokens()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • maxTokens

      public BUILDER maxTokens(int maxTokens)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxTokens(java.lang.Integer)
      Parameters:
      maxTokens - Integer property
      Returns:
      updated builder instance
      See Also:

    • logitBias

      public BUILDER logitBias(Map<String,Integer> logitBias)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map) This method replaces all values with the new ones.
      Parameters:
      logitBias - Map property
      Returns:
      updated builder instance
      See Also:

    • addLogitBias

      public BUILDER addLogitBias(Map<String,Integer> logitBias)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map) This method keeps existing values, then puts all new values into the map.
      Parameters:
      logitBias - Map property
      Returns:
      updated builder instance
      See Also:

    • putLogitBia

      public BUILDER putLogitBia(String key, Integer logitBia)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      logitBia - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearFrequencyPenalty

      public BUILDER clearFrequencyPenalty()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • frequencyPenalty

      public BUILDER frequencyPenalty(double frequencyPenalty)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.frequencyPenalty(java.lang.Double)
      Parameters:
      frequencyPenalty - Double property
      Returns:
      updated builder instance
      See Also:

    • customHeaders

      public BUILDER customHeaders(Map<String,String> customHeaders)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map) This method replaces all values with the new ones.
      Parameters:
      customHeaders - Map property
      Returns:
      updated builder instance
      See Also:

    • addCustomHeaders

      public BUILDER addCustomHeaders(Map<String,String> customHeaders)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map) This method keeps existing values, then puts all new values into the map.
      Parameters:
      customHeaders - Map property
      Returns:
      updated builder instance
      See Also:

    • putCustomHeader

      public BUILDER putCustomHeader(String key, String customHeader)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map) This method adds a new value to the map, or replaces it if the key already exists.
      Parameters:
      key - key to add or replace
      customHeader - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearMaxCompletionTokens

      public BUILDER clearMaxCompletionTokens()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • maxCompletionTokens

      public BUILDER maxCompletionTokens(int maxCompletionTokens)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxCompletionTokens(java.lang.Integer)
      Parameters:
      maxCompletionTokens - Integer property
      Returns:
      updated builder instance
      See Also:

    • listenersDiscoverServices

      public BUILDER listenersDiscoverServices(boolean discoverServices)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
      Parameters:
      discoverServices - whether to discover implementations through service loader
      Returns:
      updated builder instance
      See Also:

    • listeners

      public BUILDER listeners(List<? extends dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
      Parameters:
      listeners - List property
      Returns:
      updated builder instance
      See Also:

    • addListeners

      public BUILDER addListeners(List<? extends dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
      Parameters:
      listeners - List property
      Returns:
      updated builder instance
      See Also:

    • addListener

      public BUILDER addListener(dev.langchain4j.model.chat.listener.ChatModelListener listener)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
      Parameters:
      listener - List property
      Returns:
      updated builder instance
      See Also:

    • clearStore

      public BUILDER clearStore()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • store

      public BUILDER store(boolean store)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.store(java.lang.Boolean)
      Parameters:
      store - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearLogResponses

      public BUILDER clearLogResponses()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • logResponses

      public BUILDER logResponses(boolean logResponses)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logResponses(java.lang.Boolean)
      Parameters:
      logResponses - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearTopP

      public BUILDER clearTopP()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • topP

      public BUILDER topP(double topP)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.topP(java.lang.Double)
      Parameters:
      topP - Double property
      Returns:
      updated builder instance
      See Also:

    • clearLogRequests

      public BUILDER clearLogRequests()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • logRequests

      public BUILDER logRequests(boolean logRequests)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logRequests(java.lang.Boolean)
      Parameters:
      logRequests - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearReturnThinking

      public BUILDER clearReturnThinking()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • returnThinking

      public BUILDER returnThinking(boolean returnThinking)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.returnThinking(java.lang.Boolean)
      Parameters:
      returnThinking - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearModelName

      public BUILDER clearModelName()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • modelName

      public BUILDER modelName(String modelName)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.modelName(java.lang.String)
      Parameters:
      modelName - String property
      Returns:
      updated builder instance
      See Also:

    • clearBaseUrl

      public BUILDER clearBaseUrl()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • baseUrl

      public BUILDER baseUrl(String baseUrl)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.baseUrl(java.lang.String)
      Parameters:
      baseUrl - String property
      Returns:
      updated builder instance
      See Also:

    • stop

      public BUILDER stop(List<String> stop)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
      Parameters:
      stop - List property
      Returns:
      updated builder instance
      See Also:

    • addStop

      public BUILDER addStop(List<String> stop)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
      Parameters:
      stop - List property
      Returns:
      updated builder instance
      See Also:

    • addStop

      public BUILDER addStop(String stop)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
      Parameters:
      stop - List property
      Returns:
      updated builder instance
      See Also:

    • clearStrictTools

      public BUILDER clearStrictTools()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • strictTools

      public BUILDER strictTools(boolean strictTools)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictTools(java.lang.Boolean)
      Parameters:
      strictTools - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearServiceTier

      public BUILDER clearServiceTier()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • serviceTier

      public BUILDER serviceTier(String serviceTier)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.serviceTier(java.lang.String)
      Parameters:
      serviceTier - String property
      Returns:
      updated builder instance
      See Also:

    • clearProjectId

      public BUILDER clearProjectId()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • projectId

      public BUILDER projectId(String projectId)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.projectId(java.lang.String)
      Parameters:
      projectId - String property
      Returns:
      updated builder instance
      See Also:

    • clearUser

      public BUILDER clearUser()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • user

      public BUILDER user(String user)
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.user(java.lang.String)
      Parameters:
      user - String property
      Returns:
      updated builder instance
      See Also:

    • clearResponseFormat

      public BUILDER clearResponseFormat()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • responseFormat

      public BUILDER responseFormat(String responseFormat)
      Enable a "JSON mode" in the model configuration. This way, the LLM will be forced to respond with a valid JSON. For newer models that support Structured Outputs use supported-capabilities.
      Parameters:
      responseFormat - "json_object" to enable JSON mode on older models like gpt-3.5-turbo or gpt-4
      Returns:
      updated builder instance
      See Also:

    • enabled

      public boolean enabled()
      If set to false (default), OpenAiStreamingChatModel will not be available even if configured.
      Returns:
      the enabled

    • parallelToolCalls

      public Optional<Boolean> parallelToolCalls()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.parallelToolCalls(java.lang.Boolean)
      Returns:
      the parallel tool calls

    • metadata

      public Map<String,String> metadata()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.metadata(java.util.Map)
      Returns:
      the metadata

    • apiKey

      public Optional<String> apiKey()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.apiKey(java.lang.String)
      Returns:
      the api key

    • strictJsonSchema

      public Optional<Boolean> strictJsonSchema()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictJsonSchema(java.lang.Boolean)
      Returns:
      the strict json schema

    • seed

      public Optional<Integer> seed()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.seed(java.lang.Integer)
      Returns:
      the seed

    • logger

      public Optional<org.slf4j.Logger> logger()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logger(org.slf4j.Logger)
      Returns:
      the logger

    • defaultRequestParameters

      public Optional<dev.langchain4j.model.chat.request.ChatRequestParameters> defaultRequestParameters()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
      Returns:
      the default request parameters

    • timeout

      public Optional<Duration> timeout()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.timeout(java.time.Duration)
      Returns:
      the timeout

    • organizationId

      public Optional<String> organizationId()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.organizationId(java.lang.String)
      Returns:
      the organization id

    • presencePenalty

      public Optional<Double> presencePenalty()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.presencePenalty(java.lang.Double)
      Returns:
      the presence penalty

    • httpClientBuilder

      public Optional<dev.langchain4j.http.client.HttpClientBuilder> httpClientBuilder()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Returns:
      the http client builder

    • temperature

      public Optional<Double> temperature()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.temperature(java.lang.Double)
      Returns:
      the temperature

    • maxTokens

      public Optional<Integer> maxTokens()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxTokens(java.lang.Integer)
      Returns:
      the max tokens

    • logitBias

      public Map<String,Integer> logitBias()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logitBias(java.util.Map)
      Returns:
      the logit bias

    • frequencyPenalty

      public Optional<Double> frequencyPenalty()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.frequencyPenalty(java.lang.Double)
      Returns:
      the frequency penalty

    • customHeaders

      public Map<String,String> customHeaders()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.customHeaders(java.util.Map)
      Returns:
      the custom headers

    • maxCompletionTokens

      public Optional<Integer> maxCompletionTokens()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.maxCompletionTokens(java.lang.Integer)
      Returns:
      the max completion tokens

    • listeners

      public List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.listeners(java.util.List)
      Returns:
      the listeners

    • store

      public Optional<Boolean> store()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.store(java.lang.Boolean)
      Returns:
      the store

    • logResponses

      public Optional<Boolean> logResponses()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logResponses(java.lang.Boolean)
      Returns:
      the log responses

    • topP

      public Optional<Double> topP()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.topP(java.lang.Double)
      Returns:
      the top p

    • logRequests

      public Optional<Boolean> logRequests()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.logRequests(java.lang.Boolean)
      Returns:
      the log requests

    • returnThinking

      public Optional<Boolean> returnThinking()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.returnThinking(java.lang.Boolean)
      Returns:
      the return thinking

    • modelName

      public Optional<String> modelName()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.modelName(java.lang.String)
      Returns:
      the model name

    • baseUrl

      public Optional<String> baseUrl()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.baseUrl(java.lang.String)
      Returns:
      the base url

    • stop

      public List<String> stop()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.stop(java.util.List)
      Returns:
      the stop

    • strictTools

      public Optional<Boolean> strictTools()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.strictTools(java.lang.Boolean)
      Returns:
      the strict tools

    • serviceTier

      public Optional<String> serviceTier()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.serviceTier(java.lang.String)
      Returns:
      the service tier

    • projectId

      public Optional<String> projectId()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.projectId(java.lang.String)
      Returns:
      the project id

    • user

      public Optional<String> user()
      Generated from OpenAiStreamingChatModel.OpenAiStreamingChatModelBuilder.user(java.lang.String)
      Returns:
      the user

    • responseFormat

      public Optional<String> responseFormat()
      Enable a "JSON mode" in the model configuration. This way, the LLM will be forced to respond with a valid JSON. For newer models that support Structured Outputs use supported-capabilities.
      Returns:
      the response format

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.