Loading source
Pulling the file list, source metadata, and syntax-aware rendering for this listing.
Source from repo
Comprehensive Cloudflare platform skill covering Workers, D1, R2, KV, AI, Durable Objects, and security.
Files
Skill
Size
Entrypoint
Format
Open file
Syntax-highlighted preview of this file as included in the skill package.
references/vectorize/patterns.md
1# Vectorize Patterns23## Workers AI Integration45```typescript6// Generate embedding + query7const result = await env.AI.run("@cf/baai/bge-base-en-v1.5", { text: [query] });8const matches = await env.VECTORIZE.query(result.data[0], { topK: 5 }); // Pass data[0]!9```1011| Model | Dimensions |12|-------|------------|13| `@cf/baai/bge-small-en-v1.5` | 384 |14| `@cf/baai/bge-base-en-v1.5` | 768 (recommended) |15| `@cf/baai/bge-large-en-v1.5` | 1024 |1617## OpenAI Integration1819```typescript20const response = await openai.embeddings.create({ model: "text-embedding-ada-002", input: query });21const matches = await env.VECTORIZE.query(response.data[0].embedding, { topK: 5 });22```2324## RAG Pattern2526```typescript27// 1. Embed query28const emb = await env.AI.run("@cf/baai/bge-base-en-v1.5", { text: [query] });2930// 2. Search vectors31const matches = await env.VECTORIZE.query(emb.data[0], { topK: 5, returnMetadata: "indexed" });3233// 3. Fetch full docs from R2/D1/KV34const docs = await Promise.all(matches.matches.map(m => env.R2.get(m.metadata.key).then(o => o?.text())));3536// 4. Generate with context37const answer = await env.AI.run("@cf/meta/llama-3-8b-instruct", {38prompt: `Context:\n${docs.filter(Boolean).join("\n\n")}\n\nQuestion: ${query}\n\nAnswer:`39});40```4142## Multi-Tenant4344### Namespaces (< 50K tenants, fastest)4546```typescript47await env.VECTORIZE.upsert([{ id: "1", values: emb, namespace: `tenant-${id}` }]);48await env.VECTORIZE.query(vec, { namespace: `tenant-${id}`, topK: 10 });49```5051### Metadata Filter (> 50K tenants)5253```bash54wrangler vectorize create-metadata-index my-index --property-name=tenantId --type=string55```5657```typescript58await env.VECTORIZE.upsert([{ id: "1", values: emb, metadata: { tenantId: id } }]);59await env.VECTORIZE.query(vec, { filter: { tenantId: id }, topK: 10 });60```6162## Hybrid Search6364```typescript65const matches = await env.VECTORIZE.query(vec, {66topK: 20,67filter: {68category: { $in: ["tech", "science"] },69published: { $gte: lastMonthTimestamp }70}71});72```7374## Batch Ingestion7576```typescript77const BATCH = 500;78for (let i = 0; i < vectors.length; i += BATCH) {79await env.VECTORIZE.upsert(vectors.slice(i, i + BATCH));80}81```8283## Best Practices84851. **Pass `data[0]`** not `data` or full response862. **Batch 500** vectors per upsert873. **Create metadata indexes** before inserting884. **Use namespaces** for tenant isolation (faster than filters)895. **`returnMetadata: "indexed"`** for best speed/data balance906. **Handle 5-10s mutation delay** in async operations91