Skip to main content

Agent Plugins: Reference Starters

Document Summary

diagram-summarize.png

The Document Summary plugin leverages a moving context window to analyze the entirety of your documents, providing concise and informative summaries.

When you request a summary, the plugin meticulously scans each document with a sliding context window, extracting key points, arguments, and findings.
The plugin can adapt its summary length to your needs, whether you require a quick overview or a more detailed synopsis.

This agent plugin is backed by LiteLLM for request generalization to LLM services, so any of the LiteLLM providers should be compatible with the plugin.

We also recommend having a look at our Document Lookup plugin for another methdaology for looking up specific facts within your document.

Setting up your agent

  • After setting up your system, navigate to the "Add Panel" section and select your Document Summary plugin.
  • Choose your desired Model from the list of available options.
  • Choose a Simple Model - this one can use a cheaper model and will be used for things like titling your threads.
  • Set the overall Context Size for the model which you are connecting to.
  • Set how much of the overall Context Size you'd like to use for document context for grounding (using Document Context Size).
  • Set a System Message, this will help guide your model if you'd like it to behave a certain way or do something specific.
  • Set your LLM Model API Key for your model's API key.
  • If you need to set a specific URL Base, this is available in the settings area.

Once you've added your API key, your agent will be ready to use!

Making requests using /summary command

To activate the summary action on one of your documents:

  • Use the /summary command in your chat
  • Followed by your document filename /file filename.pdf
  • And then any additional questions you have to add the documents to your context when chatting.

An example prompt with the command would look like:

/summary /file filename.pdf Could you highlight in your summary any areas where they mention billables?

Review the code

Want to review how this model is made, or use it as the base to creating a new agent plugin?

You can find the code that powers this plugin available here:
https://github.com/promptpanel/promptpanel/tree/main/plugins/rag_lookup