Skip to content

Commit 241370b

Browse files
committed
add doc
1 parent 601e857 commit 241370b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ The following environment variables are required to run the application:
6161
- `PDF_EXTRACT_IMAGES`: (Optional) A boolean value indicating whether to extract images from PDF files. Default value is "False".
6262
- `DEBUG_RAG_API`: (Optional) Set to "True" to show more verbose logging output in the server console, and to enable postgresql database routes
6363
- `CONSOLE_JSON`: (Optional) Set to "True" to log as json for Cloud Logging aggregations
64-
- `EMBEDDINGS_PROVIDER`: (Optional) either "openai", "bedrock", "azure", "huggingface", "huggingfacetei" or "ollama", where "huggingface" uses sentence_transformers; defaults to "openai"
64+
- `EMBEDDINGS_PROVIDER`: (Optional) either "openai", "bedrock", "azure", "huggingface", "huggingfacetei", "ollama" or "mistral", where "huggingface" uses sentence_transformers; defaults to "openai"
6565
- `EMBEDDINGS_MODEL`: (Optional) Set a valid embeddings model to use from the configured provider.
6666
- **Defaults**
6767
- openai: "text-embedding-3-small"
@@ -70,6 +70,7 @@ The following environment variables are required to run the application:
7070
- huggingfacetei: "http://huggingfacetei:3000". Hugging Face TEI uses model defined on TEI service launch.
7171
- ollama: "nomic-embed-text"
7272
- bedrock: "amazon.titan-embed-text-v1"
73+
- mistral: "mistral-embed"
7374
- `RAG_AZURE_OPENAI_API_VERSION`: (Optional) Default is `2023-05-15`. The version of the Azure OpenAI API.
7475
- `RAG_AZURE_OPENAI_API_KEY`: (Optional) The API key for Azure OpenAI service.
7576
- Note: `AZURE_OPENAI_API_KEY` will work but `RAG_AZURE_OPENAI_API_KEY` will override it in order to not conflict with LibreChat setting.
@@ -83,6 +84,7 @@ The following environment variables are required to run the application:
8384
- `AWS_DEFAULT_REGION`: (Optional) defaults to `us-east-1`
8485
- `AWS_ACCESS_KEY_ID`: (Optional) needed for bedrock embeddings
8586
- `AWS_SECRET_ACCESS_KEY`: (Optional) needed for bedrock embeddings
87+
- `MISTRAL_API_KEY`: (Optional) needed for mistral embeddings
8688

8789
Make sure to set these environment variables before running the application. You can set them in a `.env` file or as system environment variables.
8890

0 commit comments

Comments
 (0)