Skip to content
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

Open
n3ur0mancer opened this issue Mar 11, 2024 · 0 comments
Labels
type: documentation Improvements or additions to documentation

Comments

@n3ur0mancer
Copy link

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.

  • How does the respective setting influence the responses of the model?
  • How to use them correctly? (possibly giving examples)
  • Are there any cross-influences? For example, do changes in the “prompt template” affect the pre-defined structure of the “retrieval template” or vice versa?

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.

@n3ur0mancer n3ur0mancer added the type: documentation Improvements or additions to documentation label Mar 11, 2024
@Van-QA Van-QA transferred this issue from janhq/jan Mar 25, 2024
@imtuyethan imtuyethan moved this to Icebox in Menlo Sep 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

1 participant