Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.ai.embedding

public final Record EmbeddingModelMetadata

extends Record
Class Inheritance
Annotations
@NullMarked
Record Components
modelName:String 
downloadSizeBytes:OptionalLong 
maxSnippetTokens:OptionalInt 
Imports
java.util.OptionalInt, .OptionalLong, org.jspecify.annotations.NullMarked

Metadata for an AI embedding model, including its model name, download size, and maximum input snippet / sequence length in tokens.

Field Summary

Modifier and TypeField and Description
private final OptionalLong
downloadSizeBytes

Record Component accessed by downloadSizeBytes().

private final OptionalInt
maxSnippetTokens

Record Component accessed by maxSnippetTokens().

private final String
modelName

Record Component accessed by modelName().

Constructor Summary

AccessConstructor and Description
public
EmbeddingModelMetadata(String modelName, OptionalLong downloadSizeBytes, OptionalInt maxSnippetTokens)

Method Summary

Modifier and TypeMethod and Description
public OptionalLong
downloadSizeBytes()

Record Component getter of downloadSizeBytes.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public OptionalInt
maxSnippetTokens()

Record Component getter of maxSnippetTokens.

public String
modelName()

Record Component getter of modelName.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

downloadSizeBytesback to summary
private final OptionalLong downloadSizeBytes

Record Component accessed by downloadSizeBytes().

maxSnippetTokensback to summary
private final OptionalInt maxSnippetTokens

Record Component accessed by maxSnippetTokens().

modelNameback to summary
private final String modelName

Record Component accessed by modelName().

Constructor Detail

EmbeddingModelMetadataback to summary
public EmbeddingModelMetadata(String modelName, OptionalLong downloadSizeBytes, OptionalInt maxSnippetTokens)

Method Detail

downloadSizeBytesback to summary
public OptionalLong downloadSizeBytes()

Record Component getter of downloadSizeBytes.

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

maxSnippetTokensback to summary
public OptionalInt maxSnippetTokens()

Record Component getter of maxSnippetTokens.

modelNameback to summary
public String modelName()

Record Component getter of modelName.

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