Download OpenAPI specification:Download
Jizt API provides an easy way of summarizing your text using state-of-the-art NLP models.
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.
Request a summary of a text.
source required | string The text to be summarized. |
model | string (Model) Value: "t5" The model used to generate the summary. |
language | string (Language) Value: "en" The language of the text. |
cache | boolean Whether to cache the summary or not. If set to |
{- "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": {
- "relative_max_length": 0.5,
- "relative_min_length": 0.1,
- "do_sample": true,
- "early_stopping": false,
- "num_beams": 4,
- "temperature": 1,
- "top_k": 4,
- "top_p": 1,
- "repetition_penalty": 1,
- "length_penalty": 1,
- "no_repeat_ngram_size": 4
}, - "language": "en",
- "cache": true
}
{- "summary_id": "80c83d77259f3c53394ceb67d85f2e0a9d289aeb86ad10ec1384d1ef75188591",
- "started_at": "2021-04-11T18:48:40.786775",
- "ended_at": null,
- "status": "preprocessing",
- "output": null,
- "model": "t5",
- "params": {
- "relative_max_length": 0.5,
- "relative_min_length": 0.1,
- "do_sample": true,
- "early_stopping": false,
- "num_beams": 4,
- "temperature": 1,
- "top_k": 4,
- "top_p": 1,
- "repetition_penalty": 1,
- "length_penalty": 1,
- "no_repeat_ngram_size": 4
}, - "language": "en",
- "warnings": { }
}
Return a summary by id.
summaryId required | string The id of the summary. |
curl https://api.jizt.it/v1/summaries/plain-text/80c83d77259f3c53394ceb67d85f2e0a9d289aeb86ad10ec1384d1ef75188591
{- "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": {
- "relative_max_length": 0.5,
- "relative_min_length": 0.1,
- "do_sample": true,
- "early_stopping": false,
- "num_beams": 4,
- "temperature": 1,
- "top_k": 4,
- "top_p": 1,
- "repetition_penalty": 1,
- "length_penalty": 1,
- "no_repeat_ngram_size": 4
}, - "language": "en"
}