Package dev.langchain4j.model.huggingface

Class HuggingFaceEmbeddingModel

java.lang.Object

dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dev.langchain4j.model.huggingface.HuggingFaceEmbeddingModel

All Implemented Interfaces:

EmbeddingModel

public class HuggingFaceEmbeddingModel
extends DimensionAwareEmbeddingModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HuggingFaceEmbeddingModel.HuggingFaceEmbeddingModelBuilder

Field Summary

Fields inherited from class dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dimension

Constructor Summary

Constructors

Constructor	Description
HuggingFaceEmbeddingModel(String accessToken, String modelId, Boolean waitForModel, Duration timeout)

Method Summary

Modifier and Type	Method	Description
static HuggingFaceEmbeddingModel.HuggingFaceEmbeddingModelBuilder	builder()
Response<List<Embedding>>	embedAll(List<TextSegment> textSegments)	Embeds the text content of a list of TextSegments.
static HuggingFaceEmbeddingModel	withAccessToken(String accessToken)

Methods inherited from class dev.langchain4j.model.embedding.DimensionAwareEmbeddingModel

dimension, knownDimension

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

Constructor Details

HuggingFaceEmbeddingModel

public HuggingFaceEmbeddingModel(String accessToken,
 String modelId,
 Boolean waitForModel,
 Duration timeout)

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.

Parameters:

textSegments - the text segments to embed.

Returns:

the embeddings.

withAccessToken

public static HuggingFaceEmbeddingModel withAccessToken(String accessToken)

builder

public static HuggingFaceEmbeddingModel.HuggingFaceEmbeddingModelBuilder builder()