Package dev.langchain4j.model.azure

Class AzureOpenAiStreamingLanguageModel.Builder

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiStreamingLanguageModel.Builder

Enclosing class:

AzureOpenAiStreamingLanguageModel

public static class AzureOpenAiStreamingLanguageModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the Azure OpenAI API key.

Parameters:

apiKey - The Azure OpenAI API key.

Returns:

builder

nonAzureApiKey

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

maxTokens

public AzureOpenAiStreamingLanguageModel.Builder maxTokens(Integer maxTokens)

temperature

public AzureOpenAiStreamingLanguageModel.Builder temperature(Double temperature)

topP

public AzureOpenAiStreamingLanguageModel.Builder topP(Double topP)

logitBias

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

user

public AzureOpenAiStreamingLanguageModel.Builder user(String user)

n

public AzureOpenAiStreamingLanguageModel.Builder n(Integer n)

logprobs

public AzureOpenAiStreamingLanguageModel.Builder logprobs(Integer logprobs)

echo

public AzureOpenAiStreamingLanguageModel.Builder echo(Boolean echo)

stop

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

presencePenalty

public AzureOpenAiStreamingLanguageModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public AzureOpenAiStreamingLanguageModel.Builder frequencyPenalty(Double frequencyPenalty)

timeout

public AzureOpenAiStreamingLanguageModel.Builder timeout(Duration timeout)

maxRetries

public AzureOpenAiStreamingLanguageModel.Builder maxRetries(Integer maxRetries)

proxyOptions

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

logRequestsAndResponses

public AzureOpenAiStreamingLanguageModel.Builder logRequestsAndResponses(Boolean logRequestsAndResponses)

openAIClient

public AzureOpenAiStreamingLanguageModel.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 AzureOpenAiStreamingLanguageModel.Builder userAgentSuffix(String userAgentSuffix)

customHeaders

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

build

public AzureOpenAiStreamingLanguageModel build()