https://github.com/luismisanve/geminipostsql_api
REST API that uses AI to translate natural language to PostgreSQL queries
https://github.com/luismisanve/geminipostsql_api
ai asp-net-core database gemini gemini-api newtonsoft-json npgsql pgadmin4 postgresql rest-api restsharp visual-studio
Last synced: 3 months ago
JSON representation
REST API that uses AI to translate natural language to PostgreSQL queries
- Host: GitHub
- URL: https://github.com/luismisanve/geminipostsql_api
- Owner: LuisMiSanVe
- License: apache-2.0
- Created: 2024-10-18T11:35:01.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T17:23:47.000Z (9 months ago)
- Last Synced: 2025-05-07T22:35:25.851Z (8 months ago)
- Topics: ai, asp-net-core, database, gemini, gemini-api, newtonsoft-json, npgsql, pgadmin4, postgresql, rest-api, restsharp, visual-studio
- Language: C#
- Homepage:
- Size: 2.21 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.es.md
- License: LICENSE
Awesome Lists containing this project
README
> [Ver en inglés/See in english](https://github.com/LuisMiSanVe/GeminiPostSQL_API/tree/main)
# 
GeminiPostSQL API | REST API para PostgreSQL Asistida por IA
[](https://dotnet.microsoft.com/en-us/languages/csharp)
[](https://dotnet.microsoft.com/en-us/learn/dotnet/what-is-dotnet)
[](https://www.postgresql.org/)
[](https://www.newtonsoft.com/json)
[](https://github.com/domaindrivendev/Swashbuckle.AspNetCore)
[](https://aistudio.google.com/app/apikey)
[](https://visualstudio.microsoft.com/)
>[!NOTE]
> Dale un vistazo a las otras versiones del programa:
>- [WinForms](https://github.com/LuisMiSanVe/GeminiPostSQL/tree/main)
>- [ChatBot](https://github.com/LuisMiSanVe/GeminiPostSQL_ChatBot/tree/main)
>- [NuGet](https://github.com/LuisMiSanVe/GeminiPostSQL_NuGet/tree/main)
>- [Android](https://github.com/LuisMiSanVe/GeminiLiteSQL/tree/main)
Esta REST API usa la IA de Google 'Gemini 2.0 Flash' para generar consultas a bases de datos PostgreSQL.
La IA convierte lenguaje natural a consultas SQL usando dos métodos diferentes, cada uno con sus ventajas y desventajas.
## 📋 Prerequisitos
Para que la API funcione, necesiatarás un servidor PostgreSQL y una clave de la API de Gemini.
> [!NOTE]
> Yo usaré pgAdmin para montar el servidor PostgreSQL.
## 🛠️ Instalación
Si no lo tienes, descarga [pgAdmin 4 desde su página ofical](https://www.pgadmin.org/download/).
Ahora, crea el servidor y monta la base de datos con algunas tablas y valores.
Después, obten tu clave de la API de Gemini yendo aqui: [Google AI Studio](https://aistudio.google.com/app/apikey). Asegurate de tener tu sesión de Google abierta, y encontes dale al botón que dice 'Crear clave de API' y sigue los pasos para crear tu proyecto de Google Cloud y conseguir tu clave de API. **Guardala en algún sitio seguro**.
Google permite el uso gratuito de esta API sin añadir ninguna forma de pago, pero con algunas limitaciones.
En Google AI Studio, puedes monitorizar el uso de la IA haciendo clic en 'Ver datos de uso' en la columna de 'Plan' en la tabla con todos tus proyectos. Recomiendo monitorizarla desde la pestaña de 'Cuota y límites del sistema' y ordenando por 'Porcentaje de uso actual', ya que es donde más información obtienes.
Ya tienes todo para hacer funcionar la REST API.
Simpemente reemplaza los valores por defecto del string 'database' en [AIAPI/Controllers/AIController.cs](https://github.com/LuisMiSanVe/AI_DB_REST_API/blob/main/AIAPI/Controllers/AIController.cs) con la información de tu base de datos, y poner la clave de API en el string 'apiKey'.
## 📖 Sobre la REST API
La API tiene un Controlador con dos endpoints:
- **[AIDatabaseMapping](https://gist.github.com/LuisMiSanVe/2da8e2d932a06ef408b3ee8468d0d820)**
Mapea la base de datos entera en un JSON la cual Gemini analiza para devolver la tabla que correspondría la solicitud enviada.
Debido a la naturaleza del método, bases de datos muy grandes puedes sobrepasar los recursos del sistema. Para prevenir esto, hay parametros para limitar que tantas filas aprende Gemini.
Toda la información recogida está generada directamente por la IA, por lo que es posible que haya información inventada. Para verificarlo, hay un parametro que hace que la IA genere la SQL necesaria para que devuelva esa tabla, la cual puedes correr en tu servidor PostgreSQL para comprobarla vericidad de los datos.
- **AIDatabaseSQL**
Este método mapea la estructura de la base de datos en un JSON que Gemini analiza para crear una consulta SQL, la cual es ejecutada por el servidor PostgreSQL directamente.
Ya que este método no mapea los valores de la base de datos el uso de tokens es menor, y los datos que devuelve son mas fiables pues es el mismo Servidor el que los devuelve. Sin embargo, no evita completamente los errores que cometa la IA. A veces, la consulta SQL fallará debido a que la IA se inventa columnas que no existen, en ese caso el endpoint devolverá la consulta generada para que identifiques el fallo.
## 💻 Tecnologías usadas
- Lenguaje de programación: [C#](https://dotnet.microsoft.com/es-es/languages/csharp)
- Framework: [ASP.NET Core](https://dotnet.microsoft.com/es-es/apps/aspnet) (creado con el Framework [.Net](https://dotnet.microsoft.com/es-es/learn/dotnet/what-is-dotnet) 8.0)
- Paquetes NuGet:
- [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) (6.4.0)
- [Swashbuckle.AspNetCore.Annotations](https://github.com/domaindrivendev/Swashbuckle.AspNetCore?tab=readme-ov-file#swashbuckleaspnetcoreannotations) (6.6.2)
- [Npgsql](https://www.npgsql.org/) (8.0.5)
- [RestSharp](https://restsharp.dev/) (112.1.0)
- [Newtonsoft.Json](https://www.newtonsoft.com/json) (13.0.3)
- Otras herramientas:
- [PostgreSQL](https://www.postgresql.org/) (16.3)
- [pgAdmin 4](https://www.pgadmin.org/) (8.9)
- Gemini API Key (2.0 Flash)
- IDE Recomendado: [Visual Studio](https://visualstudio.microsoft.com/) 2022