alondmnt / joplin-plugin-jarvis

Joplin (note-taking) assistant running a very intelligent system (OpenAI/GPT, Hugging Face, Gemini, Llama, Universal Sentence Encoder, etc.)
GNU Affero General Public License v3.0
226 stars 22 forks source link

Clearly document exactly which data is sent for each type of query #25

Closed chr15m closed 5 months ago

chr15m commented 5 months ago

Thank you for building and sharing this software!

As a potential user of this plugin I feel nervous about having my entire second brain uploaded to a third party service. I like the idea of doing simple chats though. What I would like to see in the documentation is a separate, clear, standardised indication of which data is uploaded for each of the types of queries listed.

For example:

Not sure if the above 'Data shared' annotation is actually correct, which is why I think it should be clearer to the user. I'm happy to submit a PR implementing this if you can let me know the details of the data shared. Thank you!

alondmnt commented 5 months ago

Understand your concerns. I can add something, probably in a separate section that is clearly indicated in the main README. However if this wasn't clear, what is sent to the model is:

  1. Any command: Your prompt.
  2. Research command: (1) + Paper abstracts found online.
  3. Chat commands: The last [memory tokens] of the current note up to the current position of the cursor.
  4. Chat with notes commands: (3) + Note excerpts (each up to [notes max tokens] long, for a total of [memory tokens]) that are similar to the current context of the conversation.
  5. Embeddings (computed offline locally by default): All of your notes.

BTW, you can host everything offline on your laptop without sending any bit to a third party (see the guide).

chr15m commented 5 months ago

Fantastic that is very clear, thank you so much!

alondmnt commented 5 months ago

Updated the README.