Package dev.langchain4j.model.azure

Class AzureOpenAiStreamingChatModel.Builder

java.lang.Object

dev.langchain4j.model.azure.AzureOpenAiStreamingChatModel.Builder

Enclosing class:

AzureOpenAiStreamingChatModel

public static class AzureOpenAiStreamingChatModel.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AzureOpenAiStreamingChatModel.Builder	apiKey(String apiKey)	Sets the Azure OpenAI API key.
AzureOpenAiStreamingChatModel	build()
AzureOpenAiStreamingChatModel.Builder	customHeaders(Map<String,String> customHeaders)
AzureOpenAiStreamingChatModel.Builder	dataSources(List<com.azure.ai.openai.models.AzureChatExtensionConfiguration> dataSources)
AzureOpenAiStreamingChatModel.Builder	deploymentName(String deploymentName)	Sets the deployment name in Azure OpenAI.
AzureOpenAiStreamingChatModel.Builder	endpoint(String endpoint)	Sets the Azure OpenAI endpoint.
AzureOpenAiStreamingChatModel.Builder	enhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
AzureOpenAiStreamingChatModel.Builder	frequencyPenalty(Double frequencyPenalty)
AzureOpenAiStreamingChatModel.Builder	listeners(List<ChatModelListener> listeners)
AzureOpenAiStreamingChatModel.Builder	logitBias(Map<String,Integer> logitBias)
AzureOpenAiStreamingChatModel.Builder	logRequestsAndResponses(boolean logRequestsAndResponses)
AzureOpenAiStreamingChatModel.Builder	maxRetries(Integer maxRetries)
AzureOpenAiStreamingChatModel.Builder	maxTokens(Integer maxTokens)
AzureOpenAiStreamingChatModel.Builder	n(Integer n)
AzureOpenAiStreamingChatModel.Builder	nonAzureApiKey(String nonAzureApiKey)	Used to authenticate with the OpenAI service, instead of Azure OpenAI.
AzureOpenAiStreamingChatModel.Builder	openAIAsyncClient(com.azure.ai.openai.OpenAIAsyncClient openAIAsyncClient)	Sets the Azure OpenAI client.
AzureOpenAiStreamingChatModel.Builder	openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)	Deprecated, for removal: This API element is subject to removal in a future version. Please use openAIAsyncClient(OpenAIAsyncClient) instead, if you require response streaming.
AzureOpenAiStreamingChatModel.Builder	presencePenalty(Double presencePenalty)
AzureOpenAiStreamingChatModel.Builder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
AzureOpenAiStreamingChatModel.Builder	responseFormat(com.azure.ai.openai.models.ChatCompletionsResponseFormat responseFormat)
AzureOpenAiStreamingChatModel.Builder	seed(Long seed)
AzureOpenAiStreamingChatModel.Builder	serviceVersion(String serviceVersion)	Sets the Azure OpenAI API service version.
AzureOpenAiStreamingChatModel.Builder	stop(List<String> stop)
AzureOpenAiStreamingChatModel.Builder	temperature(Double temperature)
AzureOpenAiStreamingChatModel.Builder	timeout(Duration timeout)
AzureOpenAiStreamingChatModel.Builder	tokenCredential(com.azure.core.credential.TokenCredential tokenCredential)	Used to authenticate to Azure OpenAI with Azure Active Directory credentials.
AzureOpenAiStreamingChatModel.Builder	tokenizer(Tokenizer tokenizer)
AzureOpenAiStreamingChatModel.Builder	topP(Double topP)
AzureOpenAiStreamingChatModel.Builder	useAsyncClient(boolean useAsyncClient)	Deprecated, for removal: This API element is subject to removal in a future version. If you want to continue using sync client, use AzureOpenAiChatModel instead.
AzureOpenAiStreamingChatModel.Builder	user(String user)
AzureOpenAiStreamingChatModel.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 AzureOpenAiStreamingChatModel.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 AzureOpenAiStreamingChatModel.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 AzureOpenAiStreamingChatModel.Builder apiKey(String apiKey)

Sets the Azure OpenAI API key.

Parameters:

apiKey - The Azure OpenAI API key.

Returns:

builder

nonAzureApiKey

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

maxTokens

public AzureOpenAiStreamingChatModel.Builder maxTokens(Integer maxTokens)

temperature

public AzureOpenAiStreamingChatModel.Builder temperature(Double temperature)

topP

public AzureOpenAiStreamingChatModel.Builder topP(Double topP)

logitBias

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

user

public AzureOpenAiStreamingChatModel.Builder user(String user)

n

public AzureOpenAiStreamingChatModel.Builder n(Integer n)

stop

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

presencePenalty

public AzureOpenAiStreamingChatModel.Builder presencePenalty(Double presencePenalty)

frequencyPenalty

public AzureOpenAiStreamingChatModel.Builder frequencyPenalty(Double frequencyPenalty)

dataSources

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

enhancements

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

seed

public AzureOpenAiStreamingChatModel.Builder seed(Long seed)

responseFormat

public AzureOpenAiStreamingChatModel.Builder responseFormat(com.azure.ai.openai.models.ChatCompletionsResponseFormat responseFormat)

timeout

public AzureOpenAiStreamingChatModel.Builder timeout(Duration timeout)

maxRetries

public AzureOpenAiStreamingChatModel.Builder maxRetries(Integer maxRetries)

proxyOptions

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

logRequestsAndResponses

public AzureOpenAiStreamingChatModel.Builder logRequestsAndResponses(boolean logRequestsAndResponses)

useAsyncClient

@Deprecated(forRemoval=true)
public AzureOpenAiStreamingChatModel.Builder useAsyncClient(boolean useAsyncClient)

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

If you want to continue using sync client, use AzureOpenAiChatModel instead.

Parameters:

useAsyncClient - true if you want to use the async client, false if you want to use the sync client.

Returns:

builder with the useAsyncClient parameter set

openAIClient

@Deprecated(forRemoval=true)
public AzureOpenAiStreamingChatModel.Builder openAIClient(com.azure.ai.openai.OpenAIClient openAIClient)

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

Please use openAIAsyncClient(OpenAIAsyncClient) instead, if you require response streaming. Please use AzureOpenAiChatModel instead, if you require sync responses.

Parameters:

openAIClient - The Azure OpenAI client.

Returns:

builder

openAIAsyncClient

public AzureOpenAiStreamingChatModel.Builder openAIAsyncClient(com.azure.ai.openai.OpenAIAsyncClient openAIAsyncClient)

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

Parameters:

openAIAsyncClient - The Azure OpenAI client.

Returns:

builder

userAgentSuffix

public AzureOpenAiStreamingChatModel.Builder userAgentSuffix(String userAgentSuffix)

listeners

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

customHeaders

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

build

public AzureOpenAiStreamingChatModel build()