mirror of
https://github.com/imartinez/privateGPT.git
synced 2025-04-28 03:32:18 +00:00
8119842ae6
* feat: add summary recipe * test: add summary tests * docs: move all recipes docs * docs: add recipes and summarize doc * docs: update openapi reference * refactor: split method in two method (summary) * feat: add initial summarize ui * feat: add mode explanation * fix: mypy * feat: allow to configure async property in summarize * refactor: move modes to enum and update mode explanations * docs: fix url * docs: remove list-llm pages * docs: remove double header * fix: summary description
24 lines
1018 B
Plaintext
24 lines
1018 B
Plaintext
# Recipes
|
|
|
|
Recipes are predefined use cases that help users solve very specific tasks using PrivateGPT.
|
|
They provide a streamlined approach to achieve common goals with the platform, offering both a starting point and inspiration for further exploration.
|
|
The main goal of Recipes is to empower the community to create and share solutions, expanding the capabilities of PrivateGPT.
|
|
|
|
## How to Create a New Recipe
|
|
|
|
1. **Identify the Task**: Define a specific task or problem that the Recipe will address.
|
|
2. **Develop the Solution**: Create a clear and concise guide, including any necessary code snippets or configurations.
|
|
3. **Submit a PR**: Fork the PrivateGPT repository, add your Recipe to the appropriate section, and submit a PR for review.
|
|
|
|
We encourage you to be creative and think outside the box! Your contributions help shape the future of PrivateGPT.
|
|
|
|
## Available Recipes
|
|
|
|
<Cards>
|
|
<Card
|
|
title="Summarize"
|
|
icon="fa-solid fa-file-alt"
|
|
href="/recipes/general-use-cases/summarize"
|
|
/>
|
|
</Cards>
|