JabRef 6.0-beta.1 · org.jabref.logic.ai.ingestion.tasks.generateembeddings.GenerateEmbeddingsTaskRequest

Field Summary

Modifier and Type	Field and Description
private final BibDatabaseContext	bibDatabaseContext Record Component accessed by bibDatabaseContext().
private final DocumentSplitter	documentSplitter Record Component accessed by documentSplitter().
private final dev.langchain4j.model.embedding.EmbeddingModel	embeddingModel Record Component accessed by embeddingModel().
private final dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>	embeddingStore Record Component accessed by embeddingStore().
private final FilePreferences	filePreferences Record Component accessed by filePreferences().
private final IngestedDocumentsRepository	ingestedDocumentsRepository Record Component accessed by ingestedDocumentsRepository().
private final LinkedFile	linkedFile Record Component accessed by linkedFile().

Constructor Summary

Access	Constructor and Description
public	GenerateEmbeddingsTaskRequest(FilePreferences filePreferences, IngestedDocumentsRepository ingestedDocumentsRepository, dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> embeddingStore, dev.langchain4j.model.embedding.EmbeddingModel embeddingModel, DocumentSplitter documentSplitter, BibDatabaseContext bibDatabaseContext, LinkedFile linkedFile)

Method Summary

Modifier and Type	Method and Description
public BibDatabaseContext	bibDatabaseContext() Record Component getter of bibDatabaseContext.
public DocumentSplitter	documentSplitter() Record Component getter of documentSplitter.
public dev.langchain4j.model.embedding.EmbeddingModel	embeddingModel() Record Component getter of embeddingModel.
public dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>	embeddingStore() Record Component getter of embeddingStore.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public FilePreferences	filePreferences() Record Component getter of filePreferences.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public IngestedDocumentsRepository	ingestedDocumentsRepository() Record Component getter of ingestedDocumentsRepository.
public LinkedFile	linkedFile() Record Component getter of linkedFile.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

bibDatabaseContext	back to summary
private final BibDatabaseContext bibDatabaseContext Record Component accessed by bibDatabaseContext().

documentSplitter	back to summary
private final DocumentSplitter documentSplitter Record Component accessed by documentSplitter().

embeddingModel	back to summary
private final dev.langchain4j.model.embedding.EmbeddingModel embeddingModel Record Component accessed by embeddingModel().

embeddingStore	back to summary
private final dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> embeddingStore Record Component accessed by embeddingStore().

filePreferences	back to summary
private final FilePreferences filePreferences Record Component accessed by filePreferences().

ingestedDocumentsRepository	back to summary
private final IngestedDocumentsRepository ingestedDocumentsRepository Record Component accessed by ingestedDocumentsRepository().

linkedFile	back to summary
private final LinkedFile linkedFile Record Component accessed by linkedFile().

Constructor Detail

GenerateEmbeddingsTaskRequest	back to summary
public GenerateEmbeddingsTaskRequest(FilePreferences filePreferences, IngestedDocumentsRepository ingestedDocumentsRepository, dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> embeddingStore, dev.langchain4j.model.embedding.EmbeddingModel embeddingModel, DocumentSplitter documentSplitter, BibDatabaseContext bibDatabaseContext, LinkedFile linkedFile)

Method Detail

bibDatabaseContext	back to summary
public BibDatabaseContext bibDatabaseContext() Record Component getter of bibDatabaseContext.

documentSplitter	back to summary
public DocumentSplitter documentSplitter() Record Component getter of documentSplitter.

embeddingModel	back to summary
public dev.langchain4j.model.embedding.EmbeddingModel embeddingModel() Record Component getter of embeddingModel.

embeddingStore	back to summary
public dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> embeddingStore() Record Component getter of embeddingStore.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

filePreferences	back to summary
public FilePreferences filePreferences() Record Component getter of filePreferences.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

ingestedDocumentsRepository	back to summary
public IngestedDocumentsRepository ingestedDocumentsRepository() Record Component getter of ingestedDocumentsRepository.

linkedFile	back to summary
public LinkedFile linkedFile() Record Component getter of linkedFile.

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.