Package dev.langchain4j.model.azure

Class AzureOpenAiChatModel.Builder

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiChatModel.Builder

Enclosing class:

AzureOpenAiChatModel

public static class AzureOpenAiChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureOpenAiChatModel.Builder	apiKey(String apiKey)	Sets the Azure OpenAI API key.
AzureOpenAiChatModel	build()
AzureOpenAiChatModel.Builder	customHeaders(Map<String,String> customHeaders)
AzureOpenAiChatModel.Builder	dataSources(List<com.azure.ai.openai.models.AzureChatExtensionConfiguration> dataSources)
AzureOpenAiChatModel.Builder	deploymentName(String deploymentName)	Sets the deployment name in Azure OpenAI.
AzureOpenAiChatModel.Builder	endpoint(String endpoint)	Sets the Azure OpenAI endpoint.
AzureOpenAiChatModel.Builder	enhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
AzureOpenAiChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
AzureOpenAiChatModel.Builder	listeners(List<ChatModelListener> listeners)
AzureOpenAiChatModel.Builder	logitBias(Map<String,Integer> logitBias)
AzureOpenAiChatModel.Builder	logRequestsAndResponses(Boolean logRequestsAndResponses)
AzureOpenAiChatModel.Builder	maxRetries(Integer maxRetries)
AzureOpenAiChatModel.Builder	maxTokens(Integer maxTokens)
AzureOpenAiChatModel.Builder	nonAzureApiKey(String nonAzureApiKey)	Used to authenticate with the OpenAI service, instead of Azure OpenAI.
AzureOpenAiChatModel.Builder	openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)	Sets the Azure OpenAI client.
AzureOpenAiChatModel.Builder	presencePenalty(Double presencePenalty)
AzureOpenAiChatModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
AzureOpenAiChatModel.Builder	responseFormat(com.azure.ai.openai.models.ChatCompletionsResponseFormat chatCompletionsResponseFormat)	Deprecated, for removal: This API element is subject to removal in a future version. For JSON output, you can replace `.responseFormat(new ChatCompletionsJsonResponseFormat())` with a `JsonSchema` in the `ResponseFormat`.
AzureOpenAiChatModel.Builder	responseFormat(ResponseFormat responseFormat)
AzureOpenAiChatModel.Builder	seed(Long seed)
AzureOpenAiChatModel.Builder	serviceVersion(String serviceVersion)	Sets the Azure OpenAI API service version.
AzureOpenAiChatModel.Builder	stop(List<String> stop)
AzureOpenAiChatModel.Builder	strictJsonSchema(Boolean strictJsonSchema)
AzureOpenAiChatModel.Builder	supportedCapabilities(Set<Capability> capabilities)
AzureOpenAiChatModel.Builder	temperature(Double temperature)
AzureOpenAiChatModel.Builder	timeout(Duration timeout)
AzureOpenAiChatModel.Builder	tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)	Used to authenticate to Azure OpenAI with Azure Active Directory credentials.
AzureOpenAiChatModel.Builder	tokenizer(Tokenizer tokenizer)
AzureOpenAiChatModel.Builder	topP(Double topP)
AzureOpenAiChatModel.Builder	user(String user)
AzureOpenAiChatModel.Builder	userAgentSuffix(String userAgentSuffix)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

endpoint

public AzureOpenAiChatModel.Builder endpoint(String endpoint)

Sets the Azure OpenAI endpoint. This is a mandatory parameter.

Parameters:

endpoint - The Azure OpenAI endpoint in the format: https://{resource}.openai.azure.com/

Returns:

builder

serviceVersion

public AzureOpenAiChatModel.Builder serviceVersion(String serviceVersion)

Sets the Azure OpenAI API service version. This is a mandatory parameter.

Parameters:

serviceVersion - The Azure OpenAI API service version in the format: 2023-05-15

Returns:

builder

apiKey

public AzureOpenAiChatModel.Builder apiKey(String apiKey)

Sets the Azure OpenAI API key.

Parameters:

apiKey - The Azure OpenAI API key.

Returns:

builder

nonAzureApiKey

public AzureOpenAiChatModel.Builder nonAzureApiKey(String nonAzureApiKey)

Used to authenticate with the OpenAI service, instead of Azure OpenAI. This automatically sets the endpoint to https://api.openai.com/v1.

Parameters:

nonAzureApiKey - The non-Azure OpenAI API key

Returns:

builder

tokenCredential

public AzureOpenAiChatModel.Builder tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)

Used to authenticate to Azure OpenAI with Azure Active Directory credentials.

Parameters:

tokenCredential - the credentials to authenticate with Azure Active Directory

Returns:

builder

deploymentName

public AzureOpenAiChatModel.Builder deploymentName(String deploymentName)

Sets the deployment name in Azure OpenAI. This is a mandatory parameter.

Parameters:

deploymentName - The Deployment name.

Returns:

builder

tokenizer

public AzureOpenAiChatModel.Builder tokenizer(Tokenizer tokenizer)

maxTokens

public AzureOpenAiChatModel.Builder maxTokens(Integer maxTokens)

temperature

public AzureOpenAiChatModel.Builder temperature(Double temperature)

topP

public AzureOpenAiChatModel.Builder topP(Double topP)

logitBias

public AzureOpenAiChatModel.Builder logitBias(Map<String,Integer> logitBias)

user

public AzureOpenAiChatModel.Builder user(String user)

stop

public AzureOpenAiChatModel.Builder stop(List<String> stop)

presencePenalty

public AzureOpenAiChatModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public AzureOpenAiChatModel.Builder frequencyPenalty(Double frequencyPenalty)

dataSources

public AzureOpenAiChatModel.Builder dataSources(List<com.azure.ai.openai.models.AzureChatExtensionConfiguration> dataSources)

enhancements

public AzureOpenAiChatModel.Builder enhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)

seed

public AzureOpenAiChatModel.Builder seed(Long seed)

responseFormat

@Deprecated(forRemoval=true)
public AzureOpenAiChatModel.Builder responseFormat(com.azure.ai.openai.models.ChatCompletionsResponseFormat chatCompletionsResponseFormat)

Deprecated, for removal: This API element is subject to removal in a future version.

For JSON output, you can replace `.responseFormat(new ChatCompletionsJsonResponseFormat())` with a `JsonSchema` in the `ResponseFormat`. You can then use `.strictJsonSchema(true)`to force JSON schema adherence.

responseFormat

public AzureOpenAiChatModel.Builder responseFormat(ResponseFormat responseFormat)

strictJsonSchema

public AzureOpenAiChatModel.Builder strictJsonSchema(Boolean strictJsonSchema)

timeout

public AzureOpenAiChatModel.Builder timeout(Duration timeout)

maxRetries

public AzureOpenAiChatModel.Builder maxRetries(Integer maxRetries)

proxyOptions

public AzureOpenAiChatModel.Builder proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)

logRequestsAndResponses

public AzureOpenAiChatModel.Builder logRequestsAndResponses(Boolean logRequestsAndResponses)

userAgentSuffix

public AzureOpenAiChatModel.Builder userAgentSuffix(String userAgentSuffix)

openAIClient

public AzureOpenAiChatModel.Builder openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)

Sets the Azure OpenAI client. This is an optional parameter, if you need more flexibility than using the endpoint, serviceVersion, apiKey, deploymentName parameters.

Parameters:

openAIClient - The Azure OpenAI client.

Returns:

builder

listeners

public AzureOpenAiChatModel.Builder listeners(List<ChatModelListener> listeners)

customHeaders

public AzureOpenAiChatModel.Builder customHeaders(Map<String,String> customHeaders)

supportedCapabilities

public AzureOpenAiChatModel.Builder supportedCapabilities(Set<Capability> capabilities)

build

public AzureOpenAiChatModel build()