Package org.springframework.ai.chroma

Record Class ChromaApi.GetEmbeddingsRequest

java.lang.Object
java.lang.Record
org.springframework.ai.chroma.ChromaApi.GetEmbeddingsRequest
Record Components:
ids - IDs of the embeddings to get.
where - Condition to filter results based on metadata values.
limit - Limit on the number of collection embeddings to get.
offset - Offset on the embeddings to get.
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.GetEmbeddingsRequest(List<String> ids, Map<String,Object> where, int limit, int offset, List<ChromaApi.QueryRequest.Include> include) extends Record
Get embeddings from a collection.

  • Constructor Details

    • GetEmbeddingsRequest

      public GetEmbeddingsRequest(List<String> ids)

    • GetEmbeddingsRequest

      public GetEmbeddingsRequest(List<String> ids, Map<String,Object> where)

    • GetEmbeddingsRequest

      public GetEmbeddingsRequest(List<String> ids, Map<String,Object> where, int limit, int offset)

    • GetEmbeddingsRequest

      public GetEmbeddingsRequest(List<String> ids, Map<String,Object> where, int limit, int offset, List<ChromaApi.QueryRequest.Include> include)
      Creates an instance of a GetEmbeddingsRequest record class.
      Parameters:
      ids - the value for the ids record component
      where - the value for the where record component
      limit - the value for the limit record component
      offset - the value for the offset 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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

    • where

      public Map<String,Object> where()
      Returns the value of the where record component.
      Returns:
      the value of the where record component

    • limit

      public int limit()
      Returns the value of the limit record component.
      Returns:
      the value of the limit record component

    • offset

      public int offset()
      Returns the value of the offset record component.
      Returns:
      the value of the offset 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