Record Class ChromaApi.QueryResponse

java.lang.Object

java.lang.Record

org.springframework.ai.chroma.vectorstore.ChromaApi.QueryResponse

Record Components:

ids - List of list of document ids. One for each returned document.

embeddings - List of list of document embeddings. One for each returned document.

documents - List of list of document contents. One for each returned document.

metadata - List of list of document metadata. One for each returned document.

distances - List of list of search distances. One for each returned document.

Enclosing class:

ChromaApi

public static record ChromaApi.QueryResponse(List<List<String>> ids, List<List<float[]>> embeddings, List<List<String>> documents, List<List<Map<String,Object>>> metadata, List<List<Double>> distances)
extends Record

A QueryResponse object containing the query results.

Author:

Christian Tzolov, Eddú Meléndez, Jonghoon Park

Constructor Summary

Constructors

Constructor	Description
QueryResponse(List<List<String>> ids, List<List<float[]>> embeddings, List<List<String>> documents, List<List<Map<String,Object>>> metadata, List<List<Double>> distances)	Creates an instance of a QueryResponse record class.

Method Summary

Modifier and Type	Method	Description
List<List<Double>>	distances()	Returns the value of the distances record component.
List<List<String>>	documents()	Returns the value of the documents record component.
List<List<float[]>>	embeddings()	Returns the value of the embeddings 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<List<String>>	ids()	Returns the value of the ids record component.
List<List<Map<String,Object>>>	metadata()	Returns the value of the metadata record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

QueryResponse

public QueryResponse(List<List<String>> ids,
 List<List<float[]>> embeddings,
 List<List<String>> documents,
 List<List<Map<String,Object>>> metadata,
 List<List<Double>> distances)

Creates an instance of a QueryResponse record class.

Parameters:

ids - the value for the ids record component

embeddings - the value for the embeddings record component

documents - the value for the documents record component

metadata - the value for the metadata record component

distances - the value for the distances record component

Method Details

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.

ids

public List<List<String>> ids()

Returns the value of the ids record component.

Returns:

the value of the ids record component

embeddings

public List<List<float[]>> embeddings()

Returns the value of the embeddings record component.

Returns:

the value of the embeddings record component

documents

public List<List<String>> documents()

Returns the value of the documents record component.

Returns:

the value of the documents record component

metadata

public List<List<Map<String,Object>>> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component

distances

public List<List<Double>> distances()

Returns the value of the distances record component.

Returns:

the value of the distances record component