Package dev.langchain4j.model.azure

Class AzureOpenAiImageModel

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiImageModel

All Implemented Interfaces:

ImageModel

public class AzureOpenAiImageModel
extends Object
implements ImageModel

Represents an OpenAI image model, hosted on Azure, such as dall-e-3.

You can find a tutorial on using Azure OpenAI to generate images at: https://learn.microsoft.com/en-us/azure/ai-services/openai/dall-e-quickstart?pivots=programming-language-java

Mandatory parameters for initialization are: endpoint and apikey (or an alternate authentication method, see below for more information). Optionally you can set serviceVersion (if not, the latest version is used) and deploymentName (if not, a default name is used). You can also provide your own OpenAIClient instance, if you need more flexibility.

There are 3 authentication methods:

1. Azure OpenAI API Key Authentication: this is the most common method, using an Azure OpenAI API key. You need to provide the OpenAI API Key as a parameter, using the apiKey() method in the Builder, or the apiKey parameter in the constructor: For example, you would use `builder.apiKey("{key}")`.

2. non-Azure OpenAI API Key Authentication: this method allows to use the OpenAI service, instead of Azure OpenAI. You can use the nonAzureApiKey() method in the Builder, which will also automatically set the endpoint to "https://api.openai.com/v1". For example, you would use `builder.nonAzureApiKey("{key}")`. The constructor requires a KeyCredential instance, which can be created using `new AzureKeyCredential("{key}")`, and doesn't set up the endpoint.

3. Azure OpenAI client with Microsoft Entra ID (formerly Azure Active Directory) credentials. - This requires to add the `com.azure:azure-identity` dependency to your project, which is an optional dependency to this library. - You need to provide a TokenCredential instance, using the tokenCredential() method in the Builder, or the tokenCredential parameter in the constructor. As an example, DefaultAzureCredential can be used to authenticate the client: Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET. Then, provide the DefaultAzureCredential instance to the builder: `builder.tokenCredential(new DefaultAzureCredentialBuilder().build())`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureOpenAiImageModel.Builder

Constructor Summary

Constructors

Constructor	Description
AzureOpenAiImageModel(com.azure.ai.openai.OpenAIClient client, String deploymentName, String quality, String size, String user, String style, String responseFormat)
AzureOpenAiImageModel(String endpoint, String serviceVersion, com.azure.core.credential.KeyCredential keyCredential, com.azure.core.http.HttpClientProvider httpClientProvider, String deploymentName, String quality, String size, String user, String style, String responseFormat, Duration timeout, Integer maxRetries, com.azure.core.http.ProxyOptions proxyOptions, boolean logRequestsAndResponses, String userAgentSuffix, Map<String,String> customHeaders)
AzureOpenAiImageModel(String endpoint, String serviceVersion, com.azure.core.credential.TokenCredential tokenCredential, com.azure.core.http.HttpClientProvider httpClientProvider, String deploymentName, String quality, String size, String user, String style, String responseFormat, Duration timeout, Integer maxRetries, com.azure.core.http.ProxyOptions proxyOptions, boolean logRequestsAndResponses, String userAgentSuffix, Map<String,String> customHeaders)
AzureOpenAiImageModel(String endpoint, String serviceVersion, String apiKey, com.azure.core.http.HttpClientProvider httpClientProvider, String deploymentName, String quality, String size, String user, String style, String responseFormat, Duration timeout, Integer maxRetries, com.azure.core.http.ProxyOptions proxyOptions, boolean logRequestsAndResponses, String userAgentSuffix, Map<String,String> customHeaders)

Method Summary

Modifier and Type	Method	Description
static AzureOpenAiImageModel.Builder	builder()
Response<Image>	generate(String prompt)	Given a prompt, generate an image.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.model.image.ImageModel

edit, edit, generate

Constructor Details

AzureOpenAiImageModel

public AzureOpenAiImageModel(com.azure.ai.openai.OpenAIClient client,
 String deploymentName,
 String quality,
 String size,
 String user,
 String style,
 String responseFormat)

AzureOpenAiImageModel

public AzureOpenAiImageModel(String endpoint,
 String serviceVersion,
 String apiKey,
 com.azure.core.http.HttpClientProvider httpClientProvider,
 String deploymentName,
 String quality,
 String size,
 String user,
 String style,
 String responseFormat,
 Duration timeout,
 Integer maxRetries,
 com.azure.core.http.ProxyOptions proxyOptions,
 boolean logRequestsAndResponses,
 String userAgentSuffix,
 Map<String,String> customHeaders)

AzureOpenAiImageModel

public AzureOpenAiImageModel(String endpoint,
 String serviceVersion,
 com.azure.core.credential.KeyCredential keyCredential,
 com.azure.core.http.HttpClientProvider httpClientProvider,
 String deploymentName,
 String quality,
 String size,
 String user,
 String style,
 String responseFormat,
 Duration timeout,
 Integer maxRetries,
 com.azure.core.http.ProxyOptions proxyOptions,
 boolean logRequestsAndResponses,
 String userAgentSuffix,
 Map<String,String> customHeaders)

AzureOpenAiImageModel

public AzureOpenAiImageModel(String endpoint,
 String serviceVersion,
 com.azure.core.credential.TokenCredential tokenCredential,
 com.azure.core.http.HttpClientProvider httpClientProvider,
 String deploymentName,
 String quality,
 String size,
 String user,
 String style,
 String responseFormat,
 Duration timeout,
 Integer maxRetries,
 com.azure.core.http.ProxyOptions proxyOptions,
 boolean logRequestsAndResponses,
 String userAgentSuffix,
 Map<String,String> customHeaders)

Method Details

generate

public Response<Image> generate(String prompt)

Description copied from interface: ImageModel

Given a prompt, generate an image.

Specified by:

generate in interface ImageModel

Parameters:

prompt - The prompt to generate an image from.

Returns:

The generated image Response.

builder

public static AzureOpenAiImageModel.Builder builder()