Package io.quarkiverse.langchain4j.azure.openai.runtime.config

Interface ImageModelConfig

public interface ImageModelConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    deploymentName()
    This property will override the quarkus.langchain4j.azure-openai.deployment-name specifically for image models if it is set.
    Optional<String>
    domainName()
    This property will override the quarkus.langchain4j.azure-openai.domain-name specifically for image models if it is set.
    Optional<String>
    endpoint()
    This property will override the quarkus.langchain4j.azure-openai.endpoint specifically for image models if it is set.
    Optional<Boolean>
    logRequests()
    Whether image model requests should be logged
    Optional<Boolean>
    logResponses()
    Whether image model responses should be logged
    String
    modelName()
    Model name to use
    int
    number()
    The number of images to generate.
    Optional<Boolean>
    persist()
    Configure whether the generated images will be saved to disk.
    Optional<Path>
    persistDirectory()
    The path where the generated images will be persisted to disk.
    String
    quality()
    The quality of the image that will be generated.
    Optional<String>
    resourceName()
    This property will override the quarkus.langchain4j.azure-openai.resource-name specifically for image models if it is set.
    String
    responseFormat()
    The format in which the generated images are returned.
    String
    size()
    The size of the generated images.
    String
    style()
    The style of the generated images.
    Optional<String>
    user()
    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

  • Method Details

    • resourceName

      Optional<String> resourceName()
      This property will override the quarkus.langchain4j.azure-openai.resource-name specifically for image models if it is set.

    • domainName

      Optional<String> domainName()
      This property will override the quarkus.langchain4j.azure-openai.domain-name specifically for image models if it is set.

    • deploymentName

      Optional<String> deploymentName()
      This property will override the quarkus.langchain4j.azure-openai.deployment-name specifically for image models if it is set.

    • endpoint

      Optional<String> endpoint()
      This property will override the quarkus.langchain4j.azure-openai.endpoint specifically for image models if it is set.

    • modelName

      @WithDefault("dall-e-3") String modelName()
      Model name to use

    • persist

      @ConfigDocDefault("false") Optional<Boolean> persist()
      Configure whether the generated images will be saved to disk. By default, persisting is disabled, but it is implicitly enabled when quarkus.langchain4j.openai.image-mode.directory is set and this property is not to false

    • persistDirectory

      @ConfigDocDefault("${java.io.tmpdir}/dall-e-images") Optional<Path> persistDirectory()
      The path where the generated images will be persisted to disk. This only applies of quarkus.langchain4j.openai.image-mode.persist is not set to false.

    • responseFormat

      @WithDefault("url") String responseFormat()
      The format in which the generated images are returned.

      Must be one of url or b64_json

    • size

      @WithDefault("1024x1024") String size()
      The size of the generated images.

      Must be one of 1024x1024, 1792x1024, or 1024x1792 when the model is dall-e-3.

      Must be one of 256x256, 512x512, or 1024x1024 when the model is dall-e-2.

    • quality

      @WithDefault("standard") String quality()
      The quality of the image that will be generated.

      hd creates images with finer details and greater consistency across the image.

      This param is only supported for when the model is dall-e-3.

    • number

      @WithDefault("1") int number()
      The number of images to generate.

      Must be between 1 and 10.

      When the model is dall-e-3, only n=1 is supported.

    • style

      @WithDefault("vivid") String style()
      The style of the generated images.

      Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

      This param is only supported for when the model is dall-e-3.

    • user

      Optional<String> user()
      A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

    • logRequests

      @ConfigDocDefault("false") Optional<Boolean> logRequests()
      Whether image model requests should be logged

    • logResponses

      @ConfigDocDefault("false") Optional<Boolean> logResponses()
      Whether image model responses should be logged