Skip to content

Commit 3e1e513

Browse files
authored
Update API.md
1 parent ae8a65c commit 3e1e513

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

API.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A SQLite extension that provides semantic memory capabilities with hybrid search
2323
sqlite-memory enables semantic search over text content stored in SQLite. It:
2424

2525
1. **Chunks** text content using semantic parsing (markdown-aware)
26-
2. **Generates embeddings** for each chunk using the built-in llama.cpp engine (`"local"` provider) or the [vector.space](https://vector.space) remote service
26+
2. **Generates embeddings** for each chunk using the built-in llama.cpp engine (`"local"` provider) or the [vectors.space](https://vectors.space) remote service
2727
3. **Stores** embeddings and full-text content for hybrid search
2828
4. **Searches** using vector similarity combined with FTS5 full-text search
2929

@@ -77,15 +77,15 @@ Configures the embedding model to use.
7777
**Parameters:**
7878
| Parameter | Type | Description |
7979
|-----------|------|-------------|
80-
| `provider` | TEXT | `"local"` for built-in llama.cpp engine, or any other name (e.g., `"openai"`) for [vector.space](https://vector.space) remote service |
81-
| `model` | TEXT | For local: full path to GGUF model file. For remote: model identifier supported by vector.space |
80+
| `provider` | TEXT | `"local"` for built-in llama.cpp engine, or any other name (e.g., `"openai"`) for [vectors.space](https://vectors.space) remote service |
81+
| `model` | TEXT | For local: full path to GGUF model file. For remote: model identifier supported by vectors.space |
8282

8383
**Returns:** INTEGER - 1 on success
8484

8585
**Notes:**
8686
- When `provider` is `"local"`, the extension uses the built-in llama.cpp engine and verifies the model file exists
87-
- When `provider` is anything other than `"local"`, the extension uses the [vector.space](https://vector.space) remote embedding service
88-
- Remote embedding requires a free API key from [vector.space](https://vector.space) (set via `memory_set_apikey`)
87+
- When `provider` is anything other than `"local"`, the extension uses the [vectors.space](https://vectors.space) remote embedding service
88+
- Remote embedding requires a free API key from [vectors.space](https://vectors.space) (set via `memory_set_apikey`)
8989
- Settings are persisted in `dbmem_settings` table
9090
- For local models, the embedding engine is initialized immediately
9191

@@ -94,7 +94,7 @@ Configures the embedding model to use.
9494
-- Local embedding model (uses built-in llama.cpp engine)
9595
SELECT memory_set_model('local', '/path/to/nomic-embed-text-v1.5.Q8_0.gguf');
9696

97-
-- Remote embedding via vector.space (requires free API key)
97+
-- Remote embedding via vectors.space (requires free API key)
9898
SELECT memory_set_model('openai', 'text-embedding-3-small');
9999
SELECT memory_set_apikey('your-vectorspace-api-key');
100100
```
@@ -103,19 +103,19 @@ SELECT memory_set_apikey('your-vectorspace-api-key');
103103

104104
#### `memory_set_apikey(key TEXT)`
105105

106-
Sets the API key for the [vector.space](https://vector.space) remote embedding service.
106+
Sets the API key for the [vectors.space](https://vectors.space) remote embedding service.
107107

108108
**Parameters:**
109109
| Parameter | Type | Description |
110110
|-----------|------|-------------|
111-
| `key` | TEXT | API key obtained from [vector.space](https://vector.space) (free account) |
111+
| `key` | TEXT | API key obtained from [vectors.space](https://vectors.space) (free account) |
112112

113113
**Returns:** INTEGER - 1 on success
114114

115115
**Notes:**
116116
- API key is stored in memory only, not persisted to disk
117117
- Required when using any provider other than `"local"`
118-
- Get a free API key by creating an account at [vector.space](https://vector.space)
118+
- Get a free API key by creating an account at [vectors.space](https://vectors.space)
119119

120120
**Example:**
121121
```sql
@@ -378,7 +378,7 @@ AND context = 'meetings';
378378

379379
| Option | Type | Default | Description |
380380
|--------|------|---------|-------------|
381-
| `provider` | TEXT | - | Embedding provider (`"local"` for llama.cpp, otherwise vector.space) |
381+
| `provider` | TEXT | - | Embedding provider (`"local"` for llama.cpp, otherwise vectors.space) |
382382
| `model` | TEXT | - | Model path (local) or identifier (remote) |
383383
| `dimension` | INTEGER | - | Embedding dimension (auto-detected) |
384384
| `max_tokens` | INTEGER | 400 | Maximum tokens per chunk |
@@ -529,7 +529,7 @@ LIMIT 10;
529529
|--------|-------------|
530530
| `DBMEM_OMIT_IO` | Omit file/directory functions (for WASM) |
531531
| `DBMEM_OMIT_LOCAL_ENGINE` | Omit llama.cpp local engine (for remote-only builds) |
532-
| `DBMEM_OMIT_REMOTE_ENGINE` | Omit vector.space remote engine (for local-only builds) |
532+
| `DBMEM_OMIT_REMOTE_ENGINE` | Omit vectors.space remote engine (for local-only builds) |
533533
| `SQLITE_CORE` | Compile as part of SQLite core (not as loadable extension) |
534534

535535
---

0 commit comments

Comments
 (0)