Package org.springframework.ai.openai

Class OpenAiDecisionOptions

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions

org.springframework.ai.openai.OpenAiDecisionOptions

All Implemented Interfaces:

DecisionOptions, ModelOptions

public class OpenAiDecisionOptions
extends AbstractOpenAiOptions
implements DecisionOptions

Options for the OpenAI Decisions API, used by OpenAiDecisionModel. The model name is left unset here; OpenAiDecisionModel applies DEFAULT_DECISION_MODEL to its default options when they name none, so that options given at runtime only override what they set.

Since:

2.1.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	OpenAiDecisionOptions.AbstractBuilder<B extends OpenAiDecisionOptions.AbstractBuilder<B>>
static class	OpenAiDecisionOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DECISION_MODEL

Fields inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OpenAiDecisionOptions.Builder	builder()
boolean	equals(@Nullable Object o)
@Nullable String	getSafetyIdentifier()
int	hashCode()
OpenAiDecisionOptions.Builder	mutate()	A builder initialized with these options.
String	toString()

Methods inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getModel, getOrganizationId, getProxy, getTimeout, isGitHubModels, isMicrosoftFoundry

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.ai.decision.DecisionOptions

getModel

Field Details

DEFAULT_DECISION_MODEL

public static final String DEFAULT_DECISION_MODEL

See Also:

• Constant Field Values

Constructor Details

OpenAiDecisionOptions

protected OpenAiDecisionOptions(@Nullable String baseUrl,
 @Nullable String apiKey,
 @Nullable com.openai.credential.Credential credential,
 @Nullable String model,
 @Nullable String microsoftDeploymentName,
 @Nullable com.openai.azure.AzureOpenAIServiceVersion microsoftFoundryServiceVersion,
 @Nullable String organizationId,
 @Nullable Boolean isMicrosoftFoundry,
 @Nullable Boolean isGitHubModels,
 @Nullable Duration timeout,
 @Nullable Integer maxRetries,
 @Nullable Proxy proxy,
 @Nullable Map<String,String> customHeaders,
 @Nullable String safetyIdentifier)

Method Details

builder

public static OpenAiDecisionOptions.Builder builder()

getSafetyIdentifier

public @Nullable String getSafetyIdentifier()

mutate

public OpenAiDecisionOptions.Builder mutate()

Description copied from interface: DecisionOptions

A builder initialized with these options.

Specified by:

mutate in interface DecisionOptions

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object