├── .env ├── .gitignore ├── README.md ├── app.ts ├── controllers └── index.ts ├── package.json ├── run.gif └── tsconfig.json /.env: -------------------------------------------------------------------------------- 1 | API_KEY=your_api_key_goes_here 2 | PORT=3000 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### macOS ### 2 | # General 3 | .DS_Store 4 | .AppleDouble 5 | .LSOverride 6 | 7 | ### Node ### 8 | # Logs 9 | logs 10 | *.log 11 | npm-debug.log* 12 | yarn-debug.log* 13 | yarn-error.log* 14 | lerna-debug.log* 15 | 16 | # Dependency directories 17 | node_modules/ 18 | package-lock.json 19 | 20 | # TypeScript v1 declaration files 21 | typings/ 22 | 23 | # TypeScript cache 24 | *.tsbuildinfo 25 | 26 | # Optional npm cache directory 27 | .npm 28 | 29 | # js build / generate output 30 | dist 31 | .env.dev 32 | 33 | ### VisualStudioCode ### 34 | .vscode/* 35 | !.vscode/settings.json 36 | !.vscode/tasks.json 37 | !.vscode/launch.json 38 | !.vscode/extensions.json 39 | *.code-workspace 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ChatGPT NodeJS .TS Api 2 | 3 | This project includes the boilerplate to interact with ChatGPT from a basic rest-api made in Node.js with Express + Typescript. 4 | 5 | ## Basic Requirements 6 | 7 | 1. Install Node.js [https://nodejs.org/en/download/](https://nodejs.org/en/download/) 8 | 2. Install `TypeScript` 9 | 10 | ```sh 11 | npm install -g typescript 12 | ``` 13 | 14 | 3. Install required dependencies 15 | 16 | ```sh 17 | npm install 18 | ``` 19 | 20 | 4. Get an OpenAI API key: [https://beta.openai.com/signup/](https://beta.openai.com/signup/) 21 | 5. Update your `.env` file with your API_KEY 22 | 23 | ## Build and Run 24 | 25 | To build js from typescript source. 26 | 27 | ```sh 28 | npm run build 29 | ``` 30 | 31 | To start the server from the compiled folder (/dist). 32 | 33 | ```sh 34 | npm run start 35 | ``` 36 | 37 | ## Demo 38 | 39 | ![Demo](run.gif) 40 | -------------------------------------------------------------------------------- /app.ts: -------------------------------------------------------------------------------- 1 | import express from "express"; 2 | import bodyParser from "body-parser"; 3 | import dotenv from "dotenv"; 4 | import { generateResponse } from "./controllers"; 5 | 6 | dotenv.config(); 7 | 8 | const app = express(); 9 | const port = process.env.PORT; 10 | app.use(bodyParser.json()); 11 | 12 | app.post("/generate", generateResponse); 13 | 14 | app.listen(port, () => { 15 | console.log(`Server running on port ${port}`); 16 | }); 17 | -------------------------------------------------------------------------------- /controllers/index.ts: -------------------------------------------------------------------------------- 1 | import { Request, Response } from "express"; 2 | import { OpenAIApi, Configuration } from "openai"; 3 | import dotenv from "dotenv"; 4 | 5 | dotenv.config(); 6 | 7 | // OpenAIApi required config 8 | const configuration = new Configuration({ 9 | apiKey: process.env.API_KEY, 10 | }); 11 | 12 | // OpenAIApi initialization 13 | const openai = new OpenAIApi(configuration); 14 | 15 | //These arrays are to maintain the history of the conversation 16 | const conversationContext = []; 17 | const currentMessages = []; 18 | 19 | // Controller function to handle chat conversation 20 | export const generateResponse = async (req: Request, res: Response) => { 21 | try { 22 | const { prompt } = req.body; 23 | const modelId = "gpt-3.5-turbo"; 24 | const promptText = `${prompt}\n\nResponse:`; 25 | 26 | // Restore the previous context 27 | for (const [inputText, responseText] of conversationContext) { 28 | currentMessages.push({ role: "user", content: inputText }); 29 | currentMessages.push({ role: "assistant", content: responseText }); 30 | } 31 | 32 | // Stores the new message 33 | currentMessages.push({ role: "user", content: promptText }); 34 | 35 | const result = await openai.createChatCompletion({ 36 | model: modelId, 37 | messages: currentMessages, 38 | }); 39 | 40 | const responseText = result.data.choices.shift().message.content; 41 | conversationContext.push([promptText, responseText]); 42 | res.send({ response: responseText }); 43 | } catch (err) { 44 | console.error(err); 45 | res.status(500).json({ message: "Internal server error" }); 46 | } 47 | }; 48 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "chat-gpt-nodejs", 3 | "version": "1.0.0", 4 | "description": "NodeJS REST-API to interact with OpenAI", 5 | "main": "app.js", 6 | "scripts": { 7 | "build": "rm -rf dist/* && tsc", 8 | "start": "node dist/app.js" 9 | }, 10 | "author": "Pablo Blanco", 11 | "license": "ISC", 12 | "dependencies": { 13 | "body-parser": "^1.20.2", 14 | "dotenv": "^16.0.3", 15 | "express": "^4.18.2", 16 | "openai": "^3.2.1" 17 | }, 18 | "devDependencies": { 19 | "@types/body-parser": "^1.19.2", 20 | "@types/express": "^4.17.17", 21 | "@types/node": "^18.15.3" 22 | } 23 | } -------------------------------------------------------------------------------- /run.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rootstrap/chat-gpt-nodejs/02638240437b06254e19aa98f0957cb99cec7f89/run.gif -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Visit https://aka.ms/tsconfig to read more about this file */ 4 | 5 | /* Projects */ 6 | // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ 7 | // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ 8 | // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ 9 | // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ 10 | // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ 11 | // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ 12 | 13 | /* Language and Environment */ 14 | "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, 15 | // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ 16 | // "jsx": "preserve", /* Specify what JSX code is generated. */ 17 | // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ 18 | // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ 19 | // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ 20 | // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ 21 | // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ 22 | // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ 23 | // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ 24 | // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ 25 | // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ 26 | 27 | /* Modules */ 28 | "module": "commonjs" /* Specify what module code is generated. */, 29 | // "rootDir": "./", /* Specify the root folder within your source files. */ 30 | "moduleResolution": "node" /* Specify how TypeScript looks up a file from a given module specifier. */, 31 | // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ 32 | // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ 33 | // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ 34 | // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ 35 | // "types": [], /* Specify type package names to be included without being referenced in a source file. */ 36 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 37 | // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ 38 | // "resolveJsonModule": true, /* Enable importing .json files. */ 39 | // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ 40 | 41 | /* JavaScript Support */ 42 | // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ 43 | // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ 44 | // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ 45 | 46 | /* Emit */ 47 | // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ 48 | // "declarationMap": true, /* Create sourcemaps for d.ts files. */ 49 | // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ 50 | // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ 51 | // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ 52 | "outDir": "dist/" /* Specify an output folder for all emitted files. */, 53 | // "removeComments": true, /* Disable emitting comments. */ 54 | // "noEmit": true, /* Disable emitting files from a compilation. */ 55 | // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ 56 | // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ 57 | // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ 58 | // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ 59 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 60 | // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ 61 | // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ 62 | // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ 63 | // "newLine": "crlf", /* Set the newline character for emitting files. */ 64 | // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ 65 | // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ 66 | // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ 67 | // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ 68 | // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ 69 | // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ 70 | 71 | /* Interop Constraints */ 72 | // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ 73 | "allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */, 74 | "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, 75 | // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ 76 | "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, 77 | 78 | /* Type Checking */ 79 | "strict": false /* Enable all strict type-checking options. */, 80 | // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ 81 | // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ 82 | // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ 83 | // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ 84 | // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ 85 | // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ 86 | // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ 87 | // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ 88 | // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ 89 | // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ 90 | // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ 91 | // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ 92 | // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ 93 | // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ 94 | // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ 95 | // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ 96 | // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ 97 | // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ 98 | 99 | /* Completeness */ 100 | // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ 101 | "skipLibCheck": true /* Skip type checking all .d.ts files. */ 102 | } 103 | } 104 | --------------------------------------------------------------------------------