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

Interface OpenAiImageModelConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
OpenAiImageModelConfig.BuilderBase.OpenAiImageModelConfigImpl
public interface OpenAiImageModelConfig extends Prototype.Api
Interface generated from definition. Please add javadoc to the definition interface.
See Also:

  • Field Details

  • Method Details

    • builder

      static OpenAiImageModelConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static OpenAiImageModelConfig.Builder builder(OpenAiImageModelConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static OpenAiImageModelConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      @Deprecated static OpenAiImageModelConfig create(Config config)
      Deprecated.
      use create(io.helidon.config.Config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static OpenAiImageModelConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • enabled

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

    • apiKey

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

    • logger

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

    • logResponses

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

    • logRequests

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

    • timeout

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

    • quality

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

    • organizationId

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

    • modelName

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

    • baseUrl

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

    • maxRetries

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

    • size

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

    • httpClientBuilder

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

    • style

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

    • projectId

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

    • user

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

    • customHeaders

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

    • responseFormat

      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

    • configuredBuilder

      default dev.langchain4j.model.openai.OpenAiImageModel.OpenAiImageModelBuilder configuredBuilder()
      Skipped:
      • modelName - property already exist -> dev.langchain4j.model.openai.OpenAiImageModel.OpenAiImageModelBuilder modelName(java.lang.String)
      • build - doesn't have exactly one parameter

      Overridden:

      • OpenAiLc4jProvider.responseFormat()
      • OpenAiLc4jProvider.responseFormat()
      Returns:
      Actual Lc4j model builder configured with this blueprint.