From afa97316b53232a3bba8c2aadc63b6a32d2788f9 Mon Sep 17 00:00:00 2001 From: Tianzhou Date: Thu, 1 Aug 2024 23:00:53 +0800 Subject: [PATCH] docs: add ollama --- README.md | 3 ++- README.zh-CN.md | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52eac18..2ce16d2 100644 --- a/README.md +++ b/README.md @@ -79,10 +79,11 @@ docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET="$(openss - `OPENAI_API_KEY`: OpenAI API key. You can get one from [here](https://platform.openai.com/api-keys). -- `OPENAI_API_ENDPOINT`: OpenAI API endpoint. Defaults to `https://api.openai.com`. +- `OPENAI_API_ENDPOINT`: OpenAI API endpoint. Defaults to `https://api.openai.com`. Use [Ollama](https://github.com/ollama/ollama) to set up self-host AI model and set the endpoint to it. - `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: Set to `true` to allow users to bring their own OpenAI API key. + ### Database related - `NEXT_PUBLIC_USE_DATABASE`: Set to `true` to start SQL Chat with database. This will diff --git a/README.zh-CN.md b/README.zh-CN.md index dbe0901..6290802 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -70,7 +70,7 @@ docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET="$(openss - `OPENAI_API_KEY`: OpenAI API key. 您能从 [这里](https://beta.openai.com/docs/developer-quickstart/api-keys) 获得。 -- `OPENAI_API_ENDPOINT`: OpenAI API endpoint. 默认 `https://api.openai.com`。 +- `OPENAI_API_ENDPOINT`: OpenAI API endpoint. 默认 `https://api.openai.com`。使用 [Ollama](https://github.com/ollama/ollama) 来启动 self-host AI 模型，并且把 endpoint 指向它. - `NEXT_PUBLIC_ALLOW_SELF_OPENAI_KEY`: 置为 `true` 以允许 SQL Chat 服务的用户使用自己的 key。