44 lines
1.4 KiB
Markdown
44 lines
1.4 KiB
Markdown
# hyper-p2p-semantic-vector-index
|
|
|
|
HyperP2PSemanticVectorIndex Novel, production-grade semantic vector indexing and similarity search primitive for Bare/Pear P2P applications. Features:
|
|
|
|
**Category:** Indexes & search
|
|
|
|
**Composes with:** `hyper-spatial-index`, `hyper-p2p-intent-router`
|
|
|
|
**Protocol:** `hyper-p2p-semantic-vector-index/v1`
|
|
|
|
## When to use
|
|
|
|
Multi-peer apps that need indexes & search over a shared Hyperswarm topic.
|
|
|
|
## When not to use
|
|
|
|
Single-process tools with no P2P topic (use local APIs only or skip `ready()`).
|
|
|
|
## Quick start
|
|
|
|
```js
|
|
const HyperP2PSemanticVectorIndex = require('hyper-p2p-semantic-vector-index')
|
|
const index = new HyperP2PSemanticVectorIndex({ dimension: 128, topic: process.argv[2] })
|
|
const id = await index.insert([/* normalized vector */], { tags: ['docs'] })
|
|
const hits = await index.search([/* query */], 5, { minSimilarity: 0.7 })
|
|
console.log(id, hits)
|
|
await index.close()
|
|
```
|
|
|
|
## Docs
|
|
|
|
- [docs/api.md](docs/api.md) — constructor, methods, events, errors
|
|
- [docs/architecture.md](docs/architecture.md) — wire types, state, composition
|
|
- [../_shared/PRODUCTION.md](../../_shared/PRODUCTION.md) — production checklist
|
|
- [../_shared/DOC_STANDARDS.md](../../_shared/DOC_STANDARDS.md) — documentation standards
|
|
|
|
- Integration: [`../../real_tests/integration/`](../../../real_tests/integration/) — `semantic-vector-index-two-node.js`
|
|
|
|
## Test
|
|
|
|
```bash
|
|
npm install && npm test
|
|
```
|