# openai-debugger

> Use OpenAI's API to help solve error messages

Latest version **1.0.5** (published 2023-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install openai-debugger
pnpm add openai-debugger
yarn add openai-debugger
bun add openai-debugger
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2023-08-11 |
| First published | 2023-08-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Erik Newland |
| Maintainers | eriknewland |
| Keywords | openai, chatgpt, llm, debugger, devtool, console, log, debugging, ai, artificial intelligence, logger, error, error logger, natural language processing, chat-gpt-4, chat-gpt-3, machine learning |

## Links

- npm: https://www.npmjs.com/package/openai-debugger
- Repository: https://github.com/eriknewland/openai-debugger
- Homepage: https://github.com/eriknewland/openai-debugger#readme
- Issues: https://github.com/eriknewland/openai-debugger/issues
- npm.io page: https://npm.io/package/openai-debugger

## Dependencies (1)

- [axios](https://npm.io/package/axios.md) ^1.4.0

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2023-08-11
- 1.0.4 — 2023-08-11
- 1.0.3 — 2023-08-09
- 1.0.2 — 2023-08-08
- 1.0.1 — 2023-08-07
- 1.0.0 — 2023-08-07

## README

# openai-debugger

Debug your client and server errors with OpenAI's API. Written in typescript, designed to be used as a dev dependency only.

![TypeScript](https://img.shields.io/static/v1?style=for-the-badge&message=TypeScript&color=3178C6&logo=TypeScript&logoColor=FFFFFF&label=)

![openai-debugger-browser](https://github.com/eriknewland/openai-debugger/assets/114263701/ec5f3d50-c3fd-4efd-9a25-224a048d1d30)
![openai-debugger-node](https://github.com/eriknewland/openai-debugger/assets/114263701/fa2de870-aed1-4545-9308-2efe62f1b7f4)

## Installation:

```bash
npm install -D openai-debugger
```

## Methods

1. errorHandlerNode(options)

- Handles errors in Node environments

2. errorHandlerBrowser(options)

- Handles errors in Browser environment

### Options Configuration

Options object is required, though most parameters are optional. See the official [openAI API docs](https://platform.openai.com/docs/api-reference/chat) for more info

| Option            | Type              | Description                           | Default  |
| ----------------- | ----------------- | ------------------------------------- | -------- |
| apiKey            | string            | Your OpenAI API key                   | -        |
| model             | string            | Model name                            | -        |
| temperature       | number (optional) | Model temperature ranging from 0 to 2 | 0.2      |
| top_p             | number (optional) | Controls sampling                     | 1        |
| n                 | number (optional) | Number of replies                     | 1        |
| max_tokens        | number (optional) | Maximum reply length                  | Infinity |
| presence_penalty  | number (optional) | Penalize repetition. Range 0-2        | 0        |
| frequency_penalty | number (optional) | Penalize repetition. Range 0-2        | 0        |

### Example Usage (Node)

```javascript
import { errorHandlerNode, errorHandlerBrowser } from  ('openai-debugger')

const optionsObj = {
  apiKey: '...',
  model: 'gpt-3.5-turbo',
  temperature: 0.1,
};

errorHandlerNode(optionsObj)
```

### Example Usage (Browser)

```javascript
import { errorHandlerNode, errorHandlerBrowser } from  ('openai-debugger')

const optionsObj = {
  apiKey: '...',
  model: 'gpt-3.5-turbo',
  temperature: 0.1,
};

errorHandlerBrowser(optionsObj)
```

---
_Source: https://npm.io/package/openai-debugger · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._