docs(ai/assistant): document the assistant data folder name - #15527
Conversation
|
Hello there, We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process. Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6 Thank you for contributing to Nextcloud and we hope to hear from you soon! (If you believe you should not receive this message, you can add yourself to the blocklist.) |
kyteinsky
left a comment
There was a problem hiding this comment.
would be nice to document this in the user manual too: https://github.com/nextcloud/documentation/blob/master/user_manual/ai_assistant.rst
but the changes look good!
The assistant creates a folder in each user's files for the content it generates. Its name is now configurable server-wide and per user, but neither the key nor the behaviour around existing folders was written down anywhere. Documents both settings next to the other assistant occ options, and the two things that surprise people: changing the name leaves existing folders alone, and a user who already has a folder under the built-in name keeps it rather than getting a second one. Adds the user facing side to the user manual as well: where the assistant saves what it generates, that the name can be changed in the personal settings, and that changing it leaves the existing folder alone. The skills path is stated relative to that folder rather than hardcoded, since the skills folder is resolved inside it. Signed-off-by: Baki Burak Öğün <63836730+bakiburakogun@users.noreply.github.com>
a4eff32 to
c7f04f6
Compare
|
Added, thanks — One thing I ran into while writing it. The skills section said personal skills live under I also rebased onto |
|
yeah the example paths in skills section are fine, users can deduce "Assistant/" means the Assistant's folder if they renamed it, the comment at the top clarifies it too with your change. |
|
The build jobs had not run yet when you approved this — they were still sitting in the queue. They have finished since: That leaves 21 passed, 4 skipped and one red, and the red one is No rush from my side, just flagging it since the state changed after your review. |
|
/backport to stable35 |
|
/backport to stable35 |
Documents the assistant data folder name, added in nextcloud/assistant#632.
The assistant creates a folder in each user's files for the content it generates — generated images, speech-to-text output. Its name used to be a constant; it is now an app config value with a per-user override, and both are editable in the admin and personal settings. Neither the keys nor the behaviour around existing folders was written down anywhere.
Added as item 5 of the existing "Assistant configuration" list, covering:
occ config:app:set assistant default_data_folderfor the server-wide default,occ user:setting $USER_ID assistant data_folderfor the per-user value,Assistantname keeps it, instead of getting a second folder and leaving their earlier output behind.The last two are the parts that surprise people, so they seemed worth stating rather than leaving to be discovered.
Note that the app change is merged but not in a release yet, so this targets
masteronly — happy to follow up with backports once it ships.