Class OpenAiOfficialEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.openaiofficial.OpenAiOfficialEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class OpenAiOfficialEmbeddingModel
extends DimensionAwareEmbeddingModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiOfficialEmbeddingModel.Builder

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
OpenAiOfficialEmbeddingModel(OpenAiOfficialEmbeddingModel.Builder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiOfficialEmbeddingModel.Builder	builder()
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
protected Integer	knownDimension()	When known (e.g., can be derived from the model name), returns the dimension of the Embedding produced by this embedding model.
String	modelName()	Returns the name of the underlying embedding model.

Methods inherited from class DimensionAwareEmbeddingModel

dimension

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

addListener, addListeners, defaultRequestParameters, doEmbed, embed, embed, embed, listeners, provider, supportedContentTypes, supportedParameters

Constructor Details

OpenAiOfficialEmbeddingModel

public OpenAiOfficialEmbeddingModel(OpenAiOfficialEmbeddingModel.Builder builder)

Method Details

embedAll

public Response<List<Embedding>> embedAll(List<TextSegment> textSegments)

Description copied from interface: EmbeddingModel

Embeds the text content of a list of TextSegments.

This is a convenience method over EmbeddingModel.embed(EmbeddingRequest), so listeners are notified and the model's default per-call parameters are applied here too. A provider implements its embedding logic by overriding EmbeddingModel.doEmbed(EmbeddingRequest) (preferred); it may still override this method for batch-specific behavior that the request/response API does not carry (for example applying a document title from TextSegment metadata).

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.

modelName

public String modelName()

Description copied from interface: EmbeddingModel

Returns the name of the underlying embedding model.

Implementations are encouraged to override this method and provide the actual model name. The default implementation returns "unknown", which indicates that the model name is unknown.

Returns:

the model name or a fallback value if not provided

builder

public static OpenAiOfficialEmbeddingModel.Builder builder()

knownDimension

protected Integer knownDimension()

Description copied from class: DimensionAwareEmbeddingModel

When known (e.g., can be derived from the model name), returns the dimension of the Embedding produced by this embedding model. Otherwise, it returns null.

Overrides:

knownDimension in class DimensionAwareEmbeddingModel

Returns:

the known dimension of the Embedding, or null if unknown.