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

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

java.lang.Object
io.helidon.integrations.langchain4j.providers.openai.OpenAiChatModelConfig.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:
OpenAiChatModelConfig.Builder
Enclosing interface:
OpenAiChatModelConfig
public abstract static class OpenAiChatModelConfig.BuilderBase<BUILDER extends OpenAiChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiChatModelConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for OpenAiChatModelConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenAiChatModelConfig 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(OpenAiChatModelConfig.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 OpenAiChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiChatModelConfig>
      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 OpenAiChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiChatModelConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • enabled

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

    • clearParallelToolCalls

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

    • parallelToolCalls

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

    • metadata

      public BUILDER metadata(Map<String,String> metadata)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 apiKey.
      Returns:
      updated builder instance
      See Also:

    • apiKey

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

    • clearStrictJsonSchema

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

    • strictJsonSchema

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

    • clearSeed

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

    • seed

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

    • clearLogger

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

    • logger

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

    • clearDefaultRequestParameters

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

    • defaultRequestParameters

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

    • clearReasoningEffort

      public BUILDER clearReasoningEffort()
      Clear existing value of reasoningEffort.
      Returns:
      updated builder instance
      See Also:

    • reasoningEffort

      public BUILDER reasoningEffort(String reasoningEffort)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.reasoningEffort(java.lang.String)
      Parameters:
      reasoningEffort - String property
      Returns:
      updated builder instance
      See Also:

    • clearTimeout

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

    • timeout

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

    • customQueryParams

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

    • addCustomQueryParams

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

    • putCustomQueryParam

      public BUILDER putCustomQueryParam(String key, String customQueryParam)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.customQueryParams(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
      customQueryParam - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearOrganizationId

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

    • organizationId

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

    • clearPresencePenalty

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

    • presencePenalty

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

    • clearHttpClientBuilder

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

    • httpClientBuilder

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

    • clearTemperature

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

    • temperature

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

    • clearMaxTokens

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

    • maxTokens

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

    • logitBias

      public BUILDER logitBias(Map<String,Integer> logitBias)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 frequencyPenalty.
      Returns:
      updated builder instance
      See Also:

    • frequencyPenalty

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

    • customHeaders

      public BUILDER customHeaders(Map<String,String> customHeaders)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 maxCompletionTokens.
      Returns:
      updated builder instance
      See Also:

    • maxCompletionTokens

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

    • clearListeners

      public BUILDER clearListeners()
      Clear all listeners.
      Returns:
      updated builder instance
      See Also:

    • listeners

      public BUILDER listeners(List<? extends dev.langchain4j.model.chat.listener.ChatModelListener> listeners)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.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 OpenAiChatModel.OpenAiChatModelBuilder.listeners(java.util.List)
      Parameters:
      listener - add single List property
      Returns:
      updated builder instance
      See Also:

    • clearSupportedCapabilities

      public BUILDER clearSupportedCapabilities()
      Clear all supportedCapabilities.
      Returns:
      updated builder instance
      See Also:

    • supportedCapabilities

      public BUILDER supportedCapabilities(Set<? extends dev.langchain4j.model.chat.Capability> supportedCapabilities)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.supportedCapabilities(java.util.Set)
      Parameters:
      supportedCapabilities - Set property
      Returns:
      updated builder instance
      See Also:

    • addSupportedCapabilities

      public BUILDER addSupportedCapabilities(Set<? extends dev.langchain4j.model.chat.Capability> supportedCapabilities)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.supportedCapabilities(java.util.Set)
      Parameters:
      supportedCapabilities - Set property
      Returns:
      updated builder instance
      See Also:

    • addSupportedCapabilitie

      public BUILDER addSupportedCapabilitie(dev.langchain4j.model.chat.Capability supportedCapabilitie)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.supportedCapabilities(java.util.Set)
      Parameters:
      supportedCapabilitie - add single Set property
      Returns:
      updated builder instance
      See Also:

    • clearStore

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

    • store

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

    • clearLogResponses

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

    • logResponses

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

    • clearTopP

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

    • topP

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

    • clearLogRequests

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

    • logRequests

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

    • clearReturnThinking

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

    • returnThinking

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

    • clearModelName

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

    • modelName

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

    • clearSendThinking

      public BUILDER clearSendThinking()
      Clear existing value of sendThinking.
      Returns:
      updated builder instance
      See Also:

    • sendThinking

      public BUILDER sendThinking(boolean sendThinking)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.sendThinking(java.lang.Boolean)
      Parameters:
      sendThinking - Boolean property
      Returns:
      updated builder instance
      See Also:

    • clearBaseUrl

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

    • baseUrl

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

    • clearMaxRetries

      public BUILDER clearMaxRetries()
      Clear existing value of maxRetries.
      Returns:
      updated builder instance
      See Also:

    • maxRetries

      public BUILDER maxRetries(int maxRetries)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxRetries(java.lang.Integer)
      Parameters:
      maxRetries - Integer property
      Returns:
      updated builder instance
      See Also:

    • clearStop

      public BUILDER clearStop()
      Clear all stop.
      Returns:
      updated builder instance
      See Also:

    • stop

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

    • addStop

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

    • addStop

      public BUILDER addStop(String stop)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.stop(java.util.List)
      Parameters:
      stop - add single List property
      Returns:
      updated builder instance
      See Also:

    • clearStrictTools

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

    • strictTools

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

    • clearServiceTier

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

    • serviceTier

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

    • customParameters

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

    • addCustomParameters

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

    • putCustomParameter

      public BUILDER putCustomParameter(String key, Object customParameter)
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.customParameters(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
      customParameter - new value for the key
      Returns:
      updated builder instance
      See Also:

    • clearProjectId

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

    • projectId

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

    • clearUser

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

    • user

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

    • clearResponseFormat

      public BUILDER clearResponseFormat()
      Clear existing value of responseFormat.
      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:

    • defaultRequestParametersDiscoverServices

      public BUILDER defaultRequestParametersDiscoverServices(boolean defaultRequestParametersDiscoverServices)
      Service discovery flag for defaultRequestParameters(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      defaultRequestParametersDiscoverServices - whether to enable automatic service discovery
      Returns:
      updated builder instance
      See Also:

    • httpClientBuilderDiscoverServices

      public BUILDER httpClientBuilderDiscoverServices(boolean httpClientBuilderDiscoverServices)
      Service discovery flag for httpClientBuilder(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      httpClientBuilderDiscoverServices - whether to enable automatic service discovery
      Returns:
      updated builder instance
      See Also:

    • listenersDiscoverServices

      public BUILDER listenersDiscoverServices(boolean listenersDiscoverServices)
      Service discovery flag for listeners(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      listenersDiscoverServices - whether to enable automatic service discovery
      Returns:
      updated builder instance
      See Also:

    • serviceRegistry

      public BUILDER serviceRegistry(ServiceRegistry serviceRegistry)
      Service registry used to discover providers and services. Provide an explicit registry instance to use.

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

      Parameters:
      serviceRegistry - service registry to use
      Returns:
      updated builder instance
      See Also:

    • enabled

      public boolean enabled()
      If set to false, OpenAiChatModel will not be available even if configured.
      Returns:
      whether OpenAiChatModel is enabled, defaults to true

    • parallelToolCalls

      public Optional<Boolean> parallelToolCalls()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.parallelToolCalls(java.lang.Boolean)
      Returns:
      Boolean property

    • metadata

      public Map<String,String> metadata()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.metadata(java.util.Map)
      Returns:
      Map property

    • apiKey

      public Optional<String> apiKey()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.apiKey(java.lang.String)
      Returns:
      String property

    • strictJsonSchema

      public Optional<Boolean> strictJsonSchema()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.strictJsonSchema(java.lang.Boolean)
      Returns:
      Boolean property

    • seed

      public Optional<Integer> seed()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.seed(java.lang.Integer)
      Returns:
      Integer property

    • logger

      public Optional<org.slf4j.Logger> logger()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.logger(org.slf4j.Logger)
      Returns:
      Logger property

    • defaultRequestParameters

      public Optional<dev.langchain4j.model.chat.request.ChatRequestParameters> defaultRequestParameters()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
      Returns:
      ChatRequestParameters property

    • reasoningEffort

      public Optional<String> reasoningEffort()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.reasoningEffort(java.lang.String)
      Returns:
      String property

    • timeout

      public Optional<Duration> timeout()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.timeout(java.time.Duration)
      Returns:
      Duration property

    • customQueryParams

      public Map<String,String> customQueryParams()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.customQueryParams(java.util.Map)
      Returns:
      Map property

    • organizationId

      public Optional<String> organizationId()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.organizationId(java.lang.String)
      Returns:
      String property

    • presencePenalty

      public Optional<Double> presencePenalty()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.presencePenalty(java.lang.Double)
      Returns:
      Double property

    • httpClientBuilder

      public Optional<dev.langchain4j.http.client.HttpClientBuilder> httpClientBuilder()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Returns:
      HttpClientBuilder property

    • temperature

      public Optional<Double> temperature()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.temperature(java.lang.Double)
      Returns:
      Double property

    • maxTokens

      public Optional<Integer> maxTokens()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxTokens(java.lang.Integer)
      Returns:
      Integer property

    • logitBias

      public Map<String,Integer> logitBias()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.logitBias(java.util.Map)
      Returns:
      Map property

    • frequencyPenalty

      public Optional<Double> frequencyPenalty()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.frequencyPenalty(java.lang.Double)
      Returns:
      Double property

    • customHeaders

      public Map<String,String> customHeaders()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.customHeaders(java.util.Map)
      Returns:
      Map property

    • maxCompletionTokens

      public Optional<Integer> maxCompletionTokens()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxCompletionTokens(java.lang.Integer)
      Returns:
      Integer property

    • listeners

      public List<dev.langchain4j.model.chat.listener.ChatModelListener> listeners()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.listeners(java.util.List)
      Returns:
      List property

    • supportedCapabilities

      public Set<dev.langchain4j.model.chat.Capability> supportedCapabilities()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.supportedCapabilities(java.util.Set)
      Returns:
      Set property

    • store

      public Optional<Boolean> store()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.store(java.lang.Boolean)
      Returns:
      Boolean property

    • logResponses

      public Optional<Boolean> logResponses()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.logResponses(java.lang.Boolean)
      Returns:
      Boolean property

    • topP

      public Optional<Double> topP()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.topP(java.lang.Double)
      Returns:
      Double property

    • logRequests

      public Optional<Boolean> logRequests()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.logRequests(java.lang.Boolean)
      Returns:
      Boolean property

    • returnThinking

      public Optional<Boolean> returnThinking()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.returnThinking(java.lang.Boolean)
      Returns:
      Boolean property

    • modelName

      public Optional<String> modelName()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.modelName(java.lang.String)
      Returns:
      String property

    • sendThinking

      public Optional<Boolean> sendThinking()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.sendThinking(java.lang.Boolean)
      Returns:
      Boolean property

    • baseUrl

      public Optional<String> baseUrl()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.baseUrl(java.lang.String)
      Returns:
      String property

    • maxRetries

      public Optional<Integer> maxRetries()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.maxRetries(java.lang.Integer)
      Returns:
      Integer property

    • stop

      public List<String> stop()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.stop(java.util.List)
      Returns:
      List property

    • strictTools

      public Optional<Boolean> strictTools()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.strictTools(java.lang.Boolean)
      Returns:
      Boolean property

    • serviceTier

      public Optional<String> serviceTier()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.serviceTier(java.lang.String)
      Returns:
      String property

    • customParameters

      public Map<String,Object> customParameters()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.customParameters(java.util.Map)
      Returns:
      Map property

    • projectId

      public Optional<String> projectId()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.projectId(java.lang.String)
      Returns:
      String property

    • user

      public Optional<String> user()
      Generated from OpenAiChatModel.OpenAiChatModelBuilder.user(java.lang.String)
      Returns:
      String property

    • 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:
      "json_object" to enable JSON mode on older models like gpt-3.5-turbo or gpt-4

    • defaultRequestParametersDiscoverServices

      public boolean defaultRequestParametersDiscoverServices()
      Service discovery flag for defaultRequestParameters(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Returns:
      whether to enable automatic service discovery

    • httpClientBuilderDiscoverServices

      public boolean httpClientBuilderDiscoverServices()
      Service discovery flag for httpClientBuilder(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Returns:
      whether to enable automatic service discovery

    • listenersDiscoverServices

      public boolean listenersDiscoverServices()
      Service discovery flag for listeners(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Returns:
      whether to enable automatic service discovery

    • serviceRegistry

      public Optional<ServiceRegistry> serviceRegistry()
      Service registry used to discover providers and services. Provide an explicit registry instance to use.

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

      Returns:
      service registry to use

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.

    • config

      protected Optional<Config> config()
      Configuration used to configure this instance.
      Returns:
      config instance