[Mem0] Update docs and improve readability (#1727)

This commit is contained in:
Deshraj Yadav
2024-08-21 00:18:43 -07:00
committed by GitHub
parent 2d66c23116
commit 7de35b4a68
21 changed files with 365 additions and 320 deletions

View File

@@ -1,3 +1,7 @@
---
title: Azure OpenAI
---
To use Azure OpenAI embedding models, set the `AZURE_OPENAI_API_KEY` environment variable. You can obtain the Azure OpenAI API key from the Azure.
### Usage

View File

@@ -1,3 +1,7 @@
---
title: Hugging Face
---
You can use embedding models from Huggingface to run Mem0 locally.
### Usage

View File

@@ -1,3 +1,7 @@
---
title: OpenAI
---
To use OpenAI embedding models, 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).
### Usage

View File

@@ -4,12 +4,19 @@ title: Overview
Mem0 offers support for various embedding models, allowing users to choose the one that best suits their needs.
## Supported Embedders
See the list of supported embedders below.
<CardGroup cols={4}>
<Card title="OpenAI" href="/components/embedders/models/openai"></Card>
<Card title="Azure OpenAI" href="/components/embedders/models/azure_openai"></Card>
<Card title="Ollama" href="/components/embedders/models/ollama"></Card>
<Card title="Hugging Face" href="/components/embedders/models/huggingface"></Card>
</CardGroup>
## Usage
To utilize a embedder, you must provide a configuration to customize its usage. If no configuration is supplied, a default configuration will be applied, and `OpenAI` will be used as the embedder.
For a comprehensive list of available parameters for embedder configuration, please refer to [Config](./config).
To view all supported embedders, visit the [Supported embedders](./models).