Record Class ChromaApi.QueryRequest

java.lang.Object

java.lang.Record

org.springframework.ai.chroma.vectorstore.ChromaApi.QueryRequest

Record Components:

queryEmbeddings - The embeddings to get the closes neighbors of.

nResults - The number of neighbors to return for each query_embedding or query_texts.

where - Condition to filter results based on metadata values.

include - A list of what to include in the results. Can contain "embeddings", "metadatas", "documents", "distances". Ids are always included. Defaults to [metadatas, documents, distances].

Enclosing class:

ChromaApi

public static record ChromaApi.QueryRequest(List<float[]> queryEmbeddings, Integer nResults, Map<String,Object> where, List<ChromaApi.QueryRequest.Include> include)
extends Record

Request to get the nResults nearest neighbor embeddings for provided queryEmbeddings.

Author:

Christian Tzolov, Eddú Meléndez, Jonghoon Park

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChromaApi.QueryRequest.Include

Constructor Summary

Constructors

Constructor	Description
QueryRequest(float[] queryEmbedding, Integer nResults)	Convenience to query for a single embedding instead of a batch of embeddings.
QueryRequest(float[] queryEmbedding, Integer nResults, Map<String,Object> where)
QueryRequest(List<float[]> queryEmbeddings, Integer nResults, Map<String,Object> where, List<ChromaApi.QueryRequest.Include> include)	Creates an instance of a QueryRequest record class.

Method Summary

Modifier and Type	Method	Description
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<ChromaApi.QueryRequest.Include>	include()	Returns the value of the include record component.
Integer	nResults()	Returns the value of the nResults record component.
List<float[]>	queryEmbeddings()	Returns the value of the queryEmbeddings record component.
final String	toString()	Returns a string representation of this record class.
Map<String,Object>	where()	Returns the value of the where record component.

Methods inherited from class Object

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

Constructor Details

QueryRequest

public QueryRequest(float[] queryEmbedding,
 Integer nResults)

Convenience to query for a single embedding instead of a batch of embeddings.

QueryRequest

public QueryRequest(float[] queryEmbedding,
 Integer nResults,
 @Nullable
 Map<String,Object> where)

QueryRequest

public QueryRequest(List<float[]> queryEmbeddings,
 Integer nResults,
 @Nullable
 Map<String,Object> where,
 List<ChromaApi.QueryRequest.Include> include)

Creates an instance of a QueryRequest record class.

Parameters:

queryEmbeddings - the value for the queryEmbeddings record component

nResults - the value for the nResults record component

where - the value for the where record component

include - the value for the include 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.

queryEmbeddings

public List<float[]> queryEmbeddings()

Returns the value of the queryEmbeddings record component.

Returns:

the value of the queryEmbeddings record component

nResults

public Integer nResults()

Returns the value of the nResults record component.

Returns:

the value of the nResults record component

where

@Nullable
public Map<String,Object> where()

Returns the value of the where record component.

Returns:

the value of the where record component

include

public List<ChromaApi.QueryRequest.Include> include()

Returns the value of the include record component.

Returns:

the value of the include record component