Skip to content

Commit 961a943

Browse files
committed
chore(admin): Update AI docs
Signed-off-by: Marcel Klehr <[email protected]>
1 parent dbbcad0 commit 961a943

File tree

6 files changed

+89
-20
lines changed

6 files changed

+89
-20
lines changed

admin_manual/ai/app_assistant.rst

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ Speech-To-Text
5757
In order to make use of Speech-to-Text, you will need an app that provides a Speech-To-Text backend:
5858

5959
* :ref:`stt_whisper2<ai-app-stt_whisper2>` - Runs open source AI Speech-To-Text models on your own server hardware (Customer support available upon request)
60-
* *integration_openai* - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
60+
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
6161

6262
Text processing
6363
~~~~~~~~~~~~~~~
6464

6565
In order to make use of text processing features in the assistant, you will need an app that provides a Text processing backend:
6666

6767
* :ref:`llm2<ai-app-llm2>` - Runs open source AI language models locally on your own server hardware (Customer support available upon request)
68-
* *integration_openai* - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
68+
* * `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
6969
* *integration_watsonx* - Integrates with the IBM watsonx.ai API to provide AI functionality from IBM Cloud servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
7070

7171
These apps currently implement the following Assistant Tasks:
@@ -85,18 +85,40 @@ Text-To-Image
8585
In order to make use of Text-To-Image features, you will need an app that provides an image generation backend:
8686

8787
* :ref:`tex2image_stablediffusion2<ai-app-text2image_stablediffusion2>` (Customer support available upon request)
88-
* *integration_openai* - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
88+
* * `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
8989
* *integration_replicate* - Integrates with the replicate API to provide AI functionality from replicate servers (see :ref:`AI as a Service<ai-ai_as_a_service>`)
9090

9191
Context Chat
9292
~~~~~~~~~~~~
9393

94-
In order to make use of our special Context Chat feature, offering in-context insights about your own data stored in Nextcloud, you will need the following apps:
94+
In order to make use of our special Context Chat feature, offering insights about your own documents and data stored in Nextcloud, you will need the following apps:
9595

9696
* :ref:`context_chat + context_chat_backend<ai-app-context_chat>` - (Customer support available upon request)
9797

9898
You will also need a text processing provider as specified above (ie. llm2, integration_openai or integration_watsonx).
9999

100+
Chat
101+
~~~~
102+
103+
In order to make use of our "Chat with AI" feature you will need the following apps:
104+
105+
* :ref:`llm2<ai-app-llm2>` - Runs open source AI language models locally on your own server hardware (Customer support available upon request)
106+
* * `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
107+
108+
109+
Voice Chat
110+
~~~~~~~~~~
111+
112+
In order to make use of our "Audio chat" feature which allows you to interact with the assistant Chat via your Voice and Ears as if in a real conversation, you will need the following apps:
113+
114+
* Either
115+
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
116+
117+
* Or
118+
* :ref:`llm2<ai-app-llm2>` - Runs open source AI language models locally on your own server hardware (Customer support available upon request)
119+
* :ref:`stt_whisper2<ai-app-stt_whisper2>` - Runs open source AI Speech-To-Text models on your own server hardware (Customer support available upon request)
120+
* :ref:`text2speech_kokoro<ai-app-text2speech_kokoro>` - Runs open source AI Text-To-Speech models on your own server hardware (Customer support available upon request)
121+
100122
Context Agent
101123
~~~~~~~~~~~~~
102124

@@ -111,10 +133,10 @@ You will also need a text processing provider as specified above (ie. *llm2* or
111133
Text-To-Speech
112134
~~~~~~~~~~~~~~
113135

114-
In order to make use of Text-To-Speech, you will need an app that provides a Text-To-Speech backend:
136+
In order to make use of Text-To-Speech, you will need an app that provides a Text-To-Speech backend, which is one of the following:
115137

116-
* *integration_openai* - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
117-
* *text2speech_kokoro* - Runs a local model
138+
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
139+
* :ref:`text2speech_kokoro<ai-app-text2speech_kokoro>` - Runs open source AI Text-To-Speech models on your own server hardware (Customer support available upon request)
118140

119141
Configuration
120142
-------------

admin_manual/ai/app_context_agent.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ App: Context Agent (context_agent)
44

55
.. _ai-app-context_agent:
66

7-
The *context_agent* app is the app that provides AI agent functionality in Nextcloud and acts as a backend for the :ref:`Nextcloud Assistant app<ai-app-assistant>`. Nextcloud can provide customer support upon request, please talk to your account manager for the possibilities.
7+
The *context_agent* app is the app that provides AI agent functionality in Nextcloud's "Chat with AI" feature and acts as a backend for the :ref:`Nextcloud Assistant app<ai-app-assistant>`. Nextcloud can provide customer support upon request, please talk to your account manager for the possibilities.
88

99
When the Context Agent app is installed the AI Chat in Nextcloud Assistant will be able to interact with your Nextcloud apps via virtual integrations that are called "tools". They allow the Assistant to perform actions in your Nextcloud upon sending instructions in a chat message.
1010
Tool groups are only available if their requirements are met. They can be en- and disabled in the AI admin settings.

admin_manual/ai/app_stt_whisper2.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This app supports input and output in languages other than English if the underl
1010

1111
This app uses `faster-whisper <https://github.com/SYSTRAN/faster-whisper>`_ under the hood. Output quality will differ depending on which model you use, we recommend the following models:
1212

13-
* OpenAI Whisper large-v2 or v3 (multilingual)
13+
* OpenAI Whisper large v3 turbo (multilingual)
1414
* OpenAI Whisper medium.en (English only)
1515

1616
Whisper large v3 supports about ~100 languages and shows outstanding performance in ~10 of them. For more details see the `OpenAI Whisper paper <https://cdn.openai.com/papers/whisper.pdf>`_
126 KB
Loading

admin_manual/ai/images/ai_overview.svg

Lines changed: 1 addition & 1 deletion
Loading

admin_manual/ai/overview.rst

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Overview of AI features
1212
Nextcloud uses modularity to separate raw AI functionality from the Graphical User interfaces and apps that make use of said functionality. Each instance can thus make use of various backends that provide the functionality for the same frontends and the same functionality can be implemented by multiple apps using on-premises processing or third-party AI service providers.
1313

1414
.. figure:: images/ai_overview.png
15-
:scale: 80%
15+
:scale: 60%
1616

1717
.. csv-table::
1818
:header: "Feature","App","Rating","Open source","Freely available model","Freely available training data","Privacy: Keeps data on premises"
@@ -53,7 +53,7 @@ Nextcloud uses modularity to separate raw AI functionality from the Graphical Us
5353
"","`OpenAI and LocalAI integration (via Groqcloud) <https://apps.nextcloud.com/apps/integration_openai>`_","Orange","No","Yes","No","No"
5454
"","`OpenAI and LocalAI integration (via MistralAI) <https://apps.nextcloud.com/apps/integration_openai>`_","Orange","No","Yes","No","No"
5555
"","`Replicate integration <https://apps.nextcloud.com/apps/integration_replicate>`_","Yellow","Yes","Yes - Whisper models by OpenAI","No","No"
56-
"Image generation","`Local Stable Diffusion <https://apps.nextcloud.com/apps/text2image_stablediffusion>`_","Yellow","Yes","Yes - StableDiffusion XL model by StabilityAI","No","Yes"
56+
"Image generation","`Local Stable Diffusion 2 (ExApp) <https://apps.nextcloud.com/apps/text2image_stablediffusion2>`_","Yellow","Yes","Yes - StableDiffusion XL model by StabilityAI","No","Yes"
5757
"","`Replicate integration <https://apps.nextcloud.com/apps/integration_replicate>`_","Yellow","Yes","Yes - StableDiffusion models by StabilityAI","No","No"
5858
"","`OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_","Red","No","No","No","No"
5959
"","`OpenAI and LocalAI integration (via LocalAI) <https://apps.nextcloud.com/apps/integration_openai>`_","Green","Yes","Yes","Yes","Yes"
@@ -67,8 +67,9 @@ Nextcloud uses modularity to separate raw AI functionality from the Graphical Us
6767
"Context Chat Search","`Nextcloud Assistant Context Chat <https://apps.nextcloud.com/apps/context_chat>`_","Yellow","Yes","Yes","No","Yes"
6868
"Context Agent","`Nextcloud Context Agent <https://apps.nextcloud.com/apps/context_agent>`_","Green","Yes","Yes","Yes","Yes"
6969
"Text To Speech","`Open AI Text To Speech <https://apps.nextcloud.com/apps/integration_openai>`_","Red","No","No","No","No"
70-
"","`Local Text To Speech <https://apps.nextcloud.com/apps/text2speech_kokoro>`_","Yellow","Yes","Yes","No","Yes"
70+
"","`Local Text To Speech (ExApp) <https://apps.nextcloud.com/apps/text2speech_kokoro>`_","Yellow","Yes","Yes","No","Yes"
7171
"Document generation","`Nextcloud Office <https://apps.nextcloud.com/apps/richdocuments>`_","Green","Yes","Yes","Yes","Yes"
72+
"Live Transcription","`Local Live Transcription <https://apps.nextcloud.com/apps/live_transcription>`_","Green","Yes","Yes","Yes","Yes"
7273

7374

7475
Ethical AI Rating
@@ -94,7 +95,7 @@ Features used by other apps
9495
---------------------------
9596

9697
Some of our AI features are realized as generic APIs that any app can use and any app can provide an implementation for by registering a provider. So far, these are
97-
Machine translation, Speech-To-Text, Image generation, Text processing and Context Chat.
98+
Machine translation, Speech-To-Text, Text-To-Speech, Image generation, Text processing and Context Chat.
9899

99100
Text processing
100101
^^^^^^^^^^^^^^^
@@ -108,9 +109,10 @@ Frontend apps
108109
~~~~~~~~~~~~~
109110

110111
* *Text* for offering an inline graphical UI for the various tasks
111-
* `Assistant <https://apps.nextcloud.com/apps/assistant>`_ for offering a graphical UI for the various tasks and a smart picker
112+
* `Assistant <https://apps.nextcloud.com/apps/assistant>`_ for offering a graphical UI for the various tasks, a smart picker and "Chat with AI" functionality
112113
* `Mail <https://apps.nextcloud.com/apps/mail>`_ for summarizing mail threads (see :ref:`the Nextcloud Mail docs<mail_thread_summary>` for how to enable this)
113114
* `Summary Bot <https://apps.nextcloud.com/apps/summary_bot>`_ for summarizing chat histories in `Talk <https://apps.nextcloud.com/apps/spreed>`_
115+
* `Talk <https://apps.nextcloud.com/apps/spreed>`_ for summarizing chat history (see `Nextcloud Talk docs <https://nextcloud-talk.readthedocs.io/en/latest/settings/#app-configuration>`_ for how to enable this)
114116

115117

116118
Backend apps
@@ -140,6 +142,7 @@ Backend apps
140142
~~~~~~~~~~~~
141143

142144
* :ref:`translate2 (ExApp)<ai-app-translate2>` - Runs open source AI translation models locally on your own server hardware (Customer support available upon request)
145+
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
143146
* *integration_deepl* - Integrates with the deepl API to provide translation functionality from Deepl.com servers (Only community supported)
144147

145148
Speech-To-Text
@@ -152,7 +155,7 @@ As you can see in the table above we have multiple apps offering Speech-To-Text
152155
Frontend apps
153156
~~~~~~~~~~~~~
154157

155-
* `Assistant <https://apps.nextcloud.com/apps/assistant>`_ offering a graphical translation UI and a smart picker
158+
* `Assistant <https://apps.nextcloud.com/apps/assistant>`_ offering a graphical translation UI, a smart picker and Audio Chat
156159
* `Talk <https://apps.nextcloud.com/apps/spreed>`_ for transcribing calls (see `Nextcloud Talk docs <https://nextcloud-talk.readthedocs.io/en/latest/settings/#app-configuration>`_ for how to enable this)
157160

158161
Backend apps
@@ -177,7 +180,7 @@ Frontend apps
177180
Backend apps
178181
~~~~~~~~~~~~
179182

180-
* text2image_stablediffusion (Customer support available upon request)
183+
* `Local Stable Diffusion 2 (ExApp) <https://apps.nextcloud.com/apps/text2image_stablediffusion2>`_ (Customer support available upon request)
181184
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
182185
* *integration_replicate* - Integrates with the replicate API to provide AI functionality from replicate servers (see :ref:`AI as a Service<ai-ai_as_a_service>`)
183186

@@ -198,7 +201,7 @@ Backend apps
198201
~~~~~~~~~~~~
199202

200203
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
201-
* *text2speech_kokoro* (Runs a local model)
204+
* `Local Text To Speech (ExApp) <https://apps.nextcloud.com/apps/text2speech_kokoro>`_ (Customer support available upon request)
202205

203206

204207
Context Chat
@@ -209,6 +212,7 @@ Frontend apps
209212
~~~~~~~~~~~~~
210213

211214
* `Assistant <https://apps.nextcloud.com/apps/assistant>`_ for offering a graphical UI for the context chat tasks
215+
* `Nextcloud Context Agent <https://apps.nextcloud.com/apps/context_agent>`_ for offering Context chat as a tool that the agent can execute in the "Chat with AI" feature
212216

213217
Backend apps
214218
~~~~~~~~~~~~
@@ -222,8 +226,8 @@ Apps can integrate their content with Context Chat to make it available for quer
222226

223227
* *files*
224228
* `Analytics <https://apps.nextcloud.com/apps/analytics>`_
225-
226-
229+
* `Mail <https://apps.nextcloud.com/apps/mail>`_ (coming soon)
230+
* `Bookmarks <https://apps.nextcloud.com/apps/bookmarks>`_
227231

228232
Context Chat Search
229233
^^^^^^^^^^^^^^^^^^^
@@ -244,6 +248,28 @@ Provider apps
244248

245249
See *Context Chat* section above.
246250

251+
252+
Context Agent
253+
^^^^^^^^^^^^^
254+
Our Context Agent feature was introduced in Nextcloud Hub 9 (v30). It allows asking the assistant to execute tasks related to Nextcloud. You will need to install both the context_agent app as well as a text processing provider.
255+
256+
Frontend apps
257+
~~~~~~~~~~~~~
258+
259+
* `Assistant <https://apps.nextcloud.com/apps/assistant>`_ for offering a graphical UI for the "Chat with AI" feature
260+
261+
Backend apps
262+
~~~~~~~~~~~~
263+
264+
* `Nextcloud Context Agent <https://apps.nextcloud.com/apps/context_agent>`_ (Customer support available upon request)
265+
266+
Provider apps
267+
~~~~~~~~~~~~~
268+
269+
* :ref:`llm2<ai-app-llm2>` - Runs open source AI LLM models on your own server hardware (Customer support available upon request)
270+
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
271+
272+
247273
Document generation
248274
^^^^^^^^^^^^^^^^^^^
249275
Since Hub 11 you can let Nextcloud automatically generate Office documents with content.
@@ -259,6 +285,27 @@ Backend apps
259285

260286
* `Nextcloud Office <https://apps.nextcloud.com/apps/richdocuments>`_
261287

288+
Provider apps
289+
~~~~~~~~~~~~~
290+
291+
* :ref:`llm2<ai-app-llm2>` - Runs open source AI LLM models on your own server hardware (Customer support available upon request)
292+
* `OpenAI and LocalAI integration (via OpenAI API) <https://apps.nextcloud.com/apps/integration_openai>`_ - Integrates with the OpenAI API to provide AI functionality from OpenAI servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
293+
* `IBM watsonx.ai integration (via IBM watsonx.ai as a Service) <https://apps.nextcloud.com/apps/integration_watsonx>`_ - Integrates with the IBM watsonx.ai API to provide AI functionality from IBM Cloud servers (Customer support available upon request; see :ref:`AI as a Service<ai-ai_as_a_service>`)
294+
295+
296+
Live transcription
297+
^^^^^^^^^^^^^^^^^^
298+
Since Hub 25 Autumn you can let Nextcloud automatically generate produce subtitles for video and audio calls in Nextcloud Talk.
299+
300+
Frontend apps
301+
~~~~~~~~~~~~~
302+
303+
* `Talk <https://apps.nextcloud.com/apps/spreed>`_ for displaying the subtitles in calls
304+
305+
Backend apps
306+
~~~~~~~~~~~~
307+
308+
* :ref:`live_transcription<ai-live-transcription>` - Runs open source AI Speech-To-Text models on your own server hardware (Customer support available upon request)
262309

263310
.. _ai-overview_improve-ai-task-pickup-speed:
264311

0 commit comments

Comments
 (0)