Prisma AI Extension

This project is a powerful extension for Prisma Client designed to seamlessly integrate the OpenAI API for generating Prisma queries from natural language inputs.

Installation

Install the extension by executing the following command in your terminal:

npm install --save prisma-ai-extension

Usage

Incorporate the extension into your code by importing it and passing it to the PrismaClient constructor. Here's an example in TypeScript:

• model: The OpenAI model to use. The default is gpt-4.
• pathToSchema: The path to the Prisma schema file.
• retry: Optional. Default is false. If true, the extension will retry the query generation in case of an error.
• debug: Optional. Default is false. If true, the extension will log the generated query to the console.
• readonly: Optional. Default is true. If true, the extension will not execute any methods that modify data.
• cache: Optional. Default is false. If true, the extension will cache the generated queries.

import { PrismaClient, User } from '@prisma/client';
import { PrismaAI } from 'prisma-ai-extension';

const prisma = new PrismaClient({
    errorFormat: 'pretty',
}).$extends(
    PrismaAI({
        model: 'gpt-4',
        pathToSchema: './prisma/schema.prisma',
        retry: true,
        debug: true,
        readonly: false,
        cache: true,
    }),
);

// User.create({"data":{"email":"test@example.com","name":"Test User","roleId":1}})
const { id } = await prisma.$queryAI<User>('create user');
// User.findUnique({"where":{"id":1},"include":{"posts":{"include":{"comments":true,"likes":true}}}})
const user = await prisma.$queryAI<User>(
    `find user with id ${id} and include posts and include comments and likes to each post and comment`,
);
console.log(user);