Package org.springframework.ai.model.openai.autoconfigure

Class OpenAiEmbeddingProperties

java.lang.Object

org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

org.springframework.ai.model.openai.autoconfigure.OpenAiEmbeddingProperties

@ConfigurationProperties("spring.ai.openai.embedding")
public class OpenAiEmbeddingProperties
extends AbstractOpenAiProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	OpenAiEmbeddingProperties.Options

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_PREFIX

Fields inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

DEFAULT_MAX_RETRIES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
OpenAiEmbeddingProperties()

Method Summary

Modifier and Type	Method	Description
@Nullable Integer	getDimensions()
@Nullable org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat	getEncodingFormat()
org.springframework.ai.document.MetadataMode	getMetadataMode()
@Nullable String	getModel()
OpenAiEmbeddingProperties.Options	getOptions()	Deprecated, for removal: This API element is subject to removal in a future version.
@Nullable String	getUser()
void	setDimensions(@Nullable Integer dimensions)
void	setEncodingFormat(@Nullable org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat encodingFormat)
void	setMetadataMode(org.springframework.ai.document.MetadataMode metadataMode)
void	setModel(@Nullable String model)
void	setOptions(OpenAiEmbeddingProperties.Options options)
void	setUser(@Nullable String user)
org.springframework.ai.openai.OpenAiEmbeddingOptions	toOptions()

Methods inherited from class org.springframework.ai.model.openai.autoconfigure.AbstractOpenAiProperties

getApiKey, getBaseUrl, getCredential, getCustomHeaders, getDeploymentName, getMaxRetries, getMicrosoftDeploymentName, getMicrosoftFoundryServiceVersion, getOrganizationId, getProxy, getTimeout, isConnectionPoolMetricsEnabled, isGitHubModels, isMicrosoftFoundry, setApiKey, setBaseUrl, setConnectionPoolMetricsEnabled, setCredential, setCustomHeaders, setDeploymentName, setGitHubModels, setMaxRetries, setMicrosoftDeploymentName, setMicrosoftFoundry, setMicrosoftFoundryServiceVersion, setOrganizationId, setProxy, setTimeout

Methods inherited from class java.lang.Object

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

Field Details

CONFIG_PREFIX

public static final String CONFIG_PREFIX

See Also:

• Constant Field Values

Constructor Details

OpenAiEmbeddingProperties

public OpenAiEmbeddingProperties()

Method Details

getMetadataMode

public org.springframework.ai.document.MetadataMode getMetadataMode()

setMetadataMode

public void setMetadataMode(org.springframework.ai.document.MetadataMode metadataMode)

getModel

public @Nullable String getModel()

Overrides:

getModel in class AbstractOpenAiProperties

setModel

public void setModel(@Nullable String model)

Overrides:

setModel in class AbstractOpenAiProperties

getUser

public @Nullable String getUser()

setUser

public void setUser(@Nullable String user)

getEncodingFormat

public @Nullable org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat getEncodingFormat()

setEncodingFormat

public void setEncodingFormat(@Nullable org.springframework.ai.openai.OpenAiEmbeddingOptions.EncodingFormat encodingFormat)

getDimensions

public @Nullable Integer getDimensions()

setDimensions

public void setDimensions(@Nullable Integer dimensions)

toOptions

public org.springframework.ai.openai.OpenAiEmbeddingOptions toOptions()

getOptions

@DeprecatedConfigurationProperty(replacement="spring.ai.openai.embedding")
@Deprecated(since="2.0.0",
            forRemoval=true)
public OpenAiEmbeddingProperties.Options getOptions()

Deprecated, for removal: This API element is subject to removal in a future version.

setOptions

public void setOptions(OpenAiEmbeddingProperties.Options options)