d803bfe2b1
git-subtree-dir: vendor/ruvector git-subtree-split: b64c21726f2bb37286d9ee36a7869fef60cc6900
90 lines
2.1 KiB
Markdown
90 lines
2.1 KiB
Markdown
# Embeddings Module - Quick Start Guide
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install ruvector-extensions
|
|
|
|
# Install your preferred provider SDK:
|
|
npm install openai # For OpenAI
|
|
npm install cohere-ai # For Cohere
|
|
npm install @xenova/transformers # For local models
|
|
```
|
|
|
|
## 30-Second Start
|
|
|
|
```typescript
|
|
import { OpenAIEmbeddings } from 'ruvector-extensions';
|
|
|
|
const embedder = new OpenAIEmbeddings({
|
|
apiKey: process.env.OPENAI_API_KEY,
|
|
});
|
|
|
|
const embedding = await embedder.embedText('Hello, world!');
|
|
console.log('Embedding:', embedding.length, 'dimensions');
|
|
```
|
|
|
|
## 5-Minute Integration with VectorDB
|
|
|
|
```typescript
|
|
import { VectorDB } from 'ruvector';
|
|
import { OpenAIEmbeddings, embedAndInsert } from 'ruvector-extensions';
|
|
|
|
// 1. Initialize
|
|
const embedder = new OpenAIEmbeddings({ apiKey: 'sk-...' });
|
|
const db = new VectorDB({ dimension: embedder.getDimension() });
|
|
|
|
// 2. Prepare documents
|
|
const documents = [
|
|
{
|
|
id: '1',
|
|
text: 'Machine learning is fascinating',
|
|
metadata: { category: 'AI' }
|
|
},
|
|
{
|
|
id: '2',
|
|
text: 'Deep learning uses neural networks',
|
|
metadata: { category: 'AI' }
|
|
}
|
|
];
|
|
|
|
// 3. Embed and insert
|
|
await embedAndInsert(db, embedder, documents);
|
|
|
|
// 4. Search
|
|
const results = await embedAndSearch(
|
|
db,
|
|
embedder,
|
|
'What is deep learning?',
|
|
{ topK: 5 }
|
|
);
|
|
|
|
console.log('Results:', results);
|
|
```
|
|
|
|
## Provider Comparison
|
|
|
|
| Provider | Best For | Dimension | API Key |
|
|
|----------|----------|-----------|---------|
|
|
| OpenAI | General purpose | 1536-3072 | ✅ |
|
|
| Cohere | Search optimization | 1024 | ✅ |
|
|
| HuggingFace | Privacy/offline | 384+ | ❌ |
|
|
|
|
## Next Steps
|
|
|
|
- 📚 Read the [full documentation](./docs/EMBEDDINGS.md)
|
|
- 💡 Explore [11 examples](./src/examples/embeddings-example.ts)
|
|
- 🧪 Run the [test suite](./tests/embeddings.test.ts)
|
|
|
|
## File Locations
|
|
|
|
- **Main Module**: `/src/embeddings.ts`
|
|
- **Documentation**: `/docs/EMBEDDINGS.md`
|
|
- **Examples**: `/src/examples/embeddings-example.ts`
|
|
- **Tests**: `/tests/embeddings.test.ts`
|
|
- **Summary**: `/docs/EMBEDDINGS_SUMMARY.md`
|
|
|
|
---
|
|
|
|
✅ **Status**: Production-ready and fully tested!
|