Class WorkersAiEmbeddingModel

java.lang.Object

dev.langchain4j.model.workersai.client.AbstractWorkersAIModel

dev.langchain4j.model.workersai.WorkersAiEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class WorkersAiEmbeddingModel
extends AbstractWorkersAIModel
implements EmbeddingModel

WorkerAI Embedding model. ...

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkersAiEmbeddingModel.Builder	Internal Builder.

Field Summary

Fields inherited from class AbstractWorkersAIModel

accountId, client, modelName

Constructor Summary

Constructors

Constructor	Description
WorkersAiEmbeddingModel(WorkersAiEmbeddingModel.Builder builder)	Constructor with Builder.
WorkersAiEmbeddingModel(String accountId, String modelName, String apiToken)	Constructor with Builder.

Method Summary

Modifier and Type	Method	Description
static WorkersAiEmbeddingModel.Builder	builder()	Builder access.
Response<Embedding>	embed(TextSegment textSegment)	Embed the text content of a TextSegment.
Response<Embedding>	embed(String text)	Embed a text.
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
String	modelName()	Returns the name of the underlying embedding model.

Methods inherited from class Object

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

Methods inherited from interface EmbeddingModel

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

Constructor Details

WorkersAiEmbeddingModel

public WorkersAiEmbeddingModel(WorkersAiEmbeddingModel.Builder builder)

Constructor with Builder.

Parameters:

builder - builder.

WorkersAiEmbeddingModel

public WorkersAiEmbeddingModel(String accountId,
 String modelName,
 String apiToken)

Constructor with Builder.

Parameters:

accountId - account identifier

modelName - model name

apiToken - api token

Method Details

builder

public static WorkersAiEmbeddingModel.Builder builder()

Builder access.

Returns:

builder instance

embed

public Response<Embedding> embed(String text)

Embed a text.

Specified by:

embed in interface EmbeddingModel

Parameters:

text - the text to embed.

Returns:

the embedding.

embed

public Response<Embedding> embed(TextSegment textSegment)

Embed the text content of a TextSegment.

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.

Specified by:

embed in interface EmbeddingModel

Parameters:

textSegment - the text segment to embed.

Returns:

the embedding.

embedAll

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

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).

Specified by:

embedAll in interface EmbeddingModel

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.

Specified by:

modelName in interface EmbeddingModel

Returns:

the model name or a fallback value if not provided