Package org.springframework.ai.azure.openai

Class AzureOpenAiChatOptions.Builder

java.lang.Object

org.springframework.ai.azure.openai.AzureOpenAiChatOptions.Builder

Enclosing class:

AzureOpenAiChatOptions

public static class AzureOpenAiChatOptions.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected AzureOpenAiChatOptions	options

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(AzureOpenAiChatOptions options)

Method Summary

Modifier and Type	Method	Description
AzureOpenAiChatOptions	build()
AzureOpenAiChatOptions.Builder	deploymentName(String deploymentName)
AzureOpenAiChatOptions.Builder	enhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)
AzureOpenAiChatOptions.Builder	frequencyPenalty(Double frequencyPenalty)
AzureOpenAiChatOptions.Builder	function(String functionName)
AzureOpenAiChatOptions.Builder	functionCallbacks(List<FunctionCallback> functionCallbacks)
AzureOpenAiChatOptions.Builder	functions(Set<String> functionNames)
AzureOpenAiChatOptions.Builder	logitBias(Map<String,Integer> logitBias)
AzureOpenAiChatOptions.Builder	logprobs(Boolean logprobs)
AzureOpenAiChatOptions.Builder	maxTokens(Integer maxTokens)
AzureOpenAiChatOptions.Builder	N(Integer n)
AzureOpenAiChatOptions.Builder	presencePenalty(Double presencePenalty)
AzureOpenAiChatOptions.Builder	proxyToolCalls(Boolean proxyToolCalls)
AzureOpenAiChatOptions.Builder	responseFormat(AzureOpenAiResponseFormat responseFormat)
AzureOpenAiChatOptions.Builder	seed(Long seed)
AzureOpenAiChatOptions.Builder	stop(List<String> stop)
AzureOpenAiChatOptions.Builder	streamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)
AzureOpenAiChatOptions.Builder	temperature(Double temperature)
AzureOpenAiChatOptions.Builder	toolContext(Map<String,Object> toolContext)
AzureOpenAiChatOptions.Builder	topLogprobs(Integer topLogprobs)
AzureOpenAiChatOptions.Builder	topP(Double topP)
AzureOpenAiChatOptions.Builder	user(String user)
AzureOpenAiChatOptions.Builder	withDeploymentName(String deploymentName)	Deprecated, for removal: This API element is subject to removal in a future version. use deploymentName(String) instead.
AzureOpenAiChatOptions.Builder	withEnhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)	Deprecated, for removal: This API element is subject to removal in a future version. use enhancements(AzureChatEnhancementConfiguration) )} instead.
AzureOpenAiChatOptions.Builder	withFrequencyPenalty(Double frequencyPenalty)	Deprecated, for removal: This API element is subject to removal in a future version. use frequencyPenalty(Double) instead.
AzureOpenAiChatOptions.Builder	withFunction(String functionName)	Deprecated, for removal: This API element is subject to removal in a future version. use function(String) instead.
AzureOpenAiChatOptions.Builder	withFunctionCallbacks(List<FunctionCallback> functionCallbacks)	Deprecated, for removal: This API element is subject to removal in a future version. use functionCallbacks(List) instead.
AzureOpenAiChatOptions.Builder	withFunctions(Set<String> functionNames)	Deprecated, for removal: This API element is subject to removal in a future version. use functions(Set) instead.
AzureOpenAiChatOptions.Builder	withLogitBias(Map<String,Integer> logitBias)	Deprecated, for removal: This API element is subject to removal in a future version. use logitBias(Map) instead.
AzureOpenAiChatOptions.Builder	withLogprobs(Boolean logprobs)	Deprecated, for removal: This API element is subject to removal in a future version. use logprobs(Boolean) instead.
AzureOpenAiChatOptions.Builder	withMaxTokens(Integer maxTokens)	Deprecated, for removal: This API element is subject to removal in a future version. use maxTokens(Integer) instead.
AzureOpenAiChatOptions.Builder	withN(Integer n)	Deprecated, for removal: This API element is subject to removal in a future version. use N(Integer) instead.
AzureOpenAiChatOptions.Builder	withPresencePenalty(Double presencePenalty)	Deprecated, for removal: This API element is subject to removal in a future version. use presencePenalty(Double) instead.
AzureOpenAiChatOptions.Builder	withProxyToolCalls(Boolean proxyToolCalls)	Deprecated, for removal: This API element is subject to removal in a future version. use proxyToolCalls(Boolean) instead.
AzureOpenAiChatOptions.Builder	withResponseFormat(AzureOpenAiResponseFormat responseFormat)	Deprecated, for removal: This API element is subject to removal in a future version. use responseFormat(AzureOpenAiResponseFormat) instead.
AzureOpenAiChatOptions.Builder	withSeed(Long seed)	Deprecated, for removal: This API element is subject to removal in a future version. use seed(Long) instead.
AzureOpenAiChatOptions.Builder	withStop(List<String> stop)	Deprecated, for removal: This API element is subject to removal in a future version. use stop(List) instead.
AzureOpenAiChatOptions.Builder	withStreamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)	Deprecated, for removal: This API element is subject to removal in a future version. use streamOptions(ChatCompletionStreamOptions) instead.
AzureOpenAiChatOptions.Builder	withTemperature(Double temperature)	Deprecated, for removal: This API element is subject to removal in a future version. use temperature(Double) instead.
AzureOpenAiChatOptions.Builder	withToolContext(Map<String,Object> toolContext)	Deprecated, for removal: This API element is subject to removal in a future version. use toolContext(Map) instead.
AzureOpenAiChatOptions.Builder	withTopLogprobs(Integer topLogprobs)	Deprecated, for removal: This API element is subject to removal in a future version. use topLogprobs(Integer) instead.
AzureOpenAiChatOptions.Builder	withTopP(Double topP)	Deprecated, for removal: This API element is subject to removal in a future version. use topP(Double) instead.
AzureOpenAiChatOptions.Builder	withUser(String user)	Deprecated, for removal: This API element is subject to removal in a future version. use user(String) instead.

Methods inherited from class java.lang.Object

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

Field Details

options

protected AzureOpenAiChatOptions options

Constructor Details

Builder

public Builder()

Builder

public Builder(AzureOpenAiChatOptions options)

Method Details

deploymentName

public AzureOpenAiChatOptions.Builder deploymentName(String deploymentName)

frequencyPenalty

public AzureOpenAiChatOptions.Builder frequencyPenalty(Double frequencyPenalty)

logitBias

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

maxTokens

public AzureOpenAiChatOptions.Builder maxTokens(Integer maxTokens)

N

public AzureOpenAiChatOptions.Builder N(Integer n)

presencePenalty

public AzureOpenAiChatOptions.Builder presencePenalty(Double presencePenalty)

stop

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

temperature

public AzureOpenAiChatOptions.Builder temperature(Double temperature)

topP

public AzureOpenAiChatOptions.Builder topP(Double topP)

user

public AzureOpenAiChatOptions.Builder user(String user)

functionCallbacks

public AzureOpenAiChatOptions.Builder functionCallbacks(List<FunctionCallback> functionCallbacks)

functions

public AzureOpenAiChatOptions.Builder functions(Set<String> functionNames)

function

public AzureOpenAiChatOptions.Builder function(String functionName)

responseFormat

public AzureOpenAiChatOptions.Builder responseFormat(AzureOpenAiResponseFormat responseFormat)

proxyToolCalls

public AzureOpenAiChatOptions.Builder proxyToolCalls(Boolean proxyToolCalls)

seed

public AzureOpenAiChatOptions.Builder seed(Long seed)

logprobs

public AzureOpenAiChatOptions.Builder logprobs(Boolean logprobs)

topLogprobs

public AzureOpenAiChatOptions.Builder topLogprobs(Integer topLogprobs)

enhancements

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

toolContext

public AzureOpenAiChatOptions.Builder toolContext(Map<String,Object> toolContext)

streamOptions

public AzureOpenAiChatOptions.Builder streamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)

withDeploymentName

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withDeploymentName(String deploymentName)

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

use deploymentName(String) instead.

withFrequencyPenalty

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withFrequencyPenalty(Double frequencyPenalty)

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

use frequencyPenalty(Double) instead.

withLogitBias

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withLogitBias(Map<String,Integer> logitBias)

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

use logitBias(Map) instead.

withMaxTokens

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withMaxTokens(Integer maxTokens)

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

use maxTokens(Integer) instead.

withN

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withN(Integer n)

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

use N(Integer) instead.

withPresencePenalty

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withPresencePenalty(Double presencePenalty)

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

use presencePenalty(Double) instead.

withStop

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withStop(List<String> stop)

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

use stop(List) instead.

withTemperature

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withTemperature(Double temperature)

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

use temperature(Double) instead.

withTopP

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withTopP(Double topP)

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

use topP(Double) instead.

withUser

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withUser(String user)

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

use user(String) instead.

withFunctionCallbacks

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withFunctionCallbacks(List<FunctionCallback> functionCallbacks)

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

use functionCallbacks(List) instead.

withFunctions

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withFunctions(Set<String> functionNames)

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

use functions(Set) instead.

withFunction

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withFunction(String functionName)

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

use function(String) instead.

withResponseFormat

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withResponseFormat(AzureOpenAiResponseFormat responseFormat)

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

use responseFormat(AzureOpenAiResponseFormat) instead.

withProxyToolCalls

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withProxyToolCalls(Boolean proxyToolCalls)

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

use proxyToolCalls(Boolean) instead.

withSeed

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withSeed(Long seed)

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

use seed(Long) instead.

withLogprobs

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withLogprobs(Boolean logprobs)

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

use logprobs(Boolean) instead.

withTopLogprobs

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withTopLogprobs(Integer topLogprobs)

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

use topLogprobs(Integer) instead.

withEnhancements

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withEnhancements(com.azure.ai.openai.models.AzureChatEnhancementConfiguration enhancements)

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

use enhancements(AzureChatEnhancementConfiguration) )} instead.

withToolContext

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withToolContext(Map<String,Object> toolContext)

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

use toolContext(Map) instead.

withStreamOptions

@Deprecated(forRemoval=true,
            since="1.0.0-M5")
public AzureOpenAiChatOptions.Builder withStreamOptions(com.azure.ai.openai.models.ChatCompletionStreamOptions streamOptions)

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

use streamOptions(ChatCompletionStreamOptions) instead.

build

public AzureOpenAiChatOptions build()