Merge pull request #205 from hoomano/kroussel/update_new_task

task doc update

Author: xbasset

docs/guides/tasks/example.md

@@ -32,6 +32,7 @@ Eager to assist Mia in her quest for the perfect pitch, I set out to create a ta
         "mobile",
         "webapp"
     ],
+    "task_type": "instruct",
     "predefined_actions": [],
     "task_displayed_data": [
         {
@@ -73,7 +74,8 @@ Eager to assist Mia in her quest for the perfect pitch, I set out to create a ta
             "info_name": "target_market",
             "description": "The target market represented by an ideal customer description"
         }
-    ]
+    ],
+    "result_chat_enabled": true
 }
 ```
 

docs/guides/tasks/new_task.md

@@ -1,11 +1,17 @@
-# Create a new task
+# Create a new instruct task
 
 ## Technical definition
 A task is a JSON object that contains all necessary information to render it in the app and to guide the assistant through the process of drafting the document resulting from the task.
 You can find a template of a task in the file `task_spec.json` in this repository.
 
 Let's break this specification down with "meeting_minutes" task as an example.
 
+#### Task Type
+```
+"task_type": "instruct"
+```
+The type of the task. Can be "workflow" or "instruct". A workflow is a task that requires multiple steps, executed as code, to be completed. See dedicated `new_workflow` documentation for more information on how to create a workflow.
+
 #### Platforms
 ```
 "platforms": ["mobile"]
@@ -120,13 +126,34 @@ This field contains all the information the assistant needs to collect from the
 - description: the description of the information as it will be used in the assistant prompt
 
 
-#### predefined_actions
+### predefined_actions
 ```
-"predefined_actions": []
+"predefined_actions": [
+    {
+        "task_pk": <pk of the task to chain>,
+        "displayed_data": [
+            {
+                "language_code": "en",
+                "data": {
+                    "name": "Send a follow-up email", # name of the predefined action
+                    "button_text": "Send email", # text displayed on the button of the predefined action
+                    "message_prefix": "Prepare a follow-up email to send this meeting minutes to the participants: " # prefix of the message that will be sent to the assistant in behalf of the user to start the task. It will be concatenated with the produced_text of the previous task.
+                }
+            }
+        ]
+    }
+]
+```
+Predefined Actions in Mojodex allow for chaining Task Executions. This feature is currently available only on the mobile app. It enables the execution of a subsequent task using the result of the previous task, maintaining the same context.
+
+### result_chat_enabled
+```
+"result_chat_enabled": true
 ```
-Predefined actions will be covered in a coming documentation. Let's keep it empty for now.
+This field is used to enable the chat at the end of the task, once produced_text has been generated, to let user give instruction to edit the produced_text. It is by default true. On instruct tasks, it is recommended to keep it true.
+
 
-## How to create a new task?
+## How to create a new instruct task?
 
 Let's create your first task on Mojodex.
 

docs/guides/tasks/task_spec.json

@@ -1,5 +1,6 @@
 {
     "datetime": "2024-02-14T17:49:26.545180",
+    "task_type": "instruct",
     "platforms": ["webapp","mobile"],
     "predefined_actions": [],
     "task_displayed_data": [
@@ -30,5 +31,6 @@
             "info_name": "<INFO NAME>",
             "description": "<INFO DESCRIPTION>"
         }
-    ]
+    ],
+    "result_chat_enabled":true
 }