Package dev.langchain4j.model.azure

Class AzureOpenAiLanguageModel.Builder

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiLanguageModel.Builder

Enclosing class:

AzureOpenAiLanguageModel

public static class AzureOpenAiLanguageModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureOpenAiLanguageModel.Builder	apiKey(String apiKey)	Sets the Azure OpenAI API key.
AzureOpenAiLanguageModel.Builder	bestOf(Integer bestOf)
AzureOpenAiLanguageModel	build()
AzureOpenAiLanguageModel.Builder	customHeaders(Map<String,String> customHeaders)
AzureOpenAiLanguageModel.Builder	deploymentName(String deploymentName)	Sets the deployment name in Azure OpenAI.
AzureOpenAiLanguageModel.Builder	echo(Boolean echo)
AzureOpenAiLanguageModel.Builder	endpoint(String endpoint)	Sets the Azure OpenAI endpoint.
AzureOpenAiLanguageModel.Builder	frequencyPenalty(Double frequencyPenalty)
AzureOpenAiLanguageModel.Builder	logitBias(Map<String,Integer> logitBias)
AzureOpenAiLanguageModel.Builder	logprobs(Integer logprobs)
AzureOpenAiLanguageModel.Builder	logRequestsAndResponses(boolean logRequestsAndResponses)
AzureOpenAiLanguageModel.Builder	maxRetries(Integer maxRetries)
AzureOpenAiLanguageModel.Builder	maxTokens(Integer maxTokens)
AzureOpenAiLanguageModel.Builder	n(Integer n)
AzureOpenAiLanguageModel.Builder	nonAzureApiKey(String nonAzureApiKey)	Used to authenticate with the OpenAI service, instead of Azure OpenAI.
AzureOpenAiLanguageModel.Builder	openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)	Sets the Azure OpenAI client.
AzureOpenAiLanguageModel.Builder	presencePenalty(Double presencePenalty)
AzureOpenAiLanguageModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
AzureOpenAiLanguageModel.Builder	serviceVersion(String serviceVersion)	Sets the Azure OpenAI API service version.
AzureOpenAiLanguageModel.Builder	stop(List<String> stop)
AzureOpenAiLanguageModel.Builder	temperature(Double temperature)
AzureOpenAiLanguageModel.Builder	timeout(Duration timeout)
AzureOpenAiLanguageModel.Builder	tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)	Used to authenticate to Azure OpenAI with Azure Active Directory credentials.
AzureOpenAiLanguageModel.Builder	tokenizer(Tokenizer tokenizer)
AzureOpenAiLanguageModel.Builder	topP(Double topP)
AzureOpenAiLanguageModel.Builder	user(String user)
AzureOpenAiLanguageModel.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 AzureOpenAiLanguageModel.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 AzureOpenAiLanguageModel.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 AzureOpenAiLanguageModel.Builder apiKey(String apiKey)

Sets the Azure OpenAI API key.

Parameters:

apiKey - The Azure OpenAI API key.

Returns:

builder

nonAzureApiKey

public AzureOpenAiLanguageModel.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 AzureOpenAiLanguageModel.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 AzureOpenAiLanguageModel.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 AzureOpenAiLanguageModel.Builder tokenizer(Tokenizer tokenizer)

maxTokens

public AzureOpenAiLanguageModel.Builder maxTokens(Integer maxTokens)

temperature

public AzureOpenAiLanguageModel.Builder temperature(Double temperature)

topP

public AzureOpenAiLanguageModel.Builder topP(Double topP)

logitBias

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

user

public AzureOpenAiLanguageModel.Builder user(String user)

n

public AzureOpenAiLanguageModel.Builder n(Integer n)

logprobs

public AzureOpenAiLanguageModel.Builder logprobs(Integer logprobs)

echo

public AzureOpenAiLanguageModel.Builder echo(Boolean echo)

stop

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

presencePenalty

public AzureOpenAiLanguageModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public AzureOpenAiLanguageModel.Builder frequencyPenalty(Double frequencyPenalty)

bestOf

public AzureOpenAiLanguageModel.Builder bestOf(Integer bestOf)

timeout

public AzureOpenAiLanguageModel.Builder timeout(Duration timeout)

maxRetries

public AzureOpenAiLanguageModel.Builder maxRetries(Integer maxRetries)

proxyOptions

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

logRequestsAndResponses

public AzureOpenAiLanguageModel.Builder logRequestsAndResponses(boolean logRequestsAndResponses)

openAIClient

public AzureOpenAiLanguageModel.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

userAgentSuffix

public AzureOpenAiLanguageModel.Builder userAgentSuffix(String userAgentSuffix)

customHeaders

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

build

public AzureOpenAiLanguageModel build()