json-autocomplete/README.md

Complete unfinished JSON streamed in by LLMs (Like OpenAI's GPT)

# JSON Autocomplete

### Lightweight (1KB) and dependency-free

JSON Autocomplete is designed to complete incomplete JSON strings. It's especially effective for handling partial outputs from Large Language Models (LLMs) like OpenAI's GPT.

![Streaming example](imgs/example.gif)

## Installation

Install using npm:

```bash
npm install json-autocomplete
```

Or using Yarn:

```bash
yarn add json-autocomplete
```

## Usage

Import `jsonAutocomplete` and pass incomplete JSON strings to get them completed:

```javascript
const jsonAutocomplete = require("json-autocomplete");

// Completing LLM Output
const incompleteLLMOutput = '{"items":[{"name":"Appl';
console.log(jsonAutocomplete(incompleteLLMOutput)); // Outputs: {"items":[{"name":"Appl"}]}

// Handling Incomplete Keys
const incompleteKeyJson = '{"user":{"id":123,"nam';
console.log(jsonAutocomplete(incompleteKeyJson)); // Outputs: {"user":{"id":123}}
```

## Features

- Optimized for completing JSON from LLMs like OpenAI's GPT.
- Handles a wide range of incomplete JSON formats.
- Lightweight (1KB) and dependency-free.

## Contributing

Your contributions are welcome! For bug fixes, improvements, or feature additions, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Socials

Follow us on Twitter!

[![Twitter Follow](https://img.shields.io/twitter/follow/JoelTankard?style=social)](https://twitter.com/JoelTankard)
[![Twitter Follow](https://img.shields.io/twitter/follow/hamzehloui_m?style=social)](https://twitter.com/hamzehloui_m)