openai-api-helper

openai-api-helper is a user-friendly library designed to simplify interactions with the OpenAI API. With minimal setup, you can start making requests to OpenAI's chat completions endpoint quickly and easily. This package provides a straightforward way to integrate OpenAI's powerful language models into your applications with just a few lines of code.

Key Features

Easy Setup: Initialize with your OpenAI API key and get started in minutes. Simplified API Calls: Use a single method to make requests and handle responses effortlessly.

Installation

Install openai-api-helper using npm:

npm install openai-api-helper

Usage

Basic Example Here’s how to use openai-api-helper to interact with the OpenAI API:

const OpenAIAPIHelper = require('openai-api-helper').default;

async function main() {
    const apiKey = 'YOUR_OPENAI_API_KEY';
    const model = 'GPT_MODEL';
    const prompt = 'YOUR_PROMPT';

    const openai = new OpenAIAPIHelper(apiKey);

    try {
        const response = await openai.call(model, prompt, 0.8,1);
        console.log('Response from OpenAI:', response);
    } catch (error) {
        console.error('Error:', error);
    }
}

main();

// index.ts
import OpenAIAPIHelper from 'openai-api-helper';

const apiKey = 'YOUR_OPENAI_API_KEY';
const openai = new OpenAIAPIHelper(apiKey);

async function test() {
    const model = 'GPT_MODEL';
    const prompt = 'YOUR_PROMPT';
    
    try {
        const response = await openai.call(model, prompt, 0.7, 1);
        console.log('Response from OpenAI:', response);
    } catch (error) {
        console.error('Error calling OpenAI API:', error);
    }
}

test();

Call Method

The call method sends a request to the OpenAI API and returns the response.

model: Specify the GPT model (e.g., 'gpt-4o-mini'). prompt: Provide the text prompt for the model. temperature (optional): Adjust the randomness of the response (default is 0.7). responseType (optional): Format your response json. (0 for complete json response, 1 for message string reponse. default is 1)

Testing

You can find a sample usage files in the repository (test dir) for testing purposes: test.js: Contains example JavaScript code demonstrating how to use the openai-api-helper library. test.ts: Contains example TypeScript code demonstrating how to use the openai-api-helper library.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please fork the repository and submit pull requests or open issues to suggest improvements. Ensure that your code follows the project's coding standards and includes appropriate tests.