Abbreviation Utility

Abbrevify is a tool designed to optimize text length by intelligently abbreviating full words and phrases. Perfect for developers looking to save on API costs (e.g GPT API), Abbrevify leverages advanced algorithms to condense your text while maintaining clarity and readability. Whether you're working with large datasets, sending messages, or generating content, Abbrevify ensures you get the most out of your text input with minimal characters.

Installation

You can install the package via npm:

npm install abbrevify

Usage

Example

const { abbrevify } = require('abbrevify');

async function processSentence() {
    try {
        const sentence = "I love you so much. It's true!";
        const abbreviatedSentence = await abbrevify(sentence);
        console.log('Original Sentence:', sentence);
        console.log('Abbreviated Sentence:', abbreviatedSentence);
    } catch (error) {
        console.error('Error:', error);
    }
}

processSentence();

CSV Dictionary Format

The module expects a CSV file (abbreviation_processed.csv) with two columns:

Example CSV content:

Abbreviation,Meaning
ILUSM,I love you so much
YAA,yet another acronym
abbr,abbreviation
auto,automatic
ex,example

Ensure your CSV file is formatted correctly for accurate abbreviation.

Contributing

Contributions are welcome! If you have improvements or feature requests, feel free to submit an issue or pull request.