Package org.springframework.ai.openai

Class OpenAiEmbeddingOptions

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions

org.springframework.ai.openai.OpenAiEmbeddingOptions

All Implemented Interfaces:

EmbeddingOptions, ModelOptions

public class OpenAiEmbeddingOptions
extends AbstractOpenAiOptions
implements EmbeddingOptions

Configuration information for the Embedding Model implementation using the OpenAI Java SDK.

Author:

Julien Dubois, Christian Tzolov, Ilayaperumal Gopinathan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiEmbeddingOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EMBEDDING_MODEL

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

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
OpenAiEmbeddingOptions()

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingOptions.Builder	builder()
@Nullable Integer	getDimensions()
@Nullable String	getUser()
void	setDimensions(@Nullable Integer dimensions)
void	setUser(@Nullable String user)
com.openai.models.embeddings.EmbeddingCreateParams	toOpenAiCreateParams(List<String> instructions)
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, setApiKey, setBaseUrl, setCredential, setCustomHeaders, setDeploymentName, setGitHubModels, setMaxRetries, setMicrosoftDeploymentName, setMicrosoftFoundry, setMicrosoftFoundryServiceVersion, setModel, setOrganizationId, setProxy, setTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.embedding.EmbeddingOptions

getModel

Field Details

DEFAULT_EMBEDDING_MODEL

public static final String DEFAULT_EMBEDDING_MODEL

Constructor Details

OpenAiEmbeddingOptions

public OpenAiEmbeddingOptions()

Method Details

builder

public static OpenAiEmbeddingOptions.Builder builder()

getUser

public @Nullable String getUser()

setUser

public void setUser(@Nullable String user)

getDimensions

public @Nullable Integer getDimensions()

Specified by:

getDimensions in interface EmbeddingOptions

setDimensions

public void setDimensions(@Nullable Integer dimensions)

toString

public String toString()

Overrides:

toString in class Object

toOpenAiCreateParams

public com.openai.models.embeddings.EmbeddingCreateParams toOpenAiCreateParams(List<String> instructions)