VADIS summarization api

Requirements

• Python 3.10
• Poetry
  • A package manager for Python projects
  • Follow the official documentation for its installation

Setup

git clone git@github.com:vadis-project/vadis_summarization_api.git
cd vadis_summarization_api
poetry install

Configure

This API loads configuration from ./.env file. There is a sample included in this repository as ./.sample.env. You can start by copying this by cp ./sample.env ./.env. You can set AUTH_KEY to any string.

For LANGUAGE, pick one of en or de to change the language for summaries. If you set LANGUAGE="de", this API will return you summaries in German even for the English inputs.

Run

First, activate the enviroment created by poetry by running following,

poetry shell

Then, start the api, this may take some time for the first time because of model downloading,

uvicorn vadis_summarization_api.main:app

Try

While the app is running by the command above, you can access to the automatically generated documentations where you can actually try out the API. Just open the http://127.0.0.1:8000/docs. Make sure the app is running.

Translate German input

If you use /summarize end-point (which now only can process one document a time, no batch processing), it first detects the language that the document is written in, the if it's in German, it first translates into English, then summarize in English.