Package org.springframework.ai.openai

Class OpenAiEmbeddingOptions

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions

org.springframework.ai.openai.OpenAiEmbeddingOptions

All Implemented Interfaces:

org.springframework.ai.embedding.EmbeddingOptions, org.springframework.ai.model.ModelOptions

public class OpenAiEmbeddingOptions
extends AbstractOpenAiOptions
implements org.springframework.ai.embedding.EmbeddingOptions

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

Author:

Julien Dubois, Christian Tzolov, Ilayaperumal Gopinathan, Sebastien Deleuze, guan xu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenAiEmbeddingOptions.Builder
static enum	OpenAiEmbeddingOptions.EncodingFormat	The format to return the embeddings in.

Nested classes/interfaces inherited from class org.springframework.ai.openai.AbstractOpenAiOptions

AbstractOpenAiOptions.AbstractBuilder<O extends AbstractOpenAiOptions,B extends AbstractOpenAiOptions.AbstractBuilder<O,B>>

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

Modifier	Constructor	Description
protected	OpenAiEmbeddingOptions(@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 user, @Nullable OpenAiEmbeddingOptions.EncodingFormat encodingFormat, @Nullable Integer dimensions, @Nullable Map<String,Object> extraBody)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingOptions.Builder	builder()
@Nullable Integer	getDimensions()
@Nullable OpenAiEmbeddingOptions.EncodingFormat	getEncodingFormat()
@Nullable Map<String,Object>	getExtraBody()
@Nullable String	getUser()
com.openai.models.embeddings.EmbeddingCreateParams	toOpenAiCreateParams(List<String> instructions)

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

protected OpenAiEmbeddingOptions(@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 user,
 @Nullable OpenAiEmbeddingOptions.EncodingFormat encodingFormat,
 @Nullable Integer dimensions,
 @Nullable Map<String,Object> extraBody)

Method Details

builder

public static OpenAiEmbeddingOptions.Builder builder()

getUser

public @Nullable String getUser()

getEncodingFormat

public @Nullable OpenAiEmbeddingOptions.EncodingFormat getEncodingFormat()

getDimensions

public @Nullable Integer getDimensions()

Specified by:

getDimensions in interface org.springframework.ai.embedding.EmbeddingOptions

getExtraBody

public @Nullable Map<String,Object> getExtraBody()

toOpenAiCreateParams

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