Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion admin_manual/ai/app_assistant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Nextcloud assistant is the primary graphical user interface for interacting with

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.

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

Installation
------------
Expand Down
118 changes: 118 additions & 0 deletions user_manual/ai_assistant.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
.. _ai-assistant:

============
AI assistant
============

The Nextcloud AI assistant gives you access to AI-powered tools directly from the web interface.
You can run tasks such as text summarization, image generation, and speech transcription, have
back-and-forth conversations with a connected language model, and insert AI-generated content
into documents and messages using smart pickers.

.. note::
The AI assistant requires at least one AI backend app to be installed and configured by your
administrator. See the
`AI assistant administration documentation
<https://docs.nextcloud.com/server/latest/admin_manual/ai/app_assistant.html>`_
for details.

Personal settings
-----------------

The assistant personal settings are in **Personal settings** under the **Artificial intelligence**
section. You can disable the assistant top menu entry there, and enable or disable the
AI-related smart pickers.

Running a task
--------------

To open the assistant, click the assistant icon in the top-right navigation bar.

.. figure:: images/assistant/top-right-button.png
:alt: Assistant icon in the top-right navigation bar.

*Figure 1: The assistant icon in the top-right navigation bar.*

Choose a task type at the top of the assistant panel, fill in the input form, and click the
submit button at the bottom right.

.. figure:: images/assistant/assistant.png
:alt: The assistant task form.

*Figure 2: The assistant task form.*

Your task will run immediately if possible, or be scheduled for later execution.

.. figure:: images/assistant/getting-results.png
:alt: Waiting for task results.

*Figure 3: Waiting for task results.*

Notifications
-------------

If a task was scheduled, you can request to receive a notification when it finishes. Click the
**View results** button in the notification to display the task output.

.. figure:: images/assistant/notifications.png
:alt: Task completion notification.

*Figure 4: Task completion notification.*

Task history
------------

The left panel of the assistant shows a task history list filtered to the currently selected task
type. You can relaunch, delete, or cancel previous tasks from this list.

.. figure:: images/assistant/history.png
:alt: Task history in the left panel.

*Figure 5: Task history in the left panel.*

Chat with AI
------------

The **Chat with AI** tab in the assistant lets you have a back-and-forth conversation with the
connected AI. Type a message into the text field at the bottom and press :kbd:`Enter` to send.
Click **New conversation** to start a separate conversation thread.

.. figure:: images/assistant/chat-with-ai.png
:alt: Chat with AI interface.

*Figure 6: Chat with AI interface.*

Each conversation has its own context. Toggle **Remember this** on a conversation to add it to
the AI's long-term memory so that its context is available in any future conversation. Toggle it
off again to remove the conversation from memory.

In the **AI assistant** section of your Personal settings, you can review all your remembered
conversations.

.. figure:: images/assistant/remembered-conversations.png
:alt: Remembered conversations in personal settings.

*Figure 7: Remembered conversations listed in personal settings.*

Smart pickers
-------------

The assistant app provides three smart pickers accessible in Talk, Text editor, and any other
place where rich text editing is available. Type ``/`` followed by ``ai`` to see the filtered
provider list.

In Talk:

.. figure:: images/assistant/smart-picker-talk.png
:alt: AI smart picker in Talk.

*Figure 8: AI smart picker in Talk.*

In Text editor:

.. figure:: images/assistant/smart-picker-in-text.png
:alt: AI smart picker in the Text editor.

*Figure 9: AI smart picker in the Text editor.*

Any result generated through the smart picker can be inserted directly into the current context.
1 change: 1 addition & 0 deletions user_manual/contents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Table of contents
index
webinterface
activity
ai_assistant
files/index
groupware/index
talk/index
Expand Down
Binary file added user_manual/images/assistant/assistant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/images/assistant/chat-with-ai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/images/assistant/history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual/images/assistant/notifications.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading