Package org.springframework.ai.openai

Class OpenAiEmbeddingOptions.Builder

java.lang.Object

org.springframework.ai.openai.AbstractOpenAiOptions.AbstractBuilder<OpenAiEmbeddingOptions,OpenAiEmbeddingOptions.Builder>

org.springframework.ai.openai.OpenAiEmbeddingOptions.Builder

Enclosing class:

OpenAiEmbeddingOptions

public static final class OpenAiEmbeddingOptions.Builder
extends AbstractOpenAiOptions.AbstractBuilder<OpenAiEmbeddingOptions,OpenAiEmbeddingOptions.Builder>

Field Summary

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

apiKey, baseUrl, credential, customHeaders, isGitHubModels, isMicrosoftFoundry, maxRetries, microsoftDeploymentName, microsoftFoundryServiceVersion, model, organizationId, proxy, timeout

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAiEmbeddingOptions	build()
OpenAiEmbeddingOptions.Builder	dimensions(@Nullable Integer dimensions)
OpenAiEmbeddingOptions.Builder	encodingFormat(@Nullable OpenAiEmbeddingOptions.EncodingFormat encodingFormat)
OpenAiEmbeddingOptions.Builder	from(com.openai.models.embeddings.EmbeddingCreateParams openAiCreateParams)
OpenAiEmbeddingOptions.Builder	from(OpenAiEmbeddingOptions fromOptions)
OpenAiEmbeddingOptions.Builder	merge(@Nullable EmbeddingOptions from)
OpenAiEmbeddingOptions.Builder	user(@Nullable String user)

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

apiKey, apiKey, azure, azureOpenAIServiceVersion, baseUrl, credential, customHeaders, deploymentName, gitHubModels, maxRetries, microsoftFoundry, microsoftFoundryServiceVersion, model, organizationId, proxy, self, timeout

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

from

public OpenAiEmbeddingOptions.Builder from(OpenAiEmbeddingOptions fromOptions)

merge

public OpenAiEmbeddingOptions.Builder merge(@Nullable EmbeddingOptions from)

from

public OpenAiEmbeddingOptions.Builder from(com.openai.models.embeddings.EmbeddingCreateParams openAiCreateParams)

user

public OpenAiEmbeddingOptions.Builder user(@Nullable String user)

encodingFormat

public OpenAiEmbeddingOptions.Builder encodingFormat(@Nullable OpenAiEmbeddingOptions.EncodingFormat encodingFormat)

dimensions

public OpenAiEmbeddingOptions.Builder dimensions(@Nullable Integer dimensions)

build

public OpenAiEmbeddingOptions build()

Specified by:

build in class AbstractOpenAiOptions.AbstractBuilder<OpenAiEmbeddingOptions,OpenAiEmbeddingOptions.Builder>