Class Chroma

constructor

• new Chroma(embeddings, args): Chroma

• Parameters

  • embeddings: EmbeddingsInterface

  • args: ChromaLibArgs

  Returns Chroma

FilterType

collectionName

url

Optional collection

Optional collectionMetadata

Optional filter

Optional index

Optional numDimensions

addDocuments

• addDocuments(documents, options?): Promise<string[]>

• Adds documents to the Chroma database. The documents are first converted to vectors using the embeddings instance, and then added to the database.

  Parameters

  • documents: Document<Record<string, any>>[]

    An array of Document instances to be added to the database.

  • Optional options: {
        ids?: string[];
    }

    Optional. An object containing an array of ids for the documents.

    • Optional ids?: string[]

  Returns Promise<string[]>

  A promise that resolves when the documents have been added to the database.

addVectors

• addVectors(vectors, documents, options?): Promise<string[]>

• Adds vectors to the Chroma database. The vectors are associated with the provided documents.

  Parameters

  • vectors: number[][]

    An array of vectors to be added to the database.

  • documents: Document<Record<string, any>>[]

    An array of Document instances associated with the vectors.

  • Optional options: {
        ids?: string[];
    }

    Optional. An object containing an array of ids for the vectors.

    • Optional ids?: string[]

  Returns Promise<string[]>

  A promise that resolves with an array of document IDs when the vectors have been added to the database.

delete

• delete(params): Promise<void>

• Deletes documents from the Chroma database. The documents to be deleted can be specified by providing an array of ids or a filter object.

  Parameters

  • params: ChromaDeleteParams<Where>

    An object containing either an array of ids of the documents to be deleted or a filter object to specify the documents to be deleted.

  Returns Promise<void>

  A promise that resolves when the specified documents have been deleted from the database.

ensureCollection

• ensureCollection(): Promise<Collection>

• Ensures that a collection exists in the Chroma database. If the collection does not exist, it is created.

  Returns Promise<Collection>

  A promise that resolves with the Collection instance.

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>

• Searches for vectors in the Chroma database that are similar to the provided query vector. The search can be filtered using the provided filter object or the filter property of the Chroma instance.

  Parameters

  • query: number[]

    The query vector.

  • k: number

    The number of similar vectors to return.

  • Optional filter: BaseWhere | LogicalWhere

    Optional. A filter object to filter the search results.

  Returns Promise<[Document<Record<string, any>>, number][]>

  A promise that resolves with an array of tuples, each containing a Document instance and a similarity score.

Static fromDocuments

• fromDocuments(docs, embeddings, dbConfig): Promise<Chroma>

• Creates a new Chroma instance from an array of Document instances. The documents are added to the Chroma database.

  Parameters

  • docs: Document<Record<string, any>>[]

    An array of Document instances.

  • embeddings: EmbeddingsInterface

    An Embeddings instance used to generate embeddings for the documents.

  • dbConfig: ChromaLibArgs

    A ChromaLibArgs object containing the configuration for the Chroma database.

  Returns Promise<Chroma>

  A promise that resolves with a new Chroma instance.

Static fromExistingCollection

• fromExistingCollection(embeddings, dbConfig): Promise<Chroma>

• Creates a new Chroma instance from an existing collection in the Chroma database.

  Parameters

  • embeddings: EmbeddingsInterface

    An Embeddings instance used to generate embeddings for the documents.

  • dbConfig: ChromaLibArgs

    A ChromaLibArgs object containing the configuration for the Chroma database.

  Returns Promise<Chroma>

  A promise that resolves with a new Chroma instance.

Static fromTexts

• fromTexts(texts, metadatas, embeddings, dbConfig): Promise<Chroma>

• Creates a new Chroma instance from an array of text strings. The text strings are converted to Document instances and added to the Chroma database.

  Parameters

  • texts: string[]

    An array of text strings.

  • metadatas: object | object[]

    An array of metadata objects or a single metadata object. If an array is provided, it must have the same length as the texts array.

  • embeddings: EmbeddingsInterface

    An Embeddings instance used to generate embeddings for the documents.

  • dbConfig: ChromaLibArgs

    A ChromaLibArgs object containing the configuration for the Chroma database.

  Returns Promise<Chroma>

  A promise that resolves with a new Chroma instance.

Static imports

• imports(): Promise<{
      ChromaClient: typeof ChromaClient;
  }>

• Imports the ChromaClient from the chromadb module.

  Returns Promise<{
      ChromaClient: typeof ChromaClient;
  }>

  A promise that resolves with an object containing the ChromaClient constructor.