Update Docs (#3315)

2025-08-13 21:37:15 -07:00
parent 5e895c240a
commit 192db1844c
127 changed files with 2882 additions and 3317 deletions
@@ -4,7 +4,6 @@ icon: "gear"
 iconType: "solid"
 ---

-<Snippet file="blank-notif.mdx" />

 Config in mem0 is a dictionary that specifies the settings for your embedding models. It allows you to customize the behavior and connection details of your chosen embedder.

@@ -4,8 +4,6 @@ icon: "info"
 iconType: "solid"
 ---

-<Snippet file="blank-notif.mdx" />
-
 Mem0 offers support for various embedding models, allowing users to choose the one that best suits their needs.

 ## Supported Embedders
@@ -4,8 +4,6 @@ icon: "gear"
 iconType: "solid"
 ---

-<Snippet file="blank-notif.mdx" />
-
 ## How to define configurations?

 <Tabs>
@@ -2,7 +2,6 @@
 title: Anthropic
 ---

-<Snippet file="blank-notif.mdx" />

 To use Anthropic's models, please set the `ANTHROPIC_API_KEY` which you find on their [Account Settings Page](https://console.anthropic.com/account/keys).

@@ -2,8 +2,6 @@
 title: AWS Bedrock
 ---

-<Snippet file="blank-notif.mdx" />
-
 ### Setup
 - Before using the AWS Bedrock LLM, make sure you have the appropriate model access from [Bedrock Console](https://us-east-1.console.aws.amazon.com/bedrock/home?region=us-east-1#/modelaccess).
 - You will also need to authenticate the `boto3` client by using a method in the [AWS documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials)
@@ -2,8 +2,6 @@
 title: Azure OpenAI
 ---

-<Snippet file="blank-notif.mdx" />
-
 <Note> Mem0 Now Supports Azure OpenAI Models in TypeScript SDK </Note>

 To use Azure OpenAI models, you have to set the `LLM_AZURE_OPENAI_API_KEY`, `LLM_AZURE_ENDPOINT`, `LLM_AZURE_DEPLOYMENT` and `LLM_AZURE_API_VERSION` environment variables. You can obtain the Azure API key from the [Azure](https://azure.microsoft.com/).
@@ -2,8 +2,6 @@
 title: DeepSeek
 ---

-<Snippet file="blank-notif.mdx" />
-
 To use DeepSeek LLM models, you have to set the `DEEPSEEK_API_KEY` environment variable. You can also optionally set `DEEPSEEK_API_BASE` if you need to use a different API endpoint (defaults to "https://api.deepseek.com").

 ## Usage
@@ -0,0 +1,76 @@
+---
+title: Gemini
+---
+
+ 
+
+To use the Gemini model, set the `GEMINI_API_KEY` environment variable. You can obtain the Gemini API key from [Google AI Studio](https://aistudio.google.com/app/apikey).
+
+> **Note:** As of the latest release, Mem0 uses the new `google.genai` SDK instead of the deprecated `google.generativeai`. All message formatting and model interaction now use the updated `types` module from `google.genai`.
+
+> **Note:** Some Gemini models are being deprecated and will retire soon. It is recommended to migrate to the latest stable models like `"gemini-2.0-flash-001"` or `"gemini-2.0-flash-lite-001"` to ensure ongoing support and improvements.
+
+## Usage
+
+<CodeGroup>
+```python Python
+import os
+from mem0 import Memory
+
+os.environ["OPENAI_API_KEY"] = "your-openai-api-key"  # Used for embedding model
+os.environ["GEMINI_API_KEY"] = "your-gemini-api-key"
+
+config = {
+    "llm": {
+        "provider": "gemini",
+        "config": {
+            "model": "gemini-2.0-flash-001",
+            "temperature": 0.2,
+            "max_tokens": 2000,
+            "top_p": 1.0
+        }
+    }
+}
+
+m = Memory.from_config(config)
+
+messages = [
+    {"role": "user", "content": "I'm planning to watch a movie tonight. Any recommendations?"},
+    {"role": "assistant", "content": "How about thriller movies? They can be quite engaging."},
+    {"role": "user", "content": "I’m not a big fan of thrillers, but I love sci-fi movies."},
+    {"role": "assistant", "content": "Got it! I'll avoid thrillers and suggest sci-fi movies instead."}
+]
+
+m.add(messages, user_id="alice", metadata={"category": "movies"})
+
+```
+```typescript TypeScript
+import { Memory } from "mem0ai/oss";
+
+const config = {
+    llm: {
+        // You can also use "google" as provider ( for backward compatibility )
+        provider: "gemini",
+        config: {
+            model: "gemini-2.0-flash-001",
+            temperature: 0.1
+        }
+    }
+}
+
+const memory = new Memory(config);
+
+const messages = [
+    { role: "user", content: "I'm planning to watch a movie tonight. Any recommendations?" },
+    { role: "assistant", content: "How about thriller movies? They can be quite engaging." },
+    { role: "user", content: "I’m not a big fan of thrillers, but I love sci-fi movies." },
+    { role: "assistant", content: "Got it! I'll avoid thrillers and suggest sci-fi movies instead." }
+]
+
+await memory.add(messages, { userId: "alice", metadata: { category: "movies" } });
+```
+</CodeGroup>
+
+## Config
+
+All available parameters for the `Gemini` config are present in [Master List of All Params in Config](../config).
@@ -2,8 +2,6 @@
 title: Google AI
 ---

-<Snippet file="blank-notif.mdx" />
-
 To use the Gemini model, set the `GOOGLE_API_KEY` environment variable. You can obtain the Google/Gemini API key from [Google AI Studio](https://aistudio.google.com/app/apikey).

 > **Note:** As of the latest release, Mem0 uses the new `google.genai` SDK instead of the deprecated `google.generativeai`. All message formatting and model interaction now use the updated `types` module from `google.genai`.
@@ -2,8 +2,6 @@
 title: Groq
 ---

-<Snippet file="blank-notif.mdx" />
-
 [Groq](https://groq.com/) is the creator of the world's first Language Processing Unit (LPU), providing exceptional speed performance for AI workloads running on their LPU Inference Engine.

 In order to use LLMs from Groq, go to their [platform](https://console.groq.com/keys) and get the API key. Set the API key as `GROQ_API_KEY` environment variable to use the model as given below in the example.
@@ -2,7 +2,6 @@
 title: LangChain
 ---

-<Snippet file="blank-notif.mdx" />

 Mem0 supports LangChain as a provider to access a wide range of LLM models. LangChain is a framework for developing applications powered by language models, making it easy to integrate various LLM providers through a consistent interface.

@@ -1,5 +1,3 @@
-<Snippet file="blank-notif.mdx" />
-
 [Litellm](https://litellm.vercel.app/docs/) is compatible with over 100 large language models (LLMs), all using a standardized input/output format. You can explore the [available models](https://litellm.vercel.app/docs/providers) to use with Litellm. Ensure you set the `API_KEY` for the model you choose to use.

 ## Usage
@@ -2,8 +2,6 @@
 title: LM Studio
 ---

-<Snippet file="blank-notif.mdx" />
-
 To use LM Studio with Mem0, you'll need to have LM Studio running locally with its server enabled. LM Studio provides a way to run local LLMs with an OpenAI-compatible API.

 ## Usage
@@ -2,8 +2,6 @@
 title: Mistral AI
 ---

-<Snippet file="blank-notif.mdx" />
-
 To use mistral's models, please obtain the Mistral AI api key from their [console](https://console.mistral.ai/). Set the `MISTRAL_API_KEY` environment variable to use the model as given below in the example.

 ## Usage
@@ -1,5 +1,3 @@
-<Snippet file="blank-notif.mdx" />
-
 You can use LLMs from Ollama to run Mem0 locally. These [models](https://ollama.com/search?c=tools) support tool support.

 ## Usage
@@ -2,8 +2,6 @@
 title: OpenAI
 ---

-<Snippet file="blank-notif.mdx" />
-
 To use OpenAI LLM models, you have to set the `OPENAI_API_KEY` environment variable. You can obtain the OpenAI API key from the [OpenAI Platform](https://platform.openai.com/account/api-keys).

 > **Note**: The following are currently unsupported with reasoning models `Parallel tool calling`,`temperature`, `top_p`, `presence_penalty`, `frequency_penalty`, `logprobs`, `top_logprobs`, `logit_bias`, `max_tokens`
@@ -2,8 +2,6 @@
 title: Sarvam AI
 ---

-<Snippet file="blank-notif.mdx" />
-
 **Sarvam AI** is an Indian AI company developing language models with a focus on Indian languages and cultural context. Their latest model **Sarvam-M** is designed to understand and generate content in multiple Indian languages while maintaining high performance in English.

 To use Sarvam AI's models, please set the `SARVAM_API_KEY` which you can get from their [platform](https://dashboard.sarvam.ai/).
@@ -1,5 +1,3 @@
-<Snippet file="blank-notif.mdx" />
-
 To use TogetherAI LLM models, you have to set the `TOGETHER_API_KEY` environment variable. You can obtain the TogetherAI API key from their [Account settings page](https://api.together.xyz/settings/api-keys).

 ## Usage
@@ -2,8 +2,6 @@
 title: vLLM
 ---

-<Snippet file="blank-notif.mdx" />
-
 [vLLM](https://docs.vllm.ai/) is a high-performance inference engine for large language models that provides significant performance improvements for local inference. It's designed to maximize throughput and memory efficiency for serving LLMs.

 ## Prerequisites
@@ -2,8 +2,6 @@
 title: xAI
 ---

-<Snippet file="blank-notif.mdx" />
-
 [xAI](https://x.ai/) is a new AI company founded by Elon Musk that develops large language models, including Grok. Grok is trained on real-time data from X (formerly Twitter) and aims to provide accurate, up-to-date responses with a touch of wit and humor.

 In order to use LLMs from xAI, go to their [platform](https://console.x.ai) and get the API key. Set the API key as `XAI_API_KEY` environment variable to use the model as given below in the example.
@@ -4,8 +4,6 @@ icon: "info"
 iconType: "solid"
 ---

-<Snippet file="blank-notif.mdx" />
-
 Mem0 includes built-in support for various popular large language models. Memory can utilize the LLM provided by the user, ensuring efficient use for specific needs.

 ## Usage
@@ -4,8 +4,6 @@ icon: "gear"
 iconType: "solid"
 ---

-<Snippet file="blank-notif.mdx" />
-
 ## How to define configurations?

 The `config` is defined as an object with two main keys:
@@ -4,8 +4,6 @@ icon: "info"
 iconType: "solid"
 ---

-<Snippet file="blank-notif.mdx" />
-
 Mem0 includes built-in support for various popular databases. Memory can utilize the database provided by the user, ensuring efficient use for specific needs.

 ## Supported Vector Databases