Skip to content

Chroma

Since v0.29.0

Introduction

The Testcontainers module for Chroma.

Resources

Adding this module to your project dependencies

Please run the following command to add the Chroma module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/chroma

Usage example

ctx := context.Background()

chromaContainer, err := chroma.Run(ctx, "chromadb/chroma:0.4.24")
defer func() {
    if err := testcontainers.TerminateContainer(chromaContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Module Reference

Run function

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The Chroma module exposes one entrypoint function to create the Chroma container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*ChromaContainer, error)
  • context.Context, the Go context.
  • string, the Docker image to use.
  • testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "chromadb/chroma:0.4.24").

Container Options

When starting the Chroma container, you can pass options in a variadic way to configure it.

The following options are exposed by the testcontainers package.

Basic Options

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

The Chroma container exposes the following methods:

REST Endpoint

This method returns the REST endpoint of the Chroma container, using the default 8000 port.

        restEndpoint, err := ctr.RESTEndpoint(ctx)

  

        endpoint, err := ctr.RESTEndpoint(context.Background())
        require.NoErrorf(tt, err, "failed to get REST endpoint")
        chromaClient, err := chromago.NewClient(endpoint)

Examples

Getting a Chroma client

The following example demonstrates how to create a Chroma client using the Chroma module.

First of all, you need to import the Chroma module and the Swagger client:

import (
    chromago "github.com/amikos-tech/chroma-go"
    "github.com/amikos-tech/chroma-go/types"
)

Then, you can create a Chroma client using the Chroma module:

// create the client connection and confirm that we can access the server with it
endpoint, err := chromaContainer.RESTEndpoint(context.Background())
if err != nil {
    log.Printf("failed to get REST endpoint: %s", err)
    return
}
chromaClient, err := chromago.NewClient(endpoint)

Working with Collections

// for testing we use a dummy hashing function NewConsistentHashEmbeddingFunction
col, err := chromaClient.CreateCollection(context.Background(), "test-collection", map[string]any{}, true, types.NewConsistentHashEmbeddingFunction(), types.L2)
cols, err := chromaClient.ListCollections(context.Background())
// verify it's possible to add data to the collection
col1, err := col.Add(
    context.Background(),
    nil,                                      // embeddings
    []map[string]any{},                       // metadata
    []string{"test-doc-1", "test-doc-2"},     // documents
    []string{"test-label-1", "test-label-2"}, // ids
)
// verify it's possible to query the collection
queryResults, err := col1.QueryWithOptions(
    context.Background(),
    types.WithQueryTexts([]string{"test-doc-1"}),
    types.WithInclude(types.IDocuments, types.IEmbeddings, types.IMetadatas),
    types.WithNResults(1),
)
_, err = chromaClient.DeleteCollection(context.Background(), "test-collection")