org.jabref.model.ai.chatting

public final Record ChatMessage

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.model.ai.chatting.ChatMessage

Record Components

id:String
timestamp:Instant
role:ChatMessage.Role
content:String
relevantInformation:List<RelevantInformation>

Imports

java.time.Instant, java.util.List, .Optional, .UUID, org.jabref.model.ai.pipeline.RelevantInformation, com.fasterxml.jackson.annotation.JsonCreator, .JsonProperty, dev.langchain4j.data.message.AiMessage, dev.langchain4j.data.message.SystemMessage, dev.langchain4j.data.message.UserMessage

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	ChatMessage.Role

Field Summary

Modifier and Type	Field and Description
private final String	content Record Component accessed by content().
private final String	id Record Component accessed by id().
private final List<RelevantInformation>	relevantInformation Record Component accessed by relevantInformation().
private final ChatMessage.Role	role Record Component accessed by role().
private final Instant	timestamp Record Component accessed by timestamp().

Constructor Summary

Access	Constructor and Description
public	ChatMessage(String id, Instant timestamp, ChatMessage.Role role, String content, List<RelevantInformation> relevantInformation)

Method Summary

Modifier and Type	Method and Description
public static ChatMessage	aiMessage(String content, List<RelevantInformation> relevantInformation)
public String	content() Record Component getter of content.
private static ChatMessage	dummyChatMessage(ChatMessage.Role role, String content, Instant timestamp, List<RelevantInformation> relevantInformation)
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public static ChatMessage	errorMessage(Throwable throwable)
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public String	id() Record Component getter of id.
public List<RelevantInformation>	relevantInformation() Record Component getter of relevantInformation.
public ChatMessage.Role	role() Record Component getter of role.
public static ChatMessage	systemMessage(String content)
public static ChatMessage	systemMessage(Instant timestamp, String content)
public Instant	timestamp() Record Component getter of timestamp.
public Optional<dev.langchain4j.data.message.ChatMessage>	toLangChainMessage()
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public static ChatMessage	userMessage(String content)
public static ChatMessage	userMessage(Instant timestamp, String content)

Field Detail

content	back to summary
private final String content Record Component accessed by content().

id	back to summary
private final String id Record Component accessed by id().

relevantInformation	back to summary
private final List<RelevantInformation> relevantInformation Record Component accessed by relevantInformation().

role	back to summary
private final ChatMessage.Role role Record Component accessed by role().

timestamp	back to summary
private final Instant timestamp Record Component accessed by timestamp().

Constructor Detail

ChatMessage	back to summary
public ChatMessage(String id, Instant timestamp, ChatMessage.Role role, String content, List<RelevantInformation> relevantInformation) Annotations @JsonCreator

Method Detail

aiMessage	back to summary
public static ChatMessage aiMessage(String content, List<RelevantInformation> relevantInformation)

content	back to summary
public String content() Record Component getter of content.

dummyChatMessage	back to summary
private static ChatMessage dummyChatMessage(ChatMessage.Role role, String content, Instant timestamp, List<RelevantInformation> relevantInformation)

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

errorMessage	back to summary
public static ChatMessage errorMessage(Throwable throwable)

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.

id	back to summary
public String id() Record Component getter of id.

relevantInformation	back to summary
public List<RelevantInformation> relevantInformation() Record Component getter of relevantInformation.

role	back to summary
public ChatMessage.Role role() Record Component getter of role.

systemMessage	back to summary
public static ChatMessage systemMessage(String content)

systemMessage	back to summary
public static ChatMessage systemMessage(Instant timestamp, String content)

timestamp	back to summary
public Instant timestamp() Record Component getter of timestamp.

toLangChainMessage	back to summary
public Optional<dev.langchain4j.data.message.ChatMessage> toLangChainMessage()

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.

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.

userMessage	back to summary
public static ChatMessage userMessage(String content)

userMessage	back to summary
public static ChatMessage userMessage(Instant timestamp, String content)

org.jabref.model.ai.chatting back to summary

public final Enum ChatMessage.Role