Added improved docs index and overview pages and quickstart (#3603)

This commit is contained in:
Parth Sharma
2025-10-22 23:00:45 +05:30
committed by GitHub
parent ec1a60bf8d
commit f7d7c53001
65 changed files with 2182 additions and 2299 deletions
@@ -1,8 +1,6 @@
---
title: Async Memory
description: 'Asynchronous memory for Mem0'
icon: "bolt"
iconType: "solid"
---
## AsyncMemory
@@ -1,8 +1,6 @@
---
title: Custom Fact Extraction Prompt
description: 'Enhance your product experience by adding custom fact extraction prompt tailored to your needs'
icon: "pencil"
iconType: "solid"
---
## Introduction to Custom Fact Extraction Prompt
@@ -1,7 +1,6 @@
---
title: Custom Update Memory Prompt
icon: "pencil"
iconType: "solid"
description: 'Control memory update actions with a custom prompt'
---
@@ -234,4 +233,4 @@ The prompt needs to guide the output to follow the structure as shown below:
|---------|-------------------------------|-----------------|
| Use case | Determine the action to be performed on the memory | Extract facts from messages |
| Reference | Retrieved facts from messages and old memory | Messages |
| Output | Action to be performed on the memory | Extracted facts |
| Output | Action to be performed on the memory | Extracted facts |
@@ -1,8 +1,6 @@
---
title: Enhanced Metadata Filtering
description: 'Advanced filtering capabilities for precise memory retrieval in Mem0 1.0.0 '
icon: "filter"
iconType: "solid"
---
<Info>
@@ -386,4 +384,4 @@ results = m.search(
<Info>
Enhanced metadata filtering provides powerful capabilities for precise memory retrieval. Start with simple filters and gradually adopt more complex patterns as needed.
</Info>
</Info>
@@ -1,8 +1,6 @@
---
title: Multimodal Support
description: Integrate images into your interactions with Mem0
icon: "image"
iconType: "solid"
---
Mem0 extends its capabilities beyond text by supporting multimodal data. With this feature, you can seamlessly integrate images into your interactions—allowing Mem0 to extract relevant information and context from visual content.
@@ -1,7 +1,6 @@
---
title: OpenAI Compatibility
icon: "code"
iconType: "solid"
description: 'Integrate Mem0 using OpenAI-compatible client APIs'
---
Mem0 can be easily integrated into chat applications to enhance conversational agents with structured memory. Mem0's APIs are designed to be compatible with OpenAI's, with the goal of making it easy to leverage Mem0 in applications you may have already built.
-2
View File
@@ -1,8 +1,6 @@
---
title: Overview
description: 'Build powerful AI applications with self-improving memory using Mem0 open-source'
icon: "eye"
iconType: "solid"
---
## Welcome to Mem0 Open Source
@@ -1,8 +1,6 @@
---
title: Reranker-Enhanced Search
description: 'Improve search relevance with reranking models in Mem0 1.0.0 '
icon: "sort"
iconType: "solid"
---
<Info>
@@ -415,4 +413,4 @@ results = m.search("query", user_id="alice") # Automatically reranked
<Info>
Reranker-enhanced search significantly improves result relevance. Start with a local model and upgrade to API-based solutions as your needs grow.
</Info>
</Info>
+1 -3
View File
@@ -1,8 +1,6 @@
---
title: Reranking
description: 'Improve memory search relevance with advanced reranking capabilities'
icon: "arrow-up-arrow-down"
iconType: "solid"
---
## Overview
@@ -127,4 +125,4 @@ results = memory.search("query", user_id="alice", rerank=False)
- Explore specific [reranker providers](../../components/rerankers/overview) and their capabilities
- Learn about [configuration options](../../components/rerankers/config) for fine-tuning
- Check out [Vector Stores](../../components/vectordbs/overview) for different storage backends
- See [Async Memory](./async-memory) for non-blocking reranking operations
- See [Async Memory](./async-memory) for non-blocking reranking operations
+1 -2
View File
@@ -1,7 +1,6 @@
---
title: REST API Server
icon: "server"
iconType: "solid"
description: 'Reach every Mem0 capability through a FastAPI-powered REST server'
---
Mem0 provides a REST API server (written using FastAPI). Users can perform all operations through REST endpoints. The API also includes OpenAPI documentation, accessible at `/docs` when the server is running.