Package org.springframework.ai.rag

Record Class Query

java.lang.Object

java.lang.Record

org.springframework.ai.rag.Query

Record Components:

text - the text of the query

history - the messages in the conversation history

context - the context of the query

public record Query(String text, List<Message> history, Map<String,Object> context)
extends Record

Represents a query in the context of a Retrieval Augmented Generation (RAG) flow.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Query.Builder

Constructor Summary

Constructors

Constructor	Description
Query(String text)
Query(String text, List<Message> history, Map<String,Object> context)	Creates an instance of a Query record class.

Method Summary

Modifier and Type	Method	Description
static Query.Builder	builder()
Map<String,Object>	context()	Returns the value of the context record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<Message>	history()	Returns the value of the history record component.
Query.Builder	mutate()
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Query

public Query(String text,
 List<Message> history,
 Map<String,Object> context)

Creates an instance of a Query record class.

Parameters:

text - the value for the text record component

history - the value for the history record component

context - the value for the context record component

Query

public Query(String text)

Method Details

mutate

public Query.Builder mutate()

builder

public static Query.Builder builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

history

public List<Message> history()

Returns the value of the history record component.

Returns:

the value of the history record component

context

public Map<String,Object> context()

Returns the value of the context record component.

Returns:

the value of the context record component