1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
|
---
title: "Memories Search (/v4/search)"
description: "Minimal-latency search optimized for chatbots and conversational AI"
---
Memories search (`POST /v4/search`) provides minimal-latency search optimized for real-time interactions. This endpoint prioritizes speed over extensive control, making it perfect for chatbots, Q&A systems, and any application where users expect immediate responses.
## Basic Search
<Tabs>
<Tab title="TypeScript">
```typescript
import Supermemory from 'supermemory';
const client = new Supermemory({
apiKey: process.env.SUPERMEMORY_API_KEY!
});
const results = await client.search.memories({
q: "machine learning applications",
limit: 5
});
console.log(results)
```
</Tab>
<Tab title="Python">
```python
from supermemory import Supermemory
import os
client = Supermemory(api_key=os.environ.get("SUPERMEMORY_API_KEY"))
results = client.search.memories(
q="machine learning applications",
limit=5
)
console.log(results)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "machine learning applications",
"limit": 5
}'
```
</Tab>
</Tabs>
**Sample Output:**
```json
{
"results": [
{
"id": "mem_ml_apps_2024",
"memory": "Machine learning applications span numerous industries including healthcare (diagnostic imaging, drug discovery), finance (fraud detection, algorithmic trading), autonomous vehicles (computer vision, path planning), and natural language processing (chatbots, translation services).",
"similarity": 0.92,
"title": "Machine Learning Industry Applications",
"type": "text",
"metadata": {
"topic": "machine-learning",
"industry": "technology",
"created": "2024-01-10"
}
},
{
"id": "mem_ml_healthcare",
"memory": "In healthcare, machine learning enables early disease detection through medical imaging analysis, personalized treatment recommendations, and drug discovery acceleration by predicting molecular behavior.",
"similarity": 0.89,
"title": "ML in Healthcare",
"type": "text"
}
],
"total": 8,
"timing": 87
}
```
## Container Tag Filtering
Filter by user, project, or organization:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "project updates",
containerTag: "user_123", // Note: singular, not plural
limit: 10
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="project updates",
container_tag="user_123", # Note: singular, not plural
limit=10
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "project updates",
"containerTag": "user_123",
"limit": 10
}'
```
</Tab>
</Tabs>
## Threshold Control
Control result quality with similarity threshold:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "artificial intelligence research",
threshold: 0.7, // Higher = fewer, more similar results
limit: 10
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="artificial intelligence research",
threshold=0.7, # Higher = fewer, more similar results
limit=10
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "artificial intelligence research",
"threshold": 0.7,
"limit": 10
}'
```
</Tab>
</Tabs>
## Reranking
Improve result quality with secondary ranking:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "quantum computing breakthrough",
rerank: true, // Better relevance, slight latency increase
limit: 5
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="quantum computing breakthrough",
rerank=True, # Better relevance, slight latency increase
limit=5
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "quantum computing breakthrough",
"rerank": true,
"limit": 5
}'
```
</Tab>
</Tabs>
## Query Rewriting
Improve search accuracy with automatic query expansion:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "How do neural networks learn?",
rewriteQuery: true, // +400ms latency but better results
limit: 5
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="How do neural networks learn?",
rewrite_query=True, # +400ms latency but better results
limit=5
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "How do neural networks learn?",
"rewriteQuery": true,
"limit": 5
}'
```
</Tab>
</Tabs>
## Include Related Content
Include documents, related memories, and summaries:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "machine learning trends",
include: {
documents: true, // Include source documents
relatedMemories: true, // Include related memory entries
summaries: true // Include memory summaries
},
limit: 5
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="machine learning trends",
include={
"documents": True, # Include source documents
"relatedMemories": True, # Include related memory entries
"summaries": True # Include memory summaries
},
limit=5
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "machine learning trends",
"include": {
"documents": true,
"relatedMemories": true,
"summaries": true
},
"limit": 5
}'
```
</Tab>
</Tabs>
## Metadata Filtering
Simple metadata filtering for Memories search:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "research findings",
filters: {
AND: [
{ key: "category", value: "science", negate: false },
{ key: "status", value: "published", negate: false }
]
},
limit: 10
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="research findings",
filters={
"AND": [
{"key": "category", "value": "science", "negate": False},
{"key": "status", "value": "published", "negate": False}
]
},
limit=10
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "research findings",
"filters": {
"AND": [
{"key": "category", "value": "science", "negate": false},
{"key": "status", "value": "published", "negate": false}
]
},
"limit": 10
}'
```
</Tab>
</Tabs>
## Chatbot Example
Optimal configuration for conversational AI:
<Tabs>
<Tab title="TypeScript">
```typescript
// Optimized for chatbot responses
const results = await client.search.memories({
q: userMessage,
containerTag: userId,
threshold: 0.6, // Balanced relevance
rerank: false, // Skip for speed
rewriteQuery: false, // Skip for speed
limit: 3 // Few, relevant results
});
// Quick response for chat
const context = results.results
.map(r => r.memory)
.join('\n\n');
```
</Tab>
<Tab title="Python">
```python
# Optimized for chatbot responses
results = client.search.memories(
q=user_message,
container_tag=user_id,
threshold=0.6, # Balanced relevance
rerank=False, # Skip for speed
rewrite_query=False, # Skip for speed
limit=3 # Few, relevant results
)
# Quick response for chat
context = '\n\n'.join([r.memory for r in results.results])
```
</Tab>
<Tab title="cURL">
```bash
# Optimized for chatbot responses
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "user question here",
"containerTag": "user_123",
"threshold": 0.6,
"rerank": false,
"rewriteQuery": false,
"limit": 3
}'
```
</Tab>
</Tabs>
## Complete Memories Search Example
Combining features for comprehensive results:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "machine learning model performance",
containerTag: "research_team",
filters: {
AND: [
{ key: "topic", value: "ai", negate: false }
]
},
threshold: 0.7,
rerank: true,
rewriteQuery: false, // Skip for speed
include: {
documents: true,
relatedMemories: false,
summaries: true
},
limit: 5
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="machine learning model performance",
container_tag="research_team",
filters={
"AND": [
{"key": "topic", "value": "ai", "negate": False}
]
},
threshold=0.7,
rerank=True,
rewrite_query=False, # Skip for speed
include={
"documents": True,
"relatedMemories": False,
"summaries": True
},
limit=5
)
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "machine learning model performance",
"containerTag": "research_team",
"filters": {
"AND": [
{"key": "topic", "value": "ai", "negate": false}
]
},
"threshold": 0.7,
"rerank": true,
"rewriteQuery": false,
"include": {
"documents": true,
"relatedMemories": false,
"summaries": true
},
"limit": 5
}'
```
</Tab>
</Tabs>
## Hybrid Search Mode
Hybrid search mode allows you to search both memories and document chunks in a single request. When `searchMode="hybrid"`, results contain objects with either a `memory` key (for memory results) or a `chunk` key (for chunk results).
### Basic Hybrid Search
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "machine learning best practices",
searchMode: "hybrid", // Search memories + chunks
limit: 10
});
// Handle mixed results
results.results.forEach(result => {
if ('memory' in result) {
console.log('Memory:', result.memory);
} else if ('chunk' in result) {
console.log('Chunk:', result.chunk);
console.log('From document:', result.documents?.[0]?.title);
}
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="machine learning best practices",
search_mode="hybrid", # Search memories + chunks
limit=10
)
# Handle mixed results
for result in results.results:
if 'memory' in result:
print('Memory:', result['memory'])
elif 'chunk' in result:
print('Chunk:', result['chunk'])
print('From document:', result.get('documents', [{}])[0].get('title'))
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "machine learning best practices",
"searchMode": "hybrid",
"limit": 10
}'
```
</Tab>
</Tabs>
### When to Use Hybrid Mode
Use hybrid mode when:
- You want comprehensive search across both memories and documents
- Memories might not exist for certain queries but document content is available
- You need flexibility to get either memory or document chunk results
- You want a single search endpoint that covers all content types
Use memories-only mode (`searchMode="memories"`) when:
- You only need user memories and preferences
- You want faster, more focused results
- You're building a personalized chatbot that relies on user context
### Handling Mixed Results
When using hybrid mode, you'll receive mixed results. Here's how to process them:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "quantum computing applications",
searchMode: "hybrid",
limit: 10
});
// Separate memory and chunk results
const memoryResults = results.results.filter(r => 'memory' in r);
const chunkResults = results.results.filter(r => 'chunk' in r);
console.log(`Found ${memoryResults.length} memories and ${chunkResults.length} chunks`);
// Process memories
memoryResults.forEach(mem => {
console.log('Memory:', mem.memory);
console.log('Similarity:', mem.similarity);
});
// Process chunks
chunkResults.forEach(chunk => {
console.log('Chunk:', chunk.chunk);
console.log('Document:', chunk.documents?.[0]?.title);
console.log('Similarity:', chunk.similarity);
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="quantum computing applications",
search_mode="hybrid",
limit=10
)
# Separate memory and chunk results
memory_results = [r for r in results.results if 'memory' in r]
chunk_results = [r for r in results.results if 'chunk' in r]
print(f"Found {len(memory_results)} memories and {len(chunk_results)} chunks")
# Process memories
for mem in memory_results:
print('Memory:', mem['memory'])
print('Similarity:', mem['similarity'])
# Process chunks
for chunk in chunk_results:
print('Chunk:', chunk['chunk'])
print('Document:', chunk.get('documents', [{}])[0].get('title'))
print('Similarity:', chunk['similarity'])
```
</Tab>
</Tabs>
### Hybrid Search with All Features
Combining hybrid mode with other features:
<Tabs>
<Tab title="TypeScript">
```typescript
const results = await client.search.memories({
q: "research findings on AI",
searchMode: "hybrid",
containerTag: "research_team",
threshold: 0.7,
rerank: true,
include: {
documents: true,
relatedMemories: true,
summaries: true
},
limit: 10
});
// Results are automatically sorted by similarity
// Memory results have 'memory' field, chunk results have 'chunk' field
results.results.forEach(result => {
if ('memory' in result) {
// Memory result
console.log('Memory:', result.memory);
console.log('Context:', result.context);
} else {
// Chunk result
console.log('Chunk:', result.chunk);
console.log('Document:', result.documents?.[0]);
}
});
```
</Tab>
<Tab title="Python">
```python
results = client.search.memories(
q="research findings on AI",
search_mode="hybrid",
container_tag="research_team",
threshold=0.7,
rerank=True,
include={
"documents": True,
"relatedMemories": True,
"summaries": True
},
limit=10
)
# Results are automatically sorted by similarity
# Memory results have 'memory' field, chunk results have 'chunk' field
for result in results.results:
if 'memory' in result:
# Memory result
print('Memory:', result['memory'])
print('Context:', result.get('context'))
else:
# Chunk result
print('Chunk:', result['chunk'])
print('Document:', result.get('documents', [{}])[0])
```
</Tab>
<Tab title="cURL">
```bash
curl -X POST "https://api.supermemory.ai/v4/search" \
-H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "research findings on AI",
"searchMode": "hybrid",
"containerTag": "research_team",
"threshold": 0.7,
"rerank": true,
"include": {
"documents": true,
"relatedMemories": true,
"summaries": true
},
"limit": 10
}'
```
</Tab>
</Tabs>
<Note>
**Important**: In hybrid mode, results are automatically merged and sorted by similarity score. Memory results and chunk results are deduplicated - if a chunk is already associated with a memory result, it won't appear as a separate chunk result.
</Note>
## Common Use Cases
- **Chatbots**: Basic search with container tag and low threshold
- **Q&A Systems**: Add reranking for better relevance
- **Knowledge Retrieval**: Include documents and summaries
- **Real-time Search**: Skip rewriting and reranking for maximum speed
- **Hybrid Search**: Use `searchMode="hybrid"` when you need comprehensive search across both memories and documents
|