From 2549ee457ec1f501e4f9edfeefb5aa578ef8bd82 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Fri, 17 Jan 2025 13:11:29 +0100 Subject: [PATCH] fix: Apply suggestions from code review Co-authored-by: Julien Veyssier Signed-off-by: Marcel Klehr --- admin_manual/ai/app_context_agent.rst | 4 ++-- admin_manual/ai/app_text2image_stablediffusion2.rst | 6 +++--- developer_manual/digging_deeper/task_processing.rst | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/admin_manual/ai/app_context_agent.rst b/admin_manual/ai/app_context_agent.rst index 7cae7e51e02..e42460f0d67 100644 --- a/admin_manual/ai/app_context_agent.rst +++ b/admin_manual/ai/app_context_agent.rst @@ -4,14 +4,14 @@ App: Context Agent (context_agent) .. _ai-app-context_agent: -The *context_agent* app is the apps that provide 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. +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. Requirements ------------ * This app is built as an External App and thus depends on AppAPI v3.1.0 or higher * Nextcloud AIO is supported -* No GPU is necessary +* No GPU is necessary for Context Agent but one might be useful if you use it with a self-hosted provider like llm2 * CPU Sizing diff --git a/admin_manual/ai/app_text2image_stablediffusion2.rst b/admin_manual/ai/app_text2image_stablediffusion2.rst index fab0abb64a8..a590cbfa2e5 100644 --- a/admin_manual/ai/app_text2image_stablediffusion2.rst +++ b/admin_manual/ai/app_text2image_stablediffusion2.rst @@ -26,9 +26,9 @@ Requirements Installation ------------ -0. Make sure the :ref:`Nextcloud Assistant app` is installed -1. :ref:`Install AppAPI and setup a Deploy Demon` -2. Install the "Local large language model" ExApp via the "Apps" page in the Nextcloud web admin user interface +* Make sure the :ref:`Nextcloud Assistant app` is installed +* :ref:`Install AppAPI and setup a Deploy Demon` +* Install the "Local large language model" ExApp via the "Apps" page in the Nextcloud web admin user interface Scaling diff --git a/developer_manual/digging_deeper/task_processing.rst b/developer_manual/digging_deeper/task_processing.rst index 684af2087f3..d6267dcba96 100644 --- a/developer_manual/digging_deeper/task_processing.rst +++ b/developer_manual/digging_deeper/task_processing.rst @@ -42,12 +42,12 @@ The following built-in task types are available: * Input shape: * ``system_prompt``: ``Text`` * ``input``: ``Text`` - * ``tool_message`` A JSON array of ``{"name": string, "content": string, "tool_call_id": string}`` - * ``history``: ``ListOfTexts`` Each list item is a JSON string with ``{"role": "human", "content": string}`` or ``{"role": "assistant"|, "content": string, (optional: "tool_calls": array<{"name": string, "type": "tool_call", "id": string, "args": object}>)}`` or ``{"role": "tool", "content": string, "name": string, "tool_call_id": string}`` + * ``tool_message``: ``Text`` A string containing a JSON array of ``{"name": string, "content": string, "tool_call_id": string}`` + * ``history``: ``ListOfTexts`` Each list item is a JSON string with ``{"role": "human", "content": string}`` or ``{"role": "assistant", "content": string, (optional: "tool_calls": array<{"name": string, "type": "tool_call", "id": string, "args": object}>)}`` or ``{"role": "tool", "content": string, "name": string, "tool_call_id": string}`` * ``tools``: ``Text`` The tools parameter should be a JSON array formatted according to the OpenAI API specifications: https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools * Output shape: * ``output``: ``Text`` - * ``tool_calls``: ``Text`` A JSON array with ``{"name": string, "type": "tool_call", "id": string, "args": object}`` + * ``tool_calls``: ``Text`` A string containing a JSON array with ``{"name": string, "type": "tool_call", "id": string, "args": object}`` * ``'core:contextagent:interaction'``: This task allows chatting with an agent. It is implemented by ``\OCP\TaskProcessing\TaskTypes\ContextAgentInteraction`` * Input shape: * ``input``: ``Text``