openai.js - OpenAI API Documentation

Code

/**
 * @fileoverview Library for interacting with the OpenAI API.
 * Provides askAi, getCompletion, and getTokenUsage functions.
 */

const https = require('https');

/**
 * Sends a chat completion request to the OpenAI API.
 * 
 * @param {string} model - The model name (e.g., 'gpt-4o').
 * @param {string} token - OpenAI API key.
 * @param {string} systemPrompt - System message for context.
 * @param {string} message - User message.
 * @returns {Promise<Object>} Resolves with the full JSON response.
 */
async function askAi(model, token, systemPrompt, message) {
    const data = JSON.stringify({
        model: model,
        messages: [
            { role: "system", content: systemPrompt },
            { role: "user", content: message }
        ]
    });

    const options = {
        hostname: 'api.openai.com',
        path: '/v1/chat/completions',
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'Authorization': `Bearer ${token}`
        }
    };

    return new Promise((resolve, reject) => {
        const req = https.request(options, (res) => {
            let body = '';
            res.on('data', (chunk) => { body += chunk; });
            res.on('end', () => {
                try {
                    resolve(JSON.parse(body));
                } catch (err) {
                    reject(err);
                }
            });
        });

        req.on('error', (err) => {
            reject(err);
        });

        req.write(data);
        req.end();
    });
}

/**
 * Extracts the AI completion message from the API response.
 * 
 * @param {Object} json - The full JSON response from OpenAI.
 * @returns {string} The completion text or empty string if not found.
 */
function getCompletion(json) {
    if (json && json.choices && json.choices[0] && json.choices[0].message) {
        return String(json.choices[0].message.content || '');
    }
    return '';
}

/**
 * Extracts the total token usage from the API response.
 * 
 * @param {Object} json - The full JSON response from OpenAI.
 * @returns {number} Total tokens used, or 0 if not found.
 */
function getTokenUsage(json) {
    if (json && json.usage && typeof json.usage.total_tokens === 'number') {
        return json.usage.total_tokens;
    }
    return 0;
}

module.exports = { askAi, getCompletion, getTokenUsage };

Usage

/*
    @param model = String (e.g., 'gpt-4o')
    @param token = String (your OpenAI API key)
    @param systemPrompt = String (system-level prompt, e.g., 'You are an assistant.')
    @param message = String (user's prompt)
*/
const { askAi, getCompletion, getTokenUsage } = require('./openai');

const model = 'gpt-4o';
const token = 'your-openai-api-key';
const systemPrompt = 'You are an assistant.';
const message = 'What is the weather in Paris?';

async function main() {
    const res = await askAi(model, token, systemPrompt, message);
    console.log('Completion:', getCompletion(res));
    console.log('Token Usage:', getTokenUsage(res));
}

main();

Explanation

The openai.js library provides utilities for calling the OpenAI chat completion API.

Functions:

• askAi(model, token, systemPrompt, message):
  • Sends a chat request to the OpenAI API and returns the full JSON response.
• getCompletion(json):
  • Extracts the AI's message from the API response.
• getTokenUsage(json):
  • Returns total token count used for the request and response.

Parameters:

• model: OpenAI model name (e.g., gpt-4o).
• token: Your OpenAI API key.
• systemPrompt: Instruction for the system role.
• message: The user's message.

Output:
The askAi function returns a JSON object for use with getCompletion and getTokenUsage.