Skip to content

Commit

Permalink
add screenshots, write README
Browse files Browse the repository at this point in the history
Signed-off-by: Julien Veyssier <[email protected]>
  • Loading branch information
julien-nc committed Aug 9, 2023
1 parent 368bdd9 commit 431db1f
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# Nextcloud assistant

This app brings a user interface to use the Nextcloud text processing feature.

It allows users to launch text processing tasks, be notified when they finish and see the results.
The assistant also appears in others apps like Text to easily process parts of a document.

### How to use it

A new right header menu entry appears. Once clicked, the assistant is displayed and you can select and task type and
set the input text you want to process.

Once a task is scheduled, it will run as a background job. When it is finished, you will receive a notification
from which the results can be displayed.

Other apps can integrate with the assistant. For example, Text will display an inline button besides every paragraph
to directly select a task type to process this paragraph. Selecting a task this way will open the assistant with the task
being pre-selected and the input text set.

### Text processing providers

In the assistant, the list of available tasks depends on the available providers installed via other apps.
This means you have complete freedom over which service/software will actually run your text processing tasks.
So far, the [Large language model](https://github.com/nextcloud/llm#readme)
and the [OpenAi/LocalAI integration](https://apps.nextcloud.com/apps/integration_openai) apps
include text processing providers to:
* Summarize
* Extract topics
* Generate a headline
* Get an answer from a free prompt
* Reformulate (OpenAi/LocalAi only)
18 changes: 17 additions & 1 deletion appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,23 @@
<name>Nextcloud assistant</name>
<summary>Process and transform text</summary>
<description><![CDATA[
This app brings text processing features to Nextcloud.
This app brings a user interface to use the Nextcloud text processing feature.
It allows users to launch text processing tasks, be notified when they finish and see the results.
The assistant also appears in others apps like Text to easily process parts of a document.
In the assistant, the list of available tasks depends on the available providers installed via other apps.
So far, the [Large language model](https://github.com/nextcloud/llm#readme)
and the [OpenAi/LocalAI integration](https://apps.nextcloud.com/apps/integration_openai) apps
include such providers to:
* Summarize
* Extract topics
* Generate a headline
* Get an answer from a free prompt
* Reformulate
Once a task is scheduled, it will run as a background job. When it is finished, the user receives a notification
from which the results can be displayed.
]]></description>
<version>1.0.0</version>
<licence>agpl</licence>
Expand Down
Binary file added img/screenshot1.jpg
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 img/screenshot2.jpg
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 img/screenshot3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 431db1f

Please sign in to comment.