khoj/documentation/docs/features/summarization.md
Raghav Tirumale 093eb473cb
Add Documentation for the /summarize Command (#822)
* added documentation for the /summarize command

* Add a hint for natural language usage

---------

Co-authored-by: sabaimran <narmiabas@gmail.com>
2024-06-20 12:08:01 +05:30

26 lines
959 B
Markdown

---
sidebar_position: 5
---
# File Summarization
You can use the `/summarize` command to get Khoj to generate context driven summaries of your documents.
Simply select a single file filter on the left panel menu and then use `/summarize [any context]` and Khoj
will produce a tailored summary of the text.
You can also try a natural language query which include the intent for summary without explicitly using the `/summarize` command.
## Design Diagram
<img src="/img/summarize.jpg" alt="Chat on Web" style={{width: '800px'}}/>
## Example Usage
* `/summarize in a way that can be used as practice questions for a test`
* `/summarize in a way a toddler can understand`
* `/summarize in one paragraph`
Without using the `/summarize` command:
* `create a summary of the document in a way that can be used as practice questions for a test`
* `summarize the document in a way a toddler can understand`
* `generate a one paragraph summary of the document`