JIZT API (0.1.0)
Download OpenAPI specification:Download
Diego Miguel: jizt@diegomiguel.me URL: https://dmlls.github.io/jizt-website License: GPL-3.0 License
JIZT API provides an easy way of summarizing your text using state-of-the-art NLP models.
Summarize
Request a summary of a text.
Request Body schema: application/json
| source required | string The text to be summarized. |
| model | string Value: "t5-large" The model used to generate the summary. |
| language | string Value: "en" The language of the text. |
Responses
Request samples
- Payload
Content type
application/json
{- "source": "Natural Language Processing (NLP) is a subfield of Linguistics,\nComputer science, and Artificial Intelligence concerned with the\ninteractions between computers and human language, in particular\nhow to program computers to process and analyze large amounts of\nnatural language data.",
- "model": "t5-large",
- "params": {
- "relative_max_length": 0.4,
- "relative_min_length": 0.1,
- "do_sample": false,
- "early_stopping": false,
- "num_beams": 4,
- "temperature": 1,
- "top_k": 50,
- "top_p": 1,
- "repetition_penalty": 1,
- "length_penalty": 1,
- "no_repeat_ngram_size": 4
}, - "language": "en"
}Response samples
- 200
Content type
application/json
{- "summary_id": "b40d19c2af9c5096da9070c81b22e270660a1c6313b22427f7fc14dbcb0c2d38",
- "started_at": "2021-01-11T18:48:40.786Z",
- "ended_at": null,
- "status": "preprocessing",
- "output": null,
- "model": "t5-large",
- "params": {
- "relative_max_length": 0.4,
- "relative_min_length": 0.1,
- "do_sample": false,
- "early_stopping": false,
- "num_beams": 4,
- "temperature": 1,
- "top_k": 50,
- "top_p": 1,
- "repetition_penalty": 1,
- "length_penalty": 1,
- "no_repeat_ngram_size": 4
}, - "language": "en"
}Get summary
Return a summary by id.
path Parameters
| summaryId required | string The id of the summary. |
Responses
Response samples
- 200
- 404
Content type
application/json
{- "summary_id": "b40d19c2af9c5096da9070c81b22e270660a1c6313b22427f7fc14dbcb0c2d38",
- "started_at": "2021-01-11T18:48:40.786Z",
- "ended_at": "2021-01-11T18:54:57.425Z",
- "status": "completed",
- "output": "Natural Language Processing (NLP) is a subfield of Linguistics,\nComputer Science, and Artificial Intelligence.",
- "model": "t5-large",
- "params": {
- "relative_max_length": 0.4,
- "relative_min_length": 0.1,
- "do_sample": false,
- "early_stopping": false,
- "num_beams": 4,
- "temperature": 1,
- "top_k": 50,
- "top_p": 1,
- "repetition_penalty": 1,
- "length_penalty": 1,
- "no_repeat_ngram_size": 4
}, - "language": "en"
}