1.0.1 • Published 6 months ago

openai-free v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
6 months ago

openai-free šŸ¤–

A free OpenAI-compatible API client that doesn't require API keys.

Installation

npm install openai-free

Basic Usage

const OpenAI = require('openai-free');
const openai = new OpenAI();

async function chat() {
    try {
        const response = await openai.chat.completions.create({
            messages: [
                { role: 'user', content: 'Hello!' }
            ]
        });
        
        console.log(response.choices[0].message.content);
    } catch (error) {
        console.error('Error:', error.message);
    }
}

chat();

API Methods

Chat Completion

const response = await openai.chat.completions.create({
    messages: [
        { role: 'user', content: 'What is JavaScript?' }
    ]
});

List Models

const models = await openai.models.list();
console.log(models.data);

Get Model Info

const modelInfo = await openai.models.retrieve('gpt-4o');
console.log(modelInfo);

Available Models

  • gpt-4o (default)
  • gpt-4o-mini

Parameters

ParameterTypeDefaultDescription
messagesArray[]Array of message objects
modelString'gpt-4o'Model ID
temperatureNumber0.5Response randomness (0-1)
max_tokensNumber4000Maximum response length
top_pNumber1Nucleus sampling (0-1)
frequency_penaltyNumber0Repetition reduction (0-2)
presence_penaltyNumber0Topic control (0-2)
streamBooleanfalseStream response

Custom Configuration

const openai = new OpenAI({
    baseURL: 'your-custom-url' // Optional: Override default API endpoint
});

Error Handling

try {
    const response = await openai.chat.completions.create({
        messages: [{ role: 'user', content: 'Hello!' }]
    });
} catch (error) {
    console.error('Error:', error.message);
}

šŸ› Bug Reports

Found a bug? Please open an issue with: 1. Bug description 2. Steps to reproduce 3. Expected vs actual behavior

šŸ“ License

MIT Ā© Jr Busaco (JrDev06)

šŸ‘Øā€šŸ’» Author

Jr Busaco (JrDev06)


šŸ’” Need help? Feel free to reach out on Facebook or open an issue.

1.0.1

6 months ago

1.0.0

6 months ago