Record Class ChromaApi.AddEmbeddingsRequest

java.lang.Object

java.lang.Record

org.springframework.ai.chroma.vectorstore.ChromaApi.AddEmbeddingsRequest

Record Components:

ids - The ids of the embeddings to add.

embeddings - The embeddings to add.

metadata - The metadata to associate with the embeddings. When querying, you can filter on this metadata.

documents - The documents contents to associate with the embeddings.

Enclosing class:

ChromaApi

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

Add embeddings to the chroma data store.

Author:

Christian Tzolov, Eddú Meléndez, Jonghoon Park

Constructor Summary

Constructors

Constructor	Description
AddEmbeddingsRequest(String id, float[] embedding, Map<String,Object> metadata, String document)
AddEmbeddingsRequest(List<String> ids, List<float[]> embeddings, List<Map<String,Object>> metadata, List<String> documents)	Creates an instance of a AddEmbeddingsRequest record class.

Method Summary

Modifier and Type	Method	Description
List<String>	documents()	Returns the value of the documents record component.
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<String>	ids()	Returns the value of the ids record component.
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

AddEmbeddingsRequest

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

Creates an instance of a AddEmbeddingsRequest record class.

Parameters:

ids - the value for the ids record component

embeddings - the value for the embeddings record component

metadata - the value for the metadata record component

documents - the value for the documents record component

AddEmbeddingsRequest

public AddEmbeddingsRequest(String id,
 float[] embedding,
 Map<String,Object> metadata,
 String document)

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

Returns the value of the ids record component.

Returns:

the value of the ids record component

embeddings

public List<float[]> embeddings()

Returns the value of the embeddings record component.

Returns:

the value of the embeddings record component

metadata

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

Returns the value of the metadata record component.

Returns:

the value of the metadata record component

documents

public List<String> documents()

Returns the value of the documents record component.

Returns:

the value of the documents record component