This repository has been archived by the owner on Oct 14, 2024. It is now read-only.
docs: Differences between Instructions, Prompt template & Retrieval template and how to use them #13
Labels
type: documentation
Improvements or additions to documentation
Hi,
First of all thank you for this great tool!
Pages
I would like to suggest an addition to the documentation on jan.ai . I personally do not really understand the difference and usage of “Instructions” (Assistant), “Prompt template” (Model parameters) and “Retrieval template” (Tools).
A matching place in the existing documentation for this could be under:
Developer -> Build an Assistant -> Your First Assistant OR Anatomy of an Assistant
Success Criteria
A comprehensive overview of the given options that describe how they work and how to use them. I know that there are differences between models, therefore it would be good to keep it general and focus on explaining the spheres of influence for each of the options.
Specifics
Specifics regarding instructions:
A nice-to-have would be an example of a well working instructions body, or a further reading reference on how to craft them.
Specifics regarding Retrieval template:
Does it make a difference which of the following formats is chosen?
Example:
CONTEXT: (This is the context body.)
CONTEXT: This is the context body.
If there already exists a documentation regarding these questions/ suggestions, please feel free to correct me and point me towards them!
If can try to research the details for the first draft myself, but someone who has a more in-depth understanding of the inner workings needs to validate and/ or correct it before publishing. Let me know if you want me to proceed.
The text was updated successfully, but these errors were encountered: