Class OpenAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.openai.OpenAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class OpenAiEmbeddingModel
extends DimensionAwareEmbeddingModel

Represents an OpenAI embedding model, such as text-embedding-ada-002.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder

Field Summary

Fields inherited from class DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
OpenAiEmbeddingModel(OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder	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()

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

embed, embed

Constructor Details

OpenAiEmbeddingModel

public OpenAiEmbeddingModel(OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder)

Method Details

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.

modelName

public String modelName()

embedAll

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

Description copied from interface: EmbeddingModel

Embeds the text content of a list of TextSegments.

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.

builder

public static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder()