Skip to content

Commit a4eff32

Browse files
committed
docs(ai/assistant): document the assistant data folder name
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. Signed-off-by: Baki Burak Öğün <63836730+bakiburakogun@users.noreply.github.com>
1 parent 1db4a70 commit a4eff32

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

admin_manual/ai/app_assistant.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,33 @@ To enable/disable the text-to-image smart picker for all the users.
190190
191191
To enable/disable the speech-to-text smart picker for all the users.
192192

193+
5. Data folder
194+
195+
.. code-block::
196+
197+
occ config:app:set assistant default_data_folder --value="Assistant" --type=string
198+
199+
The assistant stores the content it generates, such as generated images and speech-to-text
200+
output, in a folder in the files of each user. This sets the name that folder is given when
201+
it is created. It defaults to ``Assistant``, and is also editable in the Assistant admin
202+
settings.
203+
204+
Users can choose their own name in their personal Assistant settings, which is stored per
205+
user and takes precedence over the server-wide default:
206+
207+
.. code-block::
208+
209+
occ user:setting $USER_ID assistant data_folder "Assistant"
210+
211+
Two things to keep in mind:
212+
213+
* Changing either value does not rename or move a folder that already exists. It only
214+
affects the name used the next time a folder has to be created, so existing generated
215+
content stays where it is.
216+
* A user who already has a folder under the built-in name ``Assistant``, from before a
217+
default was set, keeps using it. This avoids starting a second folder for them and
218+
leaving their earlier output behind.
219+
193220
Task processing
194221
~~~~~~~~~~~~~~~
195222

0 commit comments

Comments
 (0)