Skip to main content

Chroma

Prerequisite​

You need a Chroma server. You can:

  1. Install Chroma CLI and run the server using chroma run
  2. Sign up for Chroma Cloud.
  3. Deploy your own Chroma instance in Docker.

Setup​

InputDescriptionDefaultCloud
DocumentCan be connected with nodes from Document Loader
EmbeddingsCan be connected with nodes from Embeddings
Collection NameChroma collection name. Refer to here for naming convention
Chroma URLSpecify the URL of your chroma instancehttp://localhost:8000https://api.trychroma.com:8000

For Chroma Cloud, you will need to get your tenant ID, and create your database and API key.

Additional​

If you are running both CiniterFlow and Chroma on Docker, there are additional steps involved.

  1. Spin up Chroma docker first
docker compose up -d --build
  1. Open docker-compose.yml in CiniterFlow
cd CiniterFlow && cd docker
  1. Modify the file to:
version: '3.1'

services:
    ciniterflow:
        image: ciniterflowai/ciniterflow
        restart: always
        environment:
            - PORT=$`{PORT}`
            - DEBUG=$`{DEBUG}`
            - DATABASE_PATH=$`{DATABASE_PATH}`
            - SECRETKEY_PATH=$`{SECRETKEY_PATH}`
            - CINITERFLOW_SECRETKEY_OVERWRITE=$`{CINITERFLOW_SECRETKEY_OVERWRITE}`
            - LOG_PATH=$`{LOG_PATH}`
            - LOG_LEVEL=$`{LOG_LEVEL}`
            - EXECUTION_MODE=$`{EXECUTION_MODE}`
        ports:
            - '$`{PORT}`:$`{PORT}`'
        volumes:
            - ~/.ciniterflow:/root/.ciniterflow
        networks:
            - ciniterflow_net
        command: /bin/sh -c "sleep 3; ciniterflow start"
networks:
    ciniterflow_net:
        name: chroma_net
        external: true
  1. Spin up CiniterFlow docker image
docker compose up -d
  1. On the Chroma URL, for Windows and MacOS Operating Systems specify http://host.docker.internal:8000. For Linux based systems the default docker gateway should be used since host.docker.internal is not available: http://172.17.0.1:8000

Resources​