瀏覽代碼

Update docs for LLMs and Overview (#1504)

Dev Khant 1 年之前
父節點
當前提交
e913c96926
共有 2 個文件被更改,包括 58 次插入2 次删除
  1. 57 1
      docs/llms.mdx
  2. 1 1
      docs/mint.json

+ 57 - 1
docs/llms.mdx

@@ -14,6 +14,8 @@ Mem0 includes built-in support for various popular large language models. Memory
   <Card title="Litellm" href="#litellm"></Card>
   <Card title="Google AI" href="#google-ai"></Card>
   <Card title="Anthropic" href="#anthropic"></Card>
+  <Card title="Mistral AI" href="#mistral-ai"></Card>
+  <Card title="OpenAI Azure" href="#openai-azure"></Card>
 </CardGroup>
 
 ## OpenAI
@@ -181,7 +183,7 @@ m.add("Likes to play cricket on weekends", user_id="alice", metadata={"category"
 
 ## Anthropic
 
-To use anthropic's model, please set the `ANTHROPIC_API_KEY` which you find on their [Account Settings Page](https://console.anthropic.com/account/keys).
+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).
 
 ```python
 import os
@@ -204,3 +206,57 @@ m = Memory.from_config(config)
 m.add("Likes to play cricket on weekends", user_id="alice", metadata={"category": "hobbies"})
 ```
 
+## Mistral AI
+
+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.
+
+```python
+import os
+from mem0 import Memory
+
+os.environ["MISTRAL_API_KEY"] = "your-api-key"
+
+config = {
+    "llm": {
+        "provider": "litellm",
+        "config": {
+            "model": "open-mixtral-8x7b",
+            "temperature": 0.1,
+            "max_tokens": 2000,
+        }
+    }
+}
+
+m = Memory.from_config(config)
+m.add("Likes to play cricket on weekends", user_id="alice", metadata={"category": "hobbies"})
+```
+
+## OpenAI Azure
+
+To use Azure AI models, you have to set the `AZURE_API_KEY`, `AZURE_API_BASE`, and `AZURE_API_VERSION` environment variables. You can obtain the Azure API key from the [Azure](https://azure.microsoft.com/).
+
+```python
+import os
+from mem0 import Memory
+
+
+os.environ["AZURE_API_KEY"] = "your-api-key"
+
+# Needed to use custom models
+os.environ["AZURE_API_BASE"] = "your-api-base-url"
+os.environ["AZURE_API_VERSION"] = "version-to-use"
+
+config = {
+    "llm": {
+        "provider": "litellm",
+        "config": {
+            "model": "azure_ai/command-r-plus",
+            "temperature": 0.1,
+            "max_tokens": 2000,
+        }
+    }
+}
+
+m = Memory.from_config(config)
+m.add("Likes to play cricket on weekends", user_id="alice", metadata={"category": "hobbies"})
+```

+ 1 - 1
docs/mint.json

@@ -88,7 +88,7 @@
   ],
   "footerSocials": {
     "x": "https://x.com/mem0ai",
-    "github": "https://github.com/embedchain/embedchain/mem0",
+    "github": "https://github.com/mem0ai/mem0",
     "linkedin": "https://www.linkedin.com/company/mem0/"
   }
 }