Verified Owner
Top Description Fields Constructors Methods
org.jabref.model.ai

public final Record AiMetadata

extends Record
Class Inheritance
Record Components
aiProvider:AiProvider 
model:String 
timestamp:Instant 
Imports
java.time.Instant, org.jabref.model.ai.llm.AiProvider, com.fasterxml.jackson.annotation.JsonCreator, .JsonProperty
Metadata about the AI model used to produce a particular result.

This record is passed to all exporter implementations so that outputs can include provenance information (which provider and model generated the content, and when).

Field Summary

Modifier and TypeField and Description
private final AiProvider
aiProvider

Record Component accessed by aiProvider().

private final String
model

Record Component accessed by model().

private final Instant
timestamp

Record Component accessed by timestamp().

Constructor Summary

AccessConstructor and Description
public
AiMetadata(AiProvider aiProvider, String model, Instant timestamp)

Method Summary

Modifier and TypeMethod and Description
public AiProvider
aiProvider()

Record Component getter of aiProvider.

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 String
model()

Record Component getter of model.

public Instant
timestamp()

Record Component getter of timestamp.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

aiProviderback to summary
private final AiProvider aiProvider

Record Component accessed by aiProvider().

modelback to summary
private final String model

Record Component accessed by model().

timestampback to summary
private final Instant timestamp

Record Component accessed by timestamp().

Constructor Detail

AiMetadataback to summary
public AiMetadata(AiProvider aiProvider, String model, Instant timestamp)
Annotations
@JsonCreator

Method Detail

aiProviderback to summary
public AiProvider aiProvider()

Record Component getter of aiProvider.

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.

modelback to summary
public String model()

Record Component getter of model.

timestampback to summary
public Instant timestamp()

Record Component getter of timestamp.

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.