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

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

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

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(OpenAiImageModelConfig 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(OpenAiImageModelConfig.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 OpenAiImageModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiImageModelConfig>
      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 OpenAiImageModelConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends OpenAiImageModelConfig>
      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, OpenAiImageModel will not be available even if configured.
      Parameters:
      enabled - whether OpenAiImageModel is enabled, defaults to true
      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 OpenAiImageModel.OpenAiImageModelBuilder.apiKey(java.lang.String)
      Parameters:
      apiKey - String 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 OpenAiImageModel.OpenAiImageModelBuilder.logger(org.slf4j.Logger)
      Parameters:
      logger - Logger 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 OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.timeout(java.time.Duration)
      Parameters:
      timeout - Duration property
      Returns:
      updated builder instance
      See Also:

    • customQueryParams

      public BUILDER customQueryParams(Map<String,String> customQueryParams)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.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:

    • clearQuality

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

    • quality

      public BUILDER quality(String quality)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.quality(java.lang.String)
      Parameters:
      quality - String property
      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 OpenAiImageModel.OpenAiImageModelBuilder.organizationId(java.lang.String)
      Parameters:
      organizationId - String 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 OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.maxRetries(java.lang.Integer)
      Parameters:
      maxRetries - Integer property
      Returns:
      updated builder instance
      See Also:

    • clearSize

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

    • size

      public BUILDER size(String size)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.size(java.lang.String)
      Parameters:
      size - String 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 OpenAiImageModel.OpenAiImageModelBuilder.httpClientBuilder(dev.langchain4j.http.client.HttpClientBuilder)
      Parameters:
      httpClientBuilder - HttpClientBuilder property
      Returns:
      updated builder instance
      See Also:

    • clearStyle

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

    • style

      public BUILDER style(String style)
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.style(java.lang.String)
      Parameters:
      style - String property
      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 OpenAiImageModel.OpenAiImageModelBuilder.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 OpenAiImageModel.OpenAiImageModelBuilder.user(java.lang.String)
      Parameters:
      user - String property
      Returns:
      updated builder instance
      See Also:

    • customHeaders

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

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

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

    • apiKey

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

    • logger

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

    • logResponses

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

    • logRequests

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

    • timeout

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

    • customQueryParams

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

    • quality

      public Optional<String> quality()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.quality(java.lang.String)
      Returns:
      String property

    • organizationId

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

    • modelName

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

    • baseUrl

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

    • maxRetries

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

    • size

      public Optional<String> size()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.size(java.lang.String)
      Returns:
      String property

    • httpClientBuilder

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

    • style

      public Optional<String> style()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.style(java.lang.String)
      Returns:
      String property

    • projectId

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

    • user

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

    • customHeaders

      public Map<String,String> customHeaders()
      Generated from OpenAiImageModel.OpenAiImageModelBuilder.customHeaders(java.util.Map)
      Returns:
      Map 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

    • 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