|
1 | | -# NodeJS-OpenAI-Function-Calling-Example |
| 1 | +# OpenAIFunctionCalling example in Node.js |
2 | 2 | This repository contains a basic Node.js example demonstrating how to call functions using the OpenAI API. The example showcases a conversation with the OpenAI GPT-3.5 Turbo model, including making function calls and processing their responses. |
| 3 | + |
| 4 | +## Getting Started |
| 5 | + |
| 6 | +**Dependencies**: This project has no external dependencies, making it lightweight and easy to set up. You can run this example with just Node.js. However, if you have a preferred library or tool for making HTTP requests, feel free to integrate it as needed to enhance the functionality or suit your specific requirements. |
| 7 | + |
| 8 | +To get started with this example: |
| 9 | + |
| 10 | +1. Clone this repository to your local machine: |
| 11 | + |
| 12 | + ```shell |
| 13 | + git clone <this-repo> |
| 14 | + ``` |
| 15 | + |
| 16 | +2. Obtain an API key from <a href="https://platform.openai.com/account/api-keys">OpenAI</a> |
| 17 | + |
| 18 | +3. Replace ```Bearer sk-xxxxxxxxx``` in the code with your API key. |
| 19 | + |
| 20 | +4. Run the example: |
| 21 | + |
| 22 | +```shell |
| 23 | +node index.js |
| 24 | +``` |
| 25 | + |
| 26 | +5. Customise the functions and conversation as needed. In this example, a simple weather-related function is included, but you can add more functions to suit your use case. |
| 27 | + |
| 28 | +## Usage |
| 29 | +This repository serves as a starting point for understanding how to integrate function calls into your conversational AI system using the OpenAI GPT-3.5 Turbo model. You can extend the example by adding more functions, handling different types of requests, and tailoring it to your specific application. |
| 30 | + |
| 31 | +## License |
| 32 | +This project is licensed under the MIT License - see the LICENSE file for details. |
0 commit comments