Docs Update (#2591)

This commit is contained in:
Prateek Chhikara
2025-04-29 08:15:25 -07:00
committed by GitHub
parent 6d13e83001
commit 393a4fd5a6
111 changed files with 2296 additions and 99 deletions

View File

@@ -4,6 +4,8 @@ icon: "magnifying-glass"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
Mem0's **Advanced Retrieval** feature delivers superior search results by leveraging state-of-the-art search algorithms. Beyond the default search functionality, Mem0 offers the following advanced retrieval modes:
1. **Keyword Search**

View File

@@ -5,6 +5,7 @@ icon: "bolt"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
The `AsyncMemoryClient` is an asynchronous client for interacting with the Mem0 API. It provides similar functionality to the synchronous `MemoryClient` but allows for non-blocking operations, which can be beneficial in applications that require high concurrency.
## Initialization

View File

@@ -4,6 +4,8 @@ icon: "square-plus"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
Mem0 now supports an contextual add version (v2). To use it, set `version="v2"` during the add call. The default version is v1, which is deprecated now. We recommend migrating to `v2` for new applications.
## Key Differences Between v1 and v2

View File

@@ -5,6 +5,8 @@ icon: "tags"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## How to set custom categories?
You can now create custom categories tailored to your specific needs, instead of using the default categories such as travel, sports, music, and more (see [default categories](#default-categories) below). **When custom categories are provided, they will override the default categories.**

View File

@@ -5,6 +5,8 @@ icon: "pencil"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Introduction to Custom Fact Extraction Prompt
Custom fact extraction prompt allow you to tailor the behavior of your Mem0 instance to specific use cases or domains.

View File

@@ -5,6 +5,8 @@ icon: "pencil"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Introduction to Custom Instructions
Custom instructions allow you to define specific guidelines for your project. This feature helps ensure consistency and provides clear direction for handling project-specific requirements.

View File

@@ -3,9 +3,12 @@ title: Custom Update Memory Prompt
icon: "pencil"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
Update memory prompt is a prompt used to determine the action to be performed on the memory.
By customizing this prompt, you can control how the memory is updated.
## Introduction
Mem0 memory system compares the newly retrieved facts with the existing memory and determines the action to be performed on the memory.

View File

@@ -5,6 +5,8 @@ icon: "arrow-right"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## How to use Direct Import?
The Direct Import feature allows users to skip the memory deduction phase and directly input pre-defined memories into the system for storage and retrieval.
To enable this feature, you need to set the `infer` parameter to `False` in the `add` method.

View File

@@ -5,6 +5,8 @@ icon: "clock"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Benefits of Memory Expiration
Setting expiration dates for memories offers several advantages:

View File

@@ -4,6 +4,8 @@ icon: "thumbs-up"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
Mem0's **Feedback Mechanism** allows you to provide feedback on the memories generated by your application. This feedback is used to improve the accuracy of the memories and the search results.
## How it works

View File

@@ -5,6 +5,8 @@ iconType: "solid"
description: "Enable graph-based memory retrieval for more contextually relevant results"
---
<Snippet file="paper-release.mdx" />
## Overview
Graph Memory enhances memory pipeline by creating relationships between entities in your data. It builds a network of interconnected information for more contextually relevant search results.

View File

@@ -5,6 +5,8 @@ icon: "file-export"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Overview
The Memory Export feature allows you to create structured exports of memories using customizable Pydantic schemas. This process enables you to transform your stored memories into specific data formats that match your needs. You can apply various filters to narrow down which memories to export and define exactly how the data should be structured.

View File

@@ -5,6 +5,8 @@ icon: "image"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
Mem0 extends its capabilities beyond text by supporting multimodal data, including images and documents. With this feature, users can seamlessly integrate visual and document content into their interactions—allowing Mem0 to extract relevant information from various media types and enrich the memory system.
## How It Works

View File

@@ -4,6 +4,8 @@ icon: "code"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
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.
If you have a `Mem0 API key`, you can use it to initialize the client. Alternatively, you can initialize Mem0 without an API key if you're using it locally.

View File

@@ -4,6 +4,8 @@ icon: "info"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
Learn about the key features and capabilities that make Mem0 a powerful platform for memory management and retrieval.
## Core Features

View File

@@ -5,6 +5,8 @@ icon: "filter"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Benefits of Memory Customization
Memory customization offers several key benefits:

View File

@@ -5,6 +5,8 @@ icon: "clock"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Overview
The Memory Timestamps feature allows you to specify when a memory was created, regardless of when it's actually added to the system. This powerful capability enables you to:

View File

@@ -5,6 +5,8 @@ icon: "webhook"
iconType: "solid"
---
<Snippet file="paper-release.mdx" />
## Overview
Webhooks enable real-time notifications for memory events in your Mem0 project. Webhooks are configured at the project level, meaning each webhook is tied to a specific project and receives events solely from that project. You can configure webhooks to send HTTP POST requests to your specified URLs whenever memories are created, updated, or deleted.