From c9ee57643c7610b5c2e4fae3c85c0921fdcbbd0a Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Tue, 21 Jan 2025 10:53:52 +0100 Subject: [PATCH] enh: More docs for context agent Signed-off-by: Marcel Klehr --- admin_manual/ai/app_context_agent.rst | 57 ++++++++++++++++++++++++++- admin_manual/ai/overview.rst | 1 + 2 files changed, 57 insertions(+), 1 deletion(-) diff --git a/admin_manual/ai/app_context_agent.rst b/admin_manual/ai/app_context_agent.rst index e42460f0d..30b5ea429 100644 --- a/admin_manual/ai/app_context_agent.rst +++ b/admin_manual/ai/app_context_agent.rst @@ -6,6 +6,61 @@ App: Context Agent (context_agent) 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`. Nextcloud can provide customer support upon request, please talk to your account manager for the possibilities. +When Context Agent is installed the AI Chat in Nextcloud Assistant will be able to interact with your Nextcloud app via virtual integrations that are called "tools". + +Currently implemented tools: + +* List the user's calendars + + * Example prompt: *"List my calendars"* + +* List the user's talk conversations + + * Example prompt: *"List my talk conversations"* + +* List messages in a talk conversation + + * Example prompt: *"List the latest messages in my conversation with Andrew"* + +* Find a person in the user's contacts + + * Example prompt: *"What is Andrew's Email address?"* + +* Ask a question to context chat + + * Example prompt: *"What is the company's sick leave process?"* + +* Get coordinates for an Address from Open Street Maps Nomatim + + * Example prompt: *"List my calendars"* + +* Get the current weather at a location + + * Example prompt: *"How is the weather in Berlin?"* + +* Schedule an event in the user's calendar + + * Example prompt: *"Make schedule an event with Andrew tomorrow at noon."* + +* Send a message to a talk conversation + + * Example prompt: *"Can you send a joke to Andrew in talk?"* + +* Send an email via Nextcloud Mail + + * Example prompt *"Send a test email from carry@company.com to Andrew@company.com from my account with id 12"* + * (The account ID will soon be irrelevant) + +These tools can also be combined by the agent to fulfil tasks like the following: + + * *"How is the weather where Andrew lives?"* + + * Uses contacts to look up Andrew's address and then checks the weather + + * *"Send an email from carry@company.com to Andrew"* + + * Uses contacts to look up Andrew's email and then sends an email + Requirements ------------ @@ -31,7 +86,7 @@ Model requirements This app requires underlying Large language models to support tool calling. The default model in *llm2* does *not* support tool calling. Instead we recommend: -* Qwen 2.5 8B or higher +* Qwen 2.5 8B or higher (May not work well with languages other than English) * Watt Tool 8B or higher See :ref:`llm2 documentation ` on how to configure alternate models. diff --git a/admin_manual/ai/overview.rst b/admin_manual/ai/overview.rst index 0818ce1f1..c70d90d20 100644 --- a/admin_manual/ai/overview.rst +++ b/admin_manual/ai/overview.rst @@ -60,6 +60,7 @@ Nextcloud uses modularity to separate raw AI functionality from the Graphical Us "","`OpenAI and LocalAI integration (via MistralAI) `_","Orange","No","Yes","No","No" "Context Chat","`Nextcloud Assistant Context Chat `_","Yellow","Yes","Yes","No","Yes" "","`Nextcloud Assistant Context Chat (Backend) `_","Yellow","Yes","Yes","No","Yes" + "Context Agent","`Nextcloud Context Agent `_","Green","Yes","Yes","Yes","Yes" Ethical AI Rating