Package org.springframework.ai.openai

Class OpenAiDecisionOptions.AbstractBuilder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>

java.lang.Object

org.springframework.ai.decision.DefaultDecisionOptions.Builder<B>

org.springframework.ai.openai.OpenAiDecisionOptions.AbstractBuilder<B>

All Implemented Interfaces:

Cloneable, DecisionOptions.Builder<B>

Direct Known Subclasses:

OpenAiDecisionOptions.Builder

Enclosing class:

OpenAiDecisionOptions

protected abstract static class OpenAiDecisionOptions.AbstractBuilder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>
extends DefaultDecisionOptions.Builder<B>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	apiKey
protected @Nullable String	baseUrl
protected @Nullable com.openai.credential.Credential	credential
protected @Nullable Map<String,String>	customHeaders
protected @Nullable Boolean	isGitHubModels
protected @Nullable Boolean	isMicrosoftFoundry
protected @Nullable Integer	maxRetries
protected @Nullable String	microsoftDeploymentName
protected @Nullable com.openai.azure.AzureOpenAIServiceVersion	microsoftFoundryServiceVersion
protected @Nullable String	organizationId
protected @Nullable Proxy	proxy
protected @Nullable String	safetyIdentifier
protected @Nullable Duration	timeout

Fields inherited from class org.springframework.ai.decision.DefaultDecisionOptions.Builder

model

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
B	apiKey(@Nullable String apiKey)
B	apiKey(@Nullable ApiKey apiKey)
B	baseUrl(@Nullable String baseUrl)
OpenAiDecisionOptions	build()
B	clone()
B	combineWith(DecisionOptions.Builder<?> other)	Override the values set so far with the non-null values of the given builder, whichever implementation it is.
B	credential(@Nullable com.openai.credential.Credential credential)
B	customHeaders(@Nullable Map<String,String> customHeaders)
B	deploymentName(@Nullable String deploymentName)
B	gitHubModels(@Nullable Boolean gitHubModels)
B	maxRetries(@Nullable Integer maxRetries)
B	microsoftFoundry(@Nullable Boolean microsoftFoundry)
B	microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion)
B	organizationId(@Nullable String organizationId)
B	proxy(@Nullable Proxy proxy)
B	safetyIdentifier(@Nullable String safetyIdentifier)
B	timeout(@Nullable Duration timeout)

Methods inherited from class org.springframework.ai.decision.DefaultDecisionOptions.Builder

model, self

Methods inherited from class java.lang.Object

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

Field Details

baseUrl

protected @Nullable String baseUrl

apiKey

protected @Nullable String apiKey

credential

protected @Nullable com.openai.credential.Credential credential

microsoftDeploymentName

protected @Nullable String microsoftDeploymentName

microsoftFoundryServiceVersion

protected @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion

organizationId

protected @Nullable String organizationId

isMicrosoftFoundry

protected @Nullable Boolean isMicrosoftFoundry

isGitHubModels

protected @Nullable Boolean isGitHubModels

timeout

protected @Nullable Duration timeout

maxRetries

protected @Nullable Integer maxRetries

proxy

protected @Nullable Proxy proxy

customHeaders

protected @Nullable Map<String,String> customHeaders

safetyIdentifier

protected @Nullable String safetyIdentifier

Constructor Details

AbstractBuilder

protected AbstractBuilder()

Method Details

clone

public B clone()

Specified by:

clone in interface DecisionOptions.Builder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>

Overrides:

clone in class DefaultDecisionOptions.Builder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>

baseUrl

public B baseUrl(@Nullable String baseUrl)

apiKey

public B apiKey(@Nullable String apiKey)

apiKey

public B apiKey(@Nullable ApiKey apiKey)

credential

public B credential(@Nullable com.openai.credential.Credential credential)

deploymentName

public B deploymentName(@Nullable String deploymentName)

microsoftFoundryServiceVersion

public B microsoftFoundryServiceVersion(@Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion)

organizationId

public B organizationId(@Nullable String organizationId)

microsoftFoundry

public B microsoftFoundry(@Nullable Boolean microsoftFoundry)

gitHubModels

public B gitHubModels(@Nullable Boolean gitHubModels)

timeout

public B timeout(@Nullable Duration timeout)

maxRetries

public B maxRetries(@Nullable Integer maxRetries)

proxy

public B proxy(@Nullable Proxy proxy)

customHeaders

public B customHeaders(@Nullable Map<String,String> customHeaders)

safetyIdentifier

public B safetyIdentifier(@Nullable String safetyIdentifier)

combineWith

public B combineWith(DecisionOptions.Builder<?> other)

Description copied from class: DefaultDecisionOptions.Builder

Override the values set so far with the non-null values of the given builder, whichever implementation it is.

A builder of another implementation is read through the options it builds, so a model its build() fills in counts as set.

Specified by:

combineWith in interface DecisionOptions.Builder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>

Overrides:

combineWith in class DefaultDecisionOptions.Builder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>

build

public OpenAiDecisionOptions build()

Specified by:

build in interface DecisionOptions.Builder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>

Overrides:

build in class DefaultDecisionOptions.Builder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>