Simple Simplifier API

Simply Simplify German Language -- API Version

This is a simplified version of our Language Simplification Tool.

With this version you can pip install the core functionality and use language simplification via GPT-4o as a package. The API is built with FastAPI and can be used to simplify German language text in production environments where you want to integrate programmatically with other services.

Usage

• Create a Conda environment: conda create -n simplifier python=3.9
• Activate the environment: conda activate simplifier
• Clone this repository. Change into the project directory.
• Install the requirements: pip install -r requirements.txt
• Export the OpenAI API key as an environment variable: export OPENAI_API_KEY=your-api-key

Install the Simplifier as a package

• pip install git+https://github.com/rnckp/simple-simplifier
• Alternatively invoke from the cloned project directory: python -m pip install .

Start the FastAPI server

• uvicorn fastapi_app:app --reload

Test the API

• Open the notebook simple-simplifier.ipynb and follow the instructions.

Feedback and Contributions

Please share your feedback. You can write an email or share your ideas by opening an issue or a pull requests.

Please note, we use Ruff for linting and code formatting with default settings.