Back to Chroma

Cloudflare Workers AI

docs/mintlify/integrations/embedding-models/cloudflare-workers-ai.mdx

1.5.91.6 KB
Original Source

Chroma provides a wrapper around Cloudflare Workers AI embedding models. This embedding function runs remotely against the Cloudflare Workers AI servers, and will require an API key and a Cloudflare account. You can find more information in the Cloudflare Workers AI Docs.

You can also optionally use the Cloudflare AI Gateway for a more customized solution by setting a gateway_id argument. See the Cloudflare AI Gateway Docs for more info.

<CodeGroup>
python
from chromadb.utils.embedding_functions import CloudflareWorkersAIEmbeddingFunction

os.environ["CHROMA_CLOUDFLARE_API_KEY"] = "<INSERT API KEY HERE>"

ef = CloudflareWorkersAIEmbeddingFunction(
    account_id="<INSERT ACCOUNTID HERE>",
    model_name="@cf/baai/bge-m3",
)
ef(input=["This is my first text to embed", "This is my second document"])
typescript
// npm install @chroma-core/cloudflare-worker-ai

import { CloudflareWorkersAIEmbeddingFunction } from '@chroma-core/cloudflare-worker-ai';

process.env.CLOUDFLARE_API_KEY = "<INSERT API KEY HERE>"

const embedder = new CloudflareWorkersAIEmbeddingFunction({
    account_id="<INSERT ACCOUNT ID HERE>",
    model_name="@cf/baai/bge-m3",
});

// use directly
embedder.generate(['This is my first text to embed', 'This is my second document']);
</CodeGroup>

You must pass in an account_id and model_name to the embedding function. It is recommended to set the CHROMA_CLOUDFLARE_API_KEY for the api key, but the embedding function also optionally takes in an api_key variable.