chore: fix doc and add more error FAQ

This commit is contained in:
tianzhou
2023-06-25 11:47:46 +08:00
parent 0c5d07b0d7
commit bb34e29f33
5 changed files with 71 additions and 20 deletions

View File

@ -21,8 +21,8 @@ SQL Chat es un cliente SQL basado en chat, que utiliza lenguaje natural para com
## ¿Por que?
A medida que entramos en la [Era de las Herramientas de Desarrollo 2.0](https://www.sequoiacap.com/article/ai-powered-developer-tools/),
existe una gran oportunidad para reconstruir las herramientas existentes utilizando una interfaz basada en chat. El cliente SQL
no es una excepción. En lugar de navegar a través de varias interfaces de usuario, una interfaz basada en chat es
existe una gran oportunidad para reconstruir las herramientas existentes utilizando una interfaz basada en chat. El cliente SQL
no es una excepción. En lugar de navegar a través de varias interfaces de usuario, una interfaz basada en chat es
más intuitiva. Por supuesto, solo si funciona, y nuestro objetivo es ofrecer esa experiencia.
## ¿Como?
@ -40,7 +40,7 @@ Vea la [Política de Privacidad de SQL Chat](https://sqlchat.ai/privacy).
## IP Whitelisting
Si usas [sqlchat.ai](https://sqlchat.ai) para conectarte a tu base de datos, debes agregar 0.0.0.0 (permitir todas las conexiones) a la IP de la lista blanca de la base de datos. Porque sqlchat.AI está alojado en
Si usas [sqlchat.ai](https://sqlchat.ai) para conectarte a tu base de datos, debes agregar 0.0.0.0 (permitir todas las conexiones) a la IP de la lista blanca de la base de datos. Porque sqlchat.AI está alojado en
[Vercel](https://vercel.com/) el cual [usa IP dinámica](https://vercel.com/guides/how-to-allowlist-deployment-ip-address). Si esto le preocupa, considere la opción de hospedaje propio a continuación.
## Hospedaje propio con Docker
@ -57,7 +57,7 @@ docker run --name sqlchat --platform linux/amd64 -env NEXTAUTH_SECRET=xxx -p 300
### Variables relacionadas con la base de datos:
- `NEXT_PUBLIC_DATABASE_LESS`: Establézcalo en `true` para iniciar SQL Chat en modo sin base de datos. Esto
- `NEXT_PUBLIC_DATABASE_LESS`: Establézcalo en `true` para iniciar SQL Chat en modo sin base de datos. Esto
desactivara las siguientes funciones:
1. Sistema de cuentas.
2. Ejecución de Cuota por Usuario.
@ -176,7 +176,23 @@ Este proyecto está bajo la Licencia BSL. Consulte el archivo [LICENSE](LICENSE)
<details><summary>¿Siempre dice que tengo un problema de conexión de red?</summary>
<p>
Asegúrese de tener una conexión de red estable que pueda acceder al endpoint de la API de OpenAI. Si no puede acceder al endpoint de la API de OpenAI, puede intentar configurar el `OPENAI_API_ENDPOINT` en la UI o como una variable de entorno.
Asegúrese de tener una conexión de red estable que pueda acceder al endpoint de la API de OpenAI.
```bash
ping api.openai.com
```
Si no puede acceder al endpoint de la API de OpenAI, puede intentar configurar el `OPENAI_API_ENDPOINT` en la UI o como una variable de entorno.
</p>
</details>
<details><summary>You exceeded your current quota, please check your plan and billing details</summary>
<p>
![openai quota](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/error-exceed-openai-quota.webp)
Su clave OpenAI se ha quedado sin cuota. Por favor revise su [cuenta de OpenAI ](https://platform.openai.com/account/api-keys).
</p>
</details>

View File

@ -107,15 +107,15 @@ docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env
1. Set up database schema
```bash
pnpm prisma migrate dev
```
```bash
pnpm prisma migrate dev
```
1. (Optional) Seed data
```bash
pnpm prisma db seed
```
```bash
pnpm prisma db seed
```
## Star History
@ -176,7 +176,25 @@ This project is under the BSL License. See the [LICENSE](LICENSE) file for the f
<details><summary>It always says that I have a network connection issue?</summary>
<p>
Please make sure you have a stable network connection which can access the OpenAI API endpoint. If you cannot access the OpenAI API endpoint, you can try to set the `OPENAI_API_ENDPOINT` in UI or environment variable.
![network error](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/error-network.webp)
Please make sure you have a stable network connection which can access the OpenAI API endpoint.
```bash
ping api.openai.com
```
If you cannot access the OpenAI API endpoint, you can try to set the `OPENAI_API_ENDPOINT` in UI or environment variable.
</p>
</details>
<details><summary>You exceeded your current quota, please check your plan and billing details</summary>
<p>
![openai quota](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/error-exceed-openai-quota.webp)
Your OpenAI Key has run out of quota. Please check your [OpenAI account](https://platform.openai.com/account/api-keys).
</p>
</details>

View File

@ -101,18 +101,17 @@ docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env
在 `.env` 文件中, 将连接字符串分配给环境变量 `DATABASE_URL` 和 `DATABASE_DIRECT_URL`。至于需要两个 URL 的原因[见此](https://www.prisma.io/docs/data-platform/data-proxy/prisma-cli-with-data-proxy#set-a-direct-database-connection-url-in-your-prisma-schema).
1. 设置数据库 schema
```bash
pnpm prisma migrate dev
```
```bash
pnpm prisma migrate dev
```
1. 初始化数据(可选)
```bash
pnpm prisma db seed
```
```bash
pnpm prisma db seed
```
## Star 历史
@ -173,7 +172,25 @@ docker run --name sqlchat --platform linux/amd64 --env NEXTAUTH_SECRET=xxx --env
<details><summary>它总是说我有网络连接问题?</summary>
<p>
请确保您有一个稳定的网络连接,可以访问 OpenAI API 端点。如果您无法访问 OpenAI API 端点,您可以尝试在 UI 或环境变量中设置 `OPENAI_API_ENDPOINT`。
![network error](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/error-network.webp)
请确保您有一个稳定的网络连接,可以访问 OpenAI API 端点。
```bash
ping api.openai.com
```
如果您无法访问 OpenAI API 端点,您可以尝试在 UI 或环境变量中设置 `OPENAI_API_ENDPOINT`。
</p>
</details>
<details><summary>You exceeded your current quota, please check your plan and billing details</summary>
<p>
![openai quota](https://raw.githubusercontent.com/sqlchat/sqlchat/main/public/error-exceed-openai-quota.webp)
这个表示你自己提供的 OpenAI Key 的 Quota 没有了
</p>
</details>

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

BIN
public/error-network.webp Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB