public Class AsyncEmbeddingModel

Class Inheritance

extends Object
implements dev.langchain4j.model.embedding.EmbeddingModel, AutoCloseable

java.lang.Object
org.jabref.logic.ai.embedding.AsyncEmbeddingModel

All Implemented Interfaces

java.lang.AutoCloseable

Imports

java.util.List, .Optional, .OptionalInt, javafx.beans.property.ObjectProperty, .SimpleObjectProperty, org.jabref.logic.ai.ingestion.tasks.UpdateEmbeddingModelTask, org.jabref.logic.ai.preferences.AiPreferences, org.jabref.logic.l10n.Localization, org.jabref.logic.util.NotificationService, .TaskExecutor, dev.langchain4j.data.embedding.Embedding, dev.langchain4j.data.segment.TextSegment, dev.langchain4j.model.embedding.EmbeddingModel, dev.langchain4j.model.output.Response, org.jspecify.annotations.NonNull, org.slf4j.Logger, .LoggerFactory

An EmbeddingModel that downloads/loads its underlying model asynchronously via a background task.

The constructor immediately schedules an UpdateEmbeddingModelTask. Call embedAll(List) only once the model is ready (check isPresent()).

Does not listen to any preferences; the owner is responsible for reacting to preference changes and creating a new instance if needed.

Implements AutoCloseable; close it to release the loaded model.

Field Summary

Modifier and Type	Field and Description
private boolean	closed
private String	errorWhileBuildingModel
private static final Logger	LOGGER
private final EmbeddingModelMetadataService	metadataService
private final String	modelName
private final NotificationService	notificationService
private final ObjectProperty<Optional<DeepJavaEmbeddingModel>>	predictorProperty
private final TaskExecutor	taskExecutor

Constructor Summary

Access	Constructor and Description
public	AsyncEmbeddingModel(String modelName, AiPreferences aiPreferences, NotificationService notificationService, TaskExecutor taskExecutor, EmbeddingModelMetadataService metadataService)

Method Summary

Modifier and Type	Method and Description
public synchronized void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
public dev.langchain4j.model.output.Response<@NonNull List<dev.langchain4j.data.embedding.Embedding>>	embedAll(List<dev.langchain4j.data.segment.TextSegment> list)
public String	getErrorWhileBuildingModel()
public OptionalInt	getMaxSnippetTokens()
public String	getModelName()
public boolean	hadErrorWhileBuildingModel()
public boolean	isPresent()
public void	startRebuildingTask()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

closed	back to summary
private boolean closed

errorWhileBuildingModel	back to summary
private String errorWhileBuildingModel

LOGGER	back to summary
private static final Logger LOGGER

metadataService	back to summary
private final EmbeddingModelMetadataService metadataService

modelName	back to summary
private final String modelName

notificationService	back to summary
private final NotificationService notificationService

predictorProperty	back to summary
private final ObjectProperty<Optional<DeepJavaEmbeddingModel>> predictorProperty

taskExecutor	back to summary
private final TaskExecutor taskExecutor

Constructor Detail

AsyncEmbeddingModel	back to summary
public AsyncEmbeddingModel(String modelName, AiPreferences aiPreferences, NotificationService notificationService, TaskExecutor taskExecutor, EmbeddingModelMetadataService metadataService)

Method Detail

close back to summary

close	back to summary
public synchronized void close() Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public synchronized void close()

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

embedAll	back to summary
public dev.langchain4j.model.output.Response<@NonNull List<dev.langchain4j.data.embedding.Embedding>> embedAll(List<dev.langchain4j.data.segment.TextSegment> list) Annotations @Override

getErrorWhileBuildingModel	back to summary
public String getErrorWhileBuildingModel()

getMaxSnippetTokens	back to summary
public OptionalInt getMaxSnippetTokens()

getModelName	back to summary
public String getModelName()

hadErrorWhileBuildingModel	back to summary
public boolean hadErrorWhileBuildingModel()

isPresent	back to summary
public boolean isPresent()

startRebuildingTask	back to summary
public void startRebuildingTask()