Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enh/summarai documentation #11725

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Enh/summarai documentation #11725

wants to merge 3 commits into from

Conversation

nc-fkl
Copy link
Contributor

@nc-fkl nc-fkl commented Apr 10, 2024

☑️ Resolves

  • Added missing documentation for SummarAI for chat summarization

🖼️ Screenshots

image

image

Signed-off-by: Florian Klinger <florian.klinger@nextcloud.com>
Signed-off-by: Florian Klinger <florian.klinger@nextcloud.com>
Space usage
~~~~~~~~~~~

* ~100MB
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should just be a bullet point, no indentation (on your screenshot interpreted as quote)


.. _ai-app-summarai:

The *SummarAI* app is one of the apps that utilize the llm or any other configured llm provider in Nextcloud and act as a configurable bot for `Nextcloud Talk`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

llm, at the first usage, it would be nice to have the full name (I suppose it is the large language model?), or already the local large language model (lllm, l3m??), because we should use it or any other llm provider....


0. Make sure the following apps are installed:

`Nextcloud AppAPI app <https://apps.nextcloud.com/apps/app_api>`_
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for this list, you don't want to use bullet points?

`Nextcloud OpenAI and LocalAI integration app <https://apps.nextcloud.com/apps/integration_openai>`_


Setup (via App Store)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The automatic setup via app store also creates a docker? Or it uses a remote service?

It is just to know, what is the benefit of the manual install, just for development purposes of the app, to have more influence on the inner parts of the AI, ...

@DaphneMuller
Copy link
Contributor

In installation step 0, where do the links point to?
I would recommend pointing where possible to the links within the AI chapter in the documentation
https://docs.nextcloud.com/server/latest/admin_manual/ai/app_api_and_external_apps.html
https://docs.nextcloud.com/server/latest/admin_manual/ai/app_assistant.html etc
except from talk

@DaphneMuller DaphneMuller self-requested a review April 17, 2024 10:57
Signed-off-by: Florian Klinger <florian.klinger@nextcloud.com>
Copy link
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

@DaphneMuller
Copy link
Contributor

DaphneMuller commented Apr 29, 2024

@bigcat88 please have a look at this docs and add the changes and publish it it after you're done with the summary bot changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants