Chroma¶
Since v0.29.0
Introduction¶
The Testcontainers module for Chroma.
Resources¶
- Chroma Docs - Chroma official documentation.
- Chroma Cookbook - Community-driven Chroma cookbook.
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¶
- Since v0.32.0
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¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Not available until the next release mainWithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Not available until the next release mainWithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Not available until the next release mainWithAdditionalLifecycleHooks
Not available until the next release mainWithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Not available until the next release mainWithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Not available until the next release mainWithImageSubstitutors
Since v0.26.0WithImagePlatform
Not available until the next release main
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Not available until the next release mainWithBridgeNetwork
Not available until the next release mainWithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Not available until the next release mainWithNoStart
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The Chroma container exposes the following methods:
REST Endpoint¶
- Since v0.29.0
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")