openai-api-helper

openai-api-helper is a user-friendly library designed to simplify interactions with the OpenAI API. With minimal setup, you can quickly start making requests to OpenAI's chat completions endpoint. 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.
Flexible Response Handling: Choose between complete JSON responses or simplified message string outputs.
PromptBuilder (Beta): Efficiently construct prompts with background, context, instructions, and examples.

Documentation

Click here for Documentation

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-3.5-turbo"; // or your preferred model
	const prompt =
		"Explain the concept of artificial intelligence in simple terms.";

	const openai = new OpenAIAPIHelper(apiKey);

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

main();

TypeScript Example

import OpenAIAPIHelper from "openai-api-helper";

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

async function test() {
	const model = "gpt-3.5-turbo";
	const prompt =
		"What are the main differences between machine learning and deep learning?";

	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();

PromptBuilder (Beta)

The PromptBuilder class allows users to construct prompts efficiently. It includes options for adding background, context, instructions, and examples combined with user input.

const { PromptBuilder } = require("openai-api-helper");

const builder = new PromptBuilder()
	.addBackground(
		"You are an AI assistant specialized in explaining technical concepts."
	)
	.addContext("The user is a beginner in computer science.")
	.addInstructions(
		"Explain the concept in simple terms, using analogies where appropriate."
	)
	.addExample(
		"Q: What is a variable?\nA: A variable is like a labeled box where you can store information. Just as you might put toys in a box labeled 'Toys', you can put data in a variable with a specific name."
	)
	.addUserInput("What is an algorithm?");

console.log(builder.build());

Refer to the test files in the repository for more detailed usage examples.

API Reference