JIZT Main Page
Documentation Powered by ReDoc

Jizt REST API - AI Summarization (0.1.0)

Download OpenAPI specification:Download

Diego Miguel: contact@jizt.it URL: https://www.jizt.it License: GPL-3.0 License

Jizt API provides an easy way of summarizing your text using state-of-the-art NLP models.

Summaries

Requesting a summary is a two-step process.

First, an HTTP POST request should be made (see "Summarize"). The server will respond with a summary_id for your text.

Then, periodic HTTP GET requests (see "Get summary") with the previous summary_id should be made until the summary is completed. The response will then contain the summary.

Please, keep in mind that the summarization process will likely take several seconds.

Summarize

Request a summary of a text.

Request Body schema: application/json
source
required
string

The text to be summarized.

model
string (Model)
Value: "t5"

The model used to generate the summary.

object (Params)

The summary generation parameters.

More info on the generation process here.
language
string (Language)
Value: "en"

The language of the text.

cache
boolean

Whether to cache the summary or not. If set to false, the summary will be deleted once it has been completed and a GET request with its id has been made once. The generated summary is automatically deleted if the GET request is not made within 5 minutes after having requested it via POST. If set to true, future requests with the same source text will be immediate, since the summary will be cached. If the source text contains sensitive information, it is recommended to set this attribute to false. If not, setting it to true helps speed up the service thanks to caching.

Responses

Request samples

Content type
application/json
{
  • "source": "Jizt makes use of the latest advances in Natural Language Processing (NLP),\nusing state-of-the-art language generation models, such as Google's T5 model, to\nprovide accurate and complete abstractive summaries.",
  • "model": "t5",
  • "params": {
    },
  • "language": "en",
  • "cache": true
}

Response samples

Content type
application/json
{
  • "summary_id": "80c83d77259f3c53394ceb67d85f2e0a9d289aeb86ad10ec1384d1ef75188591",
  • "started_at": "2021-04-11T18:48:40.786775",
  • "ended_at": null,
  • "status": "preprocessing",
  • "output": null,
  • "model": "t5",
  • "params": {
    },
  • "language": "en",
  • "warnings": { }
}

Get summary

Return a summary by id.

path Parameters
summaryId
required
string

The id of the summary.

Responses

Request samples 

curl https://api.jizt.it/v1/summaries/plain-text/80c83d77259f3c53394ceb67d85f2e0a9d289aeb86ad10ec1384d1ef75188591

Response samples

Content type
application/json
{
  • "summary_id": "80c83d77259f3c53394ceb67d85f2e0a9d289aeb86ad10ec1384d1ef75188591",
  • "started_at": "2021-04-11T18:48:40.786775",
  • "ended_at": "2021-04-11T18:54:57.425985",
  • "status": "completed",
  • "output": "Natural Language Processing (NLP) is a subfield of Linguistics,\nComputer Science, and Artificial Intelligence.",
  • "model": "t5",
  • "params": {
    },
  • "language": "en"
}

Health check

Check the current server health status.

Responses