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

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

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

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

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

    • clearTopK

      public BUILDER clearTopK()
      Clear existing value of this property.
      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:

    • clearIsRawPrompting

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

    • isRawPrompting

      public BUILDER isRawPrompting(boolean isRawPrompting)
      Generated from BaseCohereChatModel.Builder.isRawPrompting(java.lang.Boolean)
      Parameters:
      isRawPrompting - Boolean property
      Returns:
      updated builder instance
      See Also:

    • listenersDiscoverServices

      public BUILDER listenersDiscoverServices(boolean discoverServices)
      Generated from BaseChatModel.Builder.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 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 - List 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 BaseChatModel.Builder.seed(java.lang.Integer)
      Parameters:
      seed - Integer property
      Returns:
      updated builder instance
      See Also:

    • documents

      public BUILDER documents(List<?> documents)
      Generated from BaseCohereChatModel.Builder.documents(java.util.List)
      Parameters:
      documents - List property
      Returns:
      updated builder instance
      See Also:

    • addDocuments

      public BUILDER addDocuments(List<?> documents)
      Generated from BaseCohereChatModel.Builder.documents(java.util.List)
      Parameters:
      documents - List property
      Returns:
      updated builder instance
      See Also:

    • addDocument

      public BUILDER addDocument(Object document)
      Generated from BaseCohereChatModel.Builder.documents(java.util.List)
      Parameters:
      document - List 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 BaseChatModel.Builder.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 BaseChatModel.Builder.defaultRequestParameters(dev.langchain4j.model.chat.request.ChatRequestParameters)
      Parameters:
      consumer - ChatRequestParameters 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 BaseChatModel.Builder.topP(java.lang.Double)
      Parameters:
      topP - Double property
      Returns:
      updated builder instance
      See Also:

    • clearCitationQuality

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

    • citationQuality

      public BUILDER citationQuality(com.oracle.bmc.generativeaiinference.model.CohereChatRequest.CitationQuality citationQuality)
      Generated from BaseCohereChatModel.Builder.citationQuality(com.oracle.bmc.generativeaiinference.model.CohereChatRequest.CitationQuality)
      Parameters:
      citationQuality - CitationQuality property
      Returns:
      updated builder instance
      See Also:

    • clearPreambleOverride

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

    • preambleOverride

      public BUILDER preambleOverride(String preambleOverride)
      Generated from BaseCohereChatModel.Builder.preambleOverride(java.lang.String)
      Parameters:
      preambleOverride - String property
      Returns:
      updated builder instance
      See Also:

    • clearMaxInputTokens

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

    • maxInputTokens

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

    • clearServingType

      public BUILDER clearServingType()
      Clear existing value of this property.
      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:

    • clearPromptTruncation

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

    • promptTruncation

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

    • clearIsSearchQueriesOnly

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

    • isSearchQueriesOnly

      public BUILDER isSearchQueriesOnly(boolean isSearchQueriesOnly)
      Generated from BaseCohereChatModel.Builder.isSearchQueriesOnly(java.lang.Boolean)
      Parameters:
      isSearchQueriesOnly - Boolean property
      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 BaseChatModel.Builder.frequencyPenalty(java.lang.Double)
      Parameters:
      frequencyPenalty - Double property
      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 this property.
      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 this property.
      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:

    • enabled

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

    • topK

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

    • isRawPrompting

      public Optional<Boolean> isRawPrompting()
      Generated from BaseCohereChatModel.Builder.isRawPrompting(java.lang.Boolean)
      Returns:
      the is raw prompting

    • listeners

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

    • seed

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

    • documents

      public List<Object> documents()
      Generated from BaseCohereChatModel.Builder.documents(java.util.List)
      Returns:
      the documents

    • defaultRequestParameters

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

    • topP

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

    • citationQuality

      public Optional<com.oracle.bmc.generativeaiinference.model.CohereChatRequest.CitationQuality> citationQuality()
      Generated from BaseCohereChatModel.Builder.citationQuality(com.oracle.bmc.generativeaiinference.model.CohereChatRequest.CitationQuality)
      Returns:
      the citation quality

    • preambleOverride

      public Optional<String> preambleOverride()
      Generated from BaseCohereChatModel.Builder.preambleOverride(java.lang.String)
      Returns:
      the preamble override

    • maxInputTokens

      public Optional<Integer> maxInputTokens()
      Generated from BaseCohereChatModel.Builder.maxInputTokens(java.lang.Integer)
      Returns:
      the max input tokens

    • presencePenalty

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

    • stop

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

    • servingType

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

    • promptTruncation

      public Optional<com.oracle.bmc.generativeaiinference.model.CohereChatRequest.PromptTruncation> promptTruncation()
      Generated from BaseCohereChatModel.Builder.promptTruncation(com.oracle.bmc.generativeaiinference.model.CohereChatRequest.PromptTruncation)
      Returns:
      the prompt truncation

    • maxTokens

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

    • temperature

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

    • isSearchQueriesOnly

      public Optional<Boolean> isSearchQueriesOnly()
      Generated from BaseCohereChatModel.Builder.isSearchQueriesOnly(java.lang.Boolean)
      Returns:
      the is search queries only

    • frequencyPenalty

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

    • modelName

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

    • compartmentId

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

    • region

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

    • authProvider

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

    • genAiClient

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

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