diff --git a/docs/installation/ai-assistant.md b/docs/installation/ai-assistant.md index e5c7be4676..0ea0cd66c9 100644 --- a/docs/installation/ai-assistant.md +++ b/docs/installation/ai-assistant.md @@ -19,7 +19,7 @@ Set the model you want, restart Baserow, and let migrations run. ```dotenv # Required -BASEROW_ENTERPRISE_ASSISTANT_LLM_MODEL=openai/gpt-5-mini +BASEROW_ENTERPRISE_ASSISTANT_LLM_MODEL=openai/gpt-4o OPENAI_API_KEY=your_api_key # Optional - adjust LLM temperature (default: 0) @@ -39,7 +39,7 @@ Choose **one** provider block and set its variables. ### OpenAI / OpenAI-compatible ```dotenv -BASEROW_ENTERPRISE_ASSISTANT_LLM_MODEL=openai/gpt-5-mini +BASEROW_ENTERPRISE_ASSISTANT_LLM_MODEL=openai/gpt-4o OPENAI_API_KEY=your_api_key # Optional alternative endpoints (OpenAI EU or Azure OpenAI, etc.) UDSPY_LM_OPENAI_COMPATIBLE_BASE_URL=https://eu.api.openai.com/v1 diff --git a/docs/installation/configuration.md b/docs/installation/configuration.md index f5735f2be6..76f0f07cc5 100644 --- a/docs/installation/configuration.md +++ b/docs/installation/configuration.md @@ -182,15 +182,15 @@ The installation methods referred to in the variable descriptions are: | BASEROW\_DEADLOCK\_MAX\_RETRIES | The maximum number of database deadlock retries. | 1 | ### AI-assistant Configuration -| Name | Description | Defaults | -|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| -| BASEROW\_EMBEDDINGS\_API\_URL | If not empty, the AI-assistant will use this as embedding server for the knowledge base lookup. Must point to a container running this image: https://hub.docker.com/r/baserow/embeddings | "" (empty string) | -| BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL | If not empty, then this model will be used for the AI-assistant. Provide like `groq/openai/gpt-oss-120b` or `bedrock/openai.gpt-oss-120b-1:0`. Note that additional API keys must be provided as environment variable depending on the provider. Instructions can be found at https://baserow.github.io/udspy/ | "" (empty string) | -| AWS\_BEARER\_TOKEN\_BEDROCK | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=bedrock/bedrock/openai.gpt-oss-120b-1:0, then this environment variable must be set. Instructions on how to obtain: https://docs.aws.amazon.com/bedrock/latest/userguide/api-keys-use.html | "" (empty string) | -| AWS\_REGION\_NAME | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=groq/openai/gpt-oss-120b, then the AWS region for the AI-assistant can be provided here. | us-east-1 | -| GROQ\_API\_KEY | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=bedrock/bedrock/openai.gpt-oss-120b-1:0, then the Groq API key can be provided here. | "" (empty string) | -| OLLAMA\_API\_KEY | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=ollama/gpt-oss:120b, then the Ollama API key can be provided here. | "" (empty string) | -| UDSPY\_LM\_OPENAI\_COMPATIBLE\_BASE\_URL | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=openai/gpt-5-nano, then the base URL can be changed here. This can be used to point to a different OpenAI compatible API like Azure, for example. | "" (empty string) | +| Name | Description | Defaults | +|---------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| BASEROW\_EMBEDDINGS\_API\_URL | If not empty, the AI-assistant will use this as embedding server for the knowledge base lookup. Must point to a container running this image: https://hub.docker.com/r/baserow/embeddings | "" (empty string) | +| BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL | If not empty, then this model will be used for the AI-assistant. Provide like `groq/openai/gpt-oss-120b` or `bedrock/openai.gpt-oss-120b-1:0`. Note that additional API keys must be provided as environment variable depending on the provider. Instructions can be found at https://baserow.io/docs/installation/ai-assistant | "" (empty string) | +| AWS\_BEARER\_TOKEN\_BEDROCK | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=bedrock/bedrock/openai.gpt-oss-120b-1:0, then this environment variable must be set. Instructions on how to obtain: https://docs.aws.amazon.com/bedrock/latest/userguide/api-keys-use.html | "" (empty string) | +| AWS\_REGION\_NAME | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=groq/openai/gpt-oss-120b, then the AWS region for the AI-assistant can be provided here. | us-east-1 | +| GROQ\_API\_KEY | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=bedrock/bedrock/openai.gpt-oss-120b-1:0, then the Groq API key can be provided here. | "" (empty string) | +| OLLAMA\_API\_KEY | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=ollama/gpt-oss:120b, then the Ollama API key can be provided here. | "" (empty string) | +| UDSPY\_LM\_OPENAI\_COMPATIBLE\_BASE\_URL | If the BASEROW\_ENTERPRISE\_ASSISTANT\_LLM\_MODEL=openai/gpt-5-nano, then the base URL can be changed here. This can be used to point to a different OpenAI compatible API like Azure, for example. | "" (empty string) | ### Data sync configuration diff --git a/enterprise/backend/src/baserow_enterprise/api/assistant/errors.py b/enterprise/backend/src/baserow_enterprise/api/assistant/errors.py index 227c7aec7b..02ce843a91 100644 --- a/enterprise/backend/src/baserow_enterprise/api/assistant/errors.py +++ b/enterprise/backend/src/baserow_enterprise/api/assistant/errors.py @@ -13,7 +13,7 @@ ( "The specified language model is not supported or the provided API key is missing/invalid. " "Ensure you have set the correct provider API key and selected a compatible model in " - "`BASEROW_ENTERPRISE_ASSISTANT_LLM_MODEL`. See https://baserow.github.io/udspy/ for " + "`BASEROW_ENTERPRISE_ASSISTANT_LLM_MODEL`. See https://baserow.io/docs/installation/ai-assistant for " "supported models, required environment variables, and example configuration." ), )