https://github.com/joangeldelarosa/aiquery
Interact with your databases using OpenAI Natural Language Processing (NPL)
https://github.com/joangeldelarosa/aiquery
ai artificial-intelligence mongodb mongoose openai query typescript
Last synced: 2 months ago
JSON representation
Interact with your databases using OpenAI Natural Language Processing (NPL)
- Host: GitHub
- URL: https://github.com/joangeldelarosa/aiquery
- Owner: Joangeldelarosa
- Created: 2023-04-03T00:17:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-03T19:34:38.000Z (about 2 years ago)
- Last Synced: 2025-04-24T01:08:17.491Z (2 months ago)
- Topics: ai, artificial-intelligence, mongodb, mongoose, openai, query, typescript
- Language: TypeScript
- Homepage:
- Size: 9.12 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# AIQuery
AIQuery is a powerful TypeScript library that simplifies the process of interacting with a MongoDB database by allowing users to make advanced queries using natural language text. It utilizes the OpenAI GPT-3 model by default to generate executable TypeScript code based on the given query, roles, schemas, and database type, allowing for flexible and dynamic database interactions.
## Features
- Perform complex database operations using natural language queries
- Role-based access control for secure and controlled database interactions
- Utilizes OpenAI GPT-3 model by default for code generation
- Supports MongoDB with Mongoose
- Easily extensible for different databases and AI models in the future
## Installation
```bash
npm install aiquery
```
## Usage
```typescript
import { MongoClient } from 'mongodb'
import AIQuery from 'aiquery'
// Connect to your MongoDB instance
const client = new MongoClient('mongodb://localhost:27017/default')
await client.connect()
// Define your schemas and roles
const schemas = {
users: {
name: String,
age: Number
}
}
const roles = ['admin', 'user']
/* Instantiate AIQuery
* @param apiKey - The API key for OpenAI
* @param client - A connected MongoClient instance
* @param schemas - A JSON object containing the schemas for the database
* @param roles - A list of allowed roles
* @param apiModel - The API model for OpenAI (default: "text-davinci-003")
* @param dbName - The name of the database (default: "default")
* @param additionalLogic - Any additional logic to be provided to the AI model (default: "None")
* @example const query = new AIQuery(apiKey, client, schemas, ["admin", "user"], "default", "text-davinci-003", "None");
*/
const apiKey = 'your_openai_api_key'
const query = new AIQuery(
apiKey,
client,
schemas,
roles,
)
// Process a natural language query
const result = await query.processQuery(
'Find all users with age greater than 20',
'admin'
)
console.log(result)
```
## Future Updates
- Support for different databases and AI models
- Improved validation and security for generated code
- Enhanced error handling and debugging
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue to discuss any improvements or suggestions.
## License
AIQuery is released under the MIT License.