Package org.springframework.ai.openaisdk

Class OpenAiSdkEmbeddingOptions

java.lang.Object

org.springframework.ai.openaisdk.AbstractOpenAiSdkOptions

org.springframework.ai.openaisdk.OpenAiSdkEmbeddingOptions

All Implemented Interfaces:

EmbeddingOptions, ModelOptions

public class OpenAiSdkEmbeddingOptions
extends AbstractOpenAiSdkOptions
implements EmbeddingOptions

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

Author:

Julien Dubois

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiSdkEmbeddingOptions.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_EMBEDDING_MODEL

Constructor Summary

Constructors

Constructor	Description
OpenAiSdkEmbeddingOptions()

Method Summary

Modifier and Type	Method	Description
static OpenAiSdkEmbeddingOptions.Builder	builder()
Integer	getDimensions()
String	getUser()
void	setDimensions(Integer dimensions)
void	setUser(String user)
com.openai.models.embeddings.EmbeddingCreateParams	toOpenAiCreateParams(List<String> instructions)
String	toString()

Methods inherited from class org.springframework.ai.openaisdk.AbstractOpenAiSdkOptions

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

OpenAiSdkEmbeddingOptions

public OpenAiSdkEmbeddingOptions()

Method Details

builder

public static OpenAiSdkEmbeddingOptions.Builder builder()

getUser

public String getUser()

setUser

public void setUser(String user)

getDimensions

public Integer getDimensions()

Specified by:

getDimensions in interface EmbeddingOptions

setDimensions

public void setDimensions(Integer dimensions)

toString

public String toString()

Overrides:

toString in class Object

toOpenAiCreateParams

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