Skip to content

Commit 32f2c33

Browse files
committed
docs: add AI assistant user documentation
Converts the upstream assistant app user docs from Markdown to RST and adds them to the user manual, including screenshots and a smart pickers section. Updates the admin manual link to point to the new page. AI-Assisted-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Anna Larch <anna@nextcloud.com>
1 parent 78b7fb1 commit 32f2c33

12 files changed

Lines changed: 121 additions & 1 deletion

β€Žadmin_manual/ai/app_assistant.rstβ€Ž

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Nextcloud assistant is the primary graphical user interface for interacting with
88

99
It offers the graphical user interface for the unified AI Task processing API offering features like summarizing text, generating headlines, asking arbitrary questions, transcription of media files, image generation and it integrates with the context_chat app to offer in-context answers about your own data stored in Nextcloud. The assistant app also offers a chat interface to interact with the chosen language model. Nextcloud can provide customer support upon request, please talk to your account manager for the possibilities.
1010

11-
Find the user documentation here: `<https://github.com/nextcloud/assistant/tree/main/docs/user>`_
11+
Find the user documentation here:
12+
`AI assistant user documentation <https://docs.nextcloud.com/server/latest/user_manual/ai_assistant.html>`_
1213

1314
Installation
1415
------------

β€Žuser_manual/ai_assistant.rstβ€Ž

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
.. _ai-assistant:
2+
3+
============
4+
AI assistant
5+
============
6+
7+
The Nextcloud AI assistant gives you access to AI-powered tools directly from the web interface.
8+
You can run tasks such as text summarization, image generation, and speech transcription, have
9+
back-and-forth conversations with a connected language model, and insert AI-generated content
10+
into documents and messages using smart pickers.
11+
12+
.. note::
13+
The AI assistant requires at least one AI backend app to be installed and configured by your
14+
administrator. See the
15+
`AI assistant administration documentation
16+
<https://docs.nextcloud.com/server/latest/admin_manual/ai/app_assistant.html>`_
17+
for details.
18+
19+
Personal settings
20+
-----------------
21+
22+
The assistant personal settings are in **Personal settings** under the **Artificial intelligence**
23+
section. You can disable the assistant top menu entry there, and enable or disable the
24+
AI-related smart pickers.
25+
26+
Running a task
27+
--------------
28+
29+
To open the assistant, click the assistant icon in the top-right navigation bar.
30+
31+
.. figure:: images/assistant/top-right-button.png
32+
:alt: Assistant icon in the top-right navigation bar.
33+
34+
*Figure 1: The assistant icon in the top-right navigation bar.*
35+
36+
Choose a task type at the top of the assistant panel, fill in the input form, and click the
37+
submit button at the bottom right.
38+
39+
.. figure:: images/assistant/assistant.png
40+
:alt: The assistant task form.
41+
42+
*Figure 2: The assistant task form.*
43+
44+
Your task will run immediately if possible, or be scheduled for later execution.
45+
46+
.. figure:: images/assistant/getting-results.png
47+
:alt: Waiting for task results.
48+
49+
*Figure 3: Waiting for task results.*
50+
51+
Notifications
52+
-------------
53+
54+
If a task was scheduled, you can request to receive a notification when it finishes. Click the
55+
**View results** button in the notification to display the task output.
56+
57+
.. figure:: images/assistant/notifications.png
58+
:alt: Task completion notification.
59+
60+
*Figure 4: Task completion notification.*
61+
62+
Task history
63+
------------
64+
65+
The left panel of the assistant shows a task history list filtered to the currently selected task
66+
type. You can relaunch, delete, or cancel previous tasks from this list.
67+
68+
.. figure:: images/assistant/history.png
69+
:alt: Task history in the left panel.
70+
71+
*Figure 5: Task history in the left panel.*
72+
73+
Chat with AI
74+
------------
75+
76+
The **Chat with AI** tab in the assistant lets you have a back-and-forth conversation with the
77+
connected AI. Type a message into the text field at the bottom and press :kbd:`Enter` to send.
78+
Click **New conversation** to start a separate conversation thread.
79+
80+
.. figure:: images/assistant/chat-with-ai.png
81+
:alt: Chat with AI interface.
82+
83+
*Figure 6: Chat with AI interface.*
84+
85+
Each conversation has its own context. Toggle **Remember this** on a conversation to add it to
86+
the AI's long-term memory so that its context is available in any future conversation. Toggle it
87+
off again to remove the conversation from memory.
88+
89+
In the **AI assistant** section of your Personal settings, you can review all your remembered
90+
conversations.
91+
92+
.. figure:: images/assistant/remembered-conversations.png
93+
:alt: Remembered conversations in personal settings.
94+
95+
*Figure 7: Remembered conversations listed in personal settings.*
96+
97+
Smart pickers
98+
-------------
99+
100+
The assistant app provides three smart pickers accessible in Talk, Text editor, and any other
101+
place where rich text editing is available. Type ``/`` followed by ``ai`` to see the filtered
102+
provider list.
103+
104+
In Talk:
105+
106+
.. figure:: images/assistant/smart-picker-talk.png
107+
:alt: AI smart picker in Talk.
108+
109+
*Figure 8: AI smart picker in Talk.*
110+
111+
In Text editor:
112+
113+
.. figure:: images/assistant/smart-picker-in-text.png
114+
:alt: AI smart picker in the Text editor.
115+
116+
*Figure 9: AI smart picker in the Text editor.*
117+
118+
Any result generated through the smart picker can be inserted directly into the current context.

β€Žuser_manual/contents.rstβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Table of contents
1010
index
1111
webinterface
1212
activity
13+
ai_assistant
1314
files/index
1415
groupware/index
1516
talk/index
203 KB
Loading
196 KB
Loading
30 KB
Loading
60.2 KB
Loading
53.9 KB
Loading
60.6 KB
Loading
20.4 KB
Loading

0 commit comments

Comments
Β (0)