Module io.helidon.integrations.langchain4j.providers.oraclegenai
Package io.helidon.integrations.langchain4j.providers.oci.genai

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

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

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OciGenAiStreamingChatModelConfig 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(OciGenAiStreamingChatModelConfig.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 OciGenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OciGenAiStreamingChatModelConfig>
      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 OciGenAiStreamingChatModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OciGenAiStreamingChatModelConfig>
      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, OciGenAiStreamingChatModel will not be available even if configured.
      Parameters:
      enabled - whether OciGenAiStreamingChatModel is enabled, defaults to true
      Returns:
      updated builder instance
      See Also:

    • clearTopK

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

    • topK

      public BUILDER topK(int topK)
      Generated from BaseChatModel.Builder.topK(java.lang.Integer)
      Parameters:
      topK - 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 BaseChatModel.Builder.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 BaseChatModel.Builder.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 BaseChatModel.Builder.listeners(java.util.List)
      Parameters:
      listener - add single List 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 BaseChatModel.Builder.seed(java.lang.Integer)
      Parameters:
      seed - Integer property
      Returns:
      updated builder instance
      See Also:

    • clearLogProbs

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

    • logProbs

      public BUILDER logProbs(int logProbs)
      Generated from BaseGenericChatModel.Builder.logProbs(java.lang.Integer)
      Parameters:
      logProbs - Integer 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 BaseChatModel.Builder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
      Parameters:
      defaultRequestParameters - ChatRequestParameters property
      Returns:
      updated builder instance
      See Also:

    • clearNumGenerations

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

    • numGenerations

      public BUILDER numGenerations(int numGenerations)
      Generated from BaseGenericChatModel.Builder.numGenerations(java.lang.Integer)
      Parameters:
      numGenerations - Integer 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 BaseChatModel.Builder.topP(java.lang.Double)
      Parameters:
      topP - Double 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 BaseChatModel.Builder.presencePenalty(java.lang.Double)
      Parameters:
      presencePenalty - Double 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 BaseChatModel.Builder.stop(java.util.List)
      Parameters:
      stop - List property
      Returns:
      updated builder instance
      See Also:

    • addStop

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

    • addStop

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

    • clearServingType

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

    • servingType

      public BUILDER servingType(com.oracle.bmc.generativeaiinference.model.ServingMode.ServingType servingType)
      Generated from BaseChatModel.Builder.servingType(com.oracle.bmc.generativeaiinference.model.ServingMode.ServingType)
      Parameters:
      servingType - ServingType 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 BaseChatModel.Builder.maxTokens(java.lang.Integer)
      Parameters:
      maxTokens - Integer 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 BaseChatModel.Builder.temperature(java.lang.Double)
      Parameters:
      temperature - Double property
      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 BaseChatModel.Builder.frequencyPenalty(java.lang.Double)
      Parameters:
      frequencyPenalty - Double property
      Returns:
      updated builder instance
      See Also:

    • clearExecutorService

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

    • executorService

      public BUILDER executorService(ExecutorService executorService)
      Custom executor for asynchronous request startup and stream processing. A directly supplied or registry-provided executor is borrowed and remains the responsibility of its owner; the model does not shut it down.
      Parameters:
      executorService - the executor service
      Returns:
      updated builder instance
      See Also:

    • clearGenAiAsyncClient

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

    • genAiAsyncClient

      public BUILDER genAiAsyncClient(com.oracle.bmc.generativeaiinference.GenerativeAiInferenceAsyncClient genAiAsyncClient)
      Custom asynchronous OCI GenAI client. A directly supplied or registry-provided client is borrowed and is not closed by the generated factory.
      Parameters:
      genAiAsyncClient - the asynchronous OCI GenAI client
      Returns:
      updated builder instance
      See Also:

    • modelName

      public BUILDER modelName(String modelName)
      OCI LLM Model name or OCID.
      Parameters:
      modelName - Model name or OCID
      Returns:
      updated builder instance
      See Also:

    • compartmentId

      public BUILDER compartmentId(String compartmentId)
      OCI Compartment OCID.
      Parameters:
      compartmentId - Compartment OCID
      Returns:
      updated builder instance
      See Also:

    • region

      public BUILDER region(com.oracle.bmc.Region region)
      Region is by default set to the current OCI region detected by OCI SDK.
      Parameters:
      region - OCI Region to connect to
      Returns:
      updated builder instance
      See Also:

    • clearAuthProvider

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

    • authProvider

      public BUILDER authProvider(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authProvider)
      Authentication provider is by default used from default Service bean found in Service Registry.
      Parameters:
      authProvider - OCI authentication details provider
      Returns:
      updated builder instance
      See Also:

    • clearGenAiClient

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

    • genAiClient

      public BUILDER genAiClient(com.oracle.bmc.generativeaiinference.GenerativeAiInferenceClient genAiClient)
      Custom http client builder.
      Parameters:
      genAiClient - the http client builder
      Returns:
      updated builder instance
      See Also:

    • logitBias

      public BUILDER logitBias(Map<String,Integer> logitBias)
      Modifies the likelihood of specified tokens that appear in the completion.

      Example: '{"6395": 2, "8134": 1, "21943": 0.5, "5923": -100}' This method replaces all values with the new ones.

      Parameters:
      logitBias - a map
      Returns:
      updated builder instance
      See Also:

    • addLogitBias

      public BUILDER addLogitBias(Map<String,Integer> logitBias)
      Modifies the likelihood of specified tokens that appear in the completion.

      Example: '{"6395": 2, "8134": 1, "21943": 0.5, "5923": -100}' This method keeps existing values, then puts all new values into the map.

      Parameters:
      logitBias - a map
      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:

    • 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:

    • executorServiceDiscoverServices

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

    • genAiAsyncClientDiscoverServices

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

    • regionDiscoverServices

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

    • authProviderDiscoverServices

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

    • genAiClientDiscoverServices

      public BUILDER genAiClientDiscoverServices(boolean genAiClientDiscoverServices)
      Service discovery flag for genAiClient(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
      Parameters:
      genAiClientDiscoverServices - 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, OciGenAiStreamingChatModel will not be available even if configured.
      Returns:
      whether OciGenAiStreamingChatModel is enabled, defaults to true

    • topK

      public Optional<Integer> topK()
      Generated from BaseChatModel.Builder.topK(java.lang.Integer)
      Returns:
      Integer property

    • listeners

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

    • seed

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

    • logProbs

      public Optional<Integer> logProbs()
      Generated from BaseGenericChatModel.Builder.logProbs(java.lang.Integer)
      Returns:
      Integer property

    • defaultRequestParameters

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

    • numGenerations

      public Optional<Integer> numGenerations()
      Generated from BaseGenericChatModel.Builder.numGenerations(java.lang.Integer)
      Returns:
      Integer property

    • topP

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

    • presencePenalty

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

    • stop

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

    • servingType

      public Optional<com.oracle.bmc.generativeaiinference.model.ServingMode.ServingType> servingType()
      Generated from BaseChatModel.Builder.servingType(com.oracle.bmc.generativeaiinference.model.ServingMode.ServingType)
      Returns:
      ServingType property

    • maxTokens

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

    • temperature

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

    • frequencyPenalty

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

    • executorService

      public Optional<ExecutorService> executorService()
      Custom executor for asynchronous request startup and stream processing. A directly supplied or registry-provided executor is borrowed and remains the responsibility of its owner; the model does not shut it down.
      Returns:
      the executor service

    • genAiAsyncClient

      public Optional<com.oracle.bmc.generativeaiinference.GenerativeAiInferenceAsyncClient> genAiAsyncClient()
      Custom asynchronous OCI GenAI client. A directly supplied or registry-provided client is borrowed and is not closed by the generated factory.
      Returns:
      the asynchronous OCI GenAI client

    • modelName

      public Optional<String> modelName()
      OCI LLM Model name or OCID.
      Returns:
      Model name or OCID

    • compartmentId

      public Optional<String> compartmentId()
      OCI Compartment OCID.
      Returns:
      Compartment OCID

    • region

      public Optional<com.oracle.bmc.Region> region()
      Region is by default set to the current OCI region detected by OCI SDK.
      Returns:
      OCI Region to connect to

    • authProvider

      public Optional<com.oracle.bmc.auth.BasicAuthenticationDetailsProvider> authProvider()
      Authentication provider is by default used from default Service bean found in Service Registry.
      Returns:
      OCI authentication details provider

    • genAiClient

      public Optional<com.oracle.bmc.generativeaiinference.GenerativeAiInferenceClient> genAiClient()
      Custom http client builder.
      Returns:
      the http client builder

    • logitBias

      public Map<String,Integer> logitBias()
      Modifies the likelihood of specified tokens that appear in the completion.

      Example: '{"6395": 2, "8134": 1, "21943": 0.5, "5923": -100}'

      Returns:
      a map

    • 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

    • 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

    • executorServiceDiscoverServices

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

    • genAiAsyncClientDiscoverServices

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

    • regionDiscoverServices

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

    • authProviderDiscoverServices

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

    • genAiClientDiscoverServices

      public boolean genAiClientDiscoverServices()
      Service discovery flag for genAiClient(). 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