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

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

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

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OllamaEmbeddingModelConfig 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(OllamaEmbeddingModelConfig.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 OllamaEmbeddingModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OllamaEmbeddingModelConfig>
      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 OllamaEmbeddingModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OllamaEmbeddingModelConfig>
      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, OllamaEmbeddingModel will not be available even if configured.
      Parameters:
      enabled - whether OllamaEmbeddingModel is enabled, defaults to true
      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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.modelName(java.lang.String)
      Parameters:
      modelName - String 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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.maxRetries(java.lang.Integer)
      Parameters:
      maxRetries - Integer 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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Parameters:
      httpClientBuilder - HttpClientBuilder 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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.logResponses(java.lang.Boolean)
      Parameters:
      logResponses - Boolean 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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.logRequests(java.lang.Boolean)
      Parameters:
      logRequests - Boolean 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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.timeout(java.time.Duration)
      Parameters:
      timeout - Duration property
      Returns:
      updated builder instance
      See Also:

    • customHeaders

      public BUILDER customHeaders(Map<String,String> customHeaders)
      Generated from OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.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 OllamaEmbeddingModel.OllamaEmbeddingModelBuilder.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:

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

    • 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, OllamaEmbeddingModel will not be available even if configured.
      Returns:
      whether OllamaEmbeddingModel is enabled, defaults to true

    • modelName

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

    • baseUrl

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

    • maxRetries

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

    • httpClientBuilder

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

    • logResponses

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

    • logRequests

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

    • timeout

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

    • customHeaders

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

    • 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

    • 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