Skip to content

An AI-powered search engine with a generative UI

docs: update model configuration documentation

Yoshiki Miura76c017e763fd
diff --git a/.env.local.example b/.env.local.example
index 2efd5794..af3671c7 100644
--- a/.env.local.example
+++ b/.env.local.example
@@ -45,14 +45,10 @@ TAVILY_API_KEY=[YOUR_TAVILY_API_KEY] # Get your API key at: https://app.tavily.
# Ollama
# OLLAMA_BASE_URL=http://localhost:11434
-# NEXT_PUBLIC_OLLAMA_MODEL=[YOUR_MODEL_NAME] (eg: deepseek-r1)
-# If you want to use a different model for tool call, set the model name here.
-# NEXT_PUBLIC_OLLAMA_TOOL_CALL_MODEL=[YOUR_MODEL_NAME] (eg: phi4) (optional)
# Azure OpenAI
# AZURE_API_KEY=
# AZURE_RESOURCE_NAME=
-# NEXT_PUBLIC_AZURE_DEPLOYMENT_NAME=
# DeepSeek
# DEEPSEEK_API_KEY=[YOUR_DEEPSEEK_API_KEY]
@@ -64,7 +60,6 @@ TAVILY_API_KEY=[YOUR_TAVILY_API_KEY] # Get your API key at: https://app.tavily.
# XAI_API_KEY=[YOUR_XAI_API_KEY]
# OpenAI Compatible Model
-# NEXT_PUBLIC_OPENAI_COMPATIBLE_MODEL=
# OPENAI_COMPATIBLE_API_KEY=
# OPENAI_COMPATIBLE_API_BASE_URL=
diff --git a/README.md b/README.md
index 3b17c4a0..e1f55c02 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,8 @@ An AI-powered search engine with a generative UI.
### AI Providers
+The following AI providers are supported:
+
- OpenAI (Default)
- Google Generative AI
- Azure OpenAI
@@ -42,8 +44,11 @@ An AI-powered search engine with a generative UI.
- Groq
- DeepSeek
- Fireworks
+- xAI (Grok)
- OpenAI Compatible
+Models are configured in `lib/config/models.json`. Each model requires its corresponding API key to be set in the environment variables. See [Configuration Guide](docs/CONFIGURATION.md) for details.
+
### Search Capabilities
- URL-specific search
diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md
index 1e21f4a6..97d2c467 100644
--- a/docs/CONFIGURATION.md
+++ b/docs/CONFIGURATION.md
@@ -121,6 +121,30 @@ docker-compose logs searxng
## Additional AI Providers
+Models are configured in `lib/config/models.json`. Each model requires its corresponding API key to be set in the environment variables.
+
+### Model Configuration
+
+The `models.json` file contains an array of model configurations with the following structure:
+
+```json
+{
+ "models": [
+ {
+ "id": "model-id",
+ "name": "Model Name",
+ "provider": "Provider Name",
+ "providerId": "provider-id",
+ "enabled": true,
+ "toolCallType": "native|manual",
+ "toolCallModel": "tool-call-model-id" // only required if toolCallType is "manual"
+ }
+ ]
+}
+```
+
+### Provider API Keys
+
### Google Generative AI
```bash
@@ -150,19 +174,18 @@ OLLAMA_BASE_URL=http://localhost:11434
```bash
AZURE_API_KEY=[YOUR_API_KEY]
AZURE_RESOURCE_NAME=[YOUR_RESOURCE_NAME]
-NEXT_PUBLIC_AZURE_DEPLOYMENT_NAME=[YOUR_DEPLOYMENT_NAME]
```
### DeepSeek
-```
-# DEEPSEEK_API_KEY=[YOUR_API_KEY]
+```bash
+DEEPSEEK_API_KEY=[YOUR_API_KEY]
```
### Fireworks
-```
-# FIREWORKS_API_KEY=[YOUR_API_KEY]
+```bash
+FIREWORKS_API_KEY=[YOUR_API_KEY]
```
### xAI
@@ -171,6 +194,13 @@ NEXT_PUBLIC_AZURE_DEPLOYMENT_NAME=[YOUR_DEPLOYMENT_NAME]
XAI_API_KEY=[YOUR_XAI_API_KEY]
```
+### OpenAI Compatible Model
+
+```bash
+OPENAI_COMPATIBLE_API_KEY=[YOUR_API_KEY]
+OPENAI_COMPATIBLE_API_BASE_URL=[YOUR_API_BASE_URL]
+```
+
## Other Features
### Share Feature