Package dev.langchain4j.model.openai

Class OpenAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.openai.OpenAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel, TokenCountEstimator

public class OpenAiEmbeddingModel
extends Object
implements EmbeddingModel, TokenCountEstimator

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

Constructor Summary

Constructors

Constructor	Description
OpenAiEmbeddingModel(String baseUrl, String apiKey, String organizationId, String modelName, Integer dimensions, String user, Duration timeout, Integer maxRetries, Proxy proxy, Boolean logRequests, Boolean logResponses, Tokenizer tokenizer)

Method Summary

Modifier and Type	Method	Description
static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder	builder()
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)
int	estimateTokenCount(String text)
static OpenAiEmbeddingModel	withApiKey(String apiKey)

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.embedding.EmbeddingModel

embed, embed

Methods inherited from interface dev.langchain4j.model.embedding.TokenCountEstimator

estimateTokenCount, estimateTokenCount

Constructor Details

OpenAiEmbeddingModel

public OpenAiEmbeddingModel(String baseUrl,
 String apiKey,
 String organizationId,
 String modelName,
 Integer dimensions,
 String user,
 Duration timeout,
 Integer maxRetries,
 Proxy proxy,
 Boolean logRequests,
 Boolean logResponses,
 Tokenizer tokenizer)

Method Details

embedAll

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

Specified by:

embedAll in interface EmbeddingModel

estimateTokenCount

public int estimateTokenCount(String text)

Specified by:

estimateTokenCount in interface TokenCountEstimator

withApiKey

public static OpenAiEmbeddingModel withApiKey(String apiKey)

builder

public static OpenAiEmbeddingModel.OpenAiEmbeddingModelBuilder builder()