You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-13Lines changed: 30 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,15 @@ It is designed to be task-oriented, configurable, and personalizable. Mojodex is
14
14
15
15
## What's in it?
16
16
17
-
| Link to the repo | Description | Live Demo Version |
18
-
| --- | --- | --- |
19
-
|[Plaform Core (this repo)](https://github.com/hoomano/mojodex)|[Open-source NextJS](/webapp), [Python backend](backend), [PostgreSQL database](/pgsql) and more, including the [webapp](/webapp/) convenient for laptop usage. |[https://mojodex.hoomano.com](https://mojodex.hoomano.com)|
20
-
|[Mobile app](https://github.com/hoomano/mojodex_mobile)| Open-source Flutter app that allows users to interact with the digital assistant on the go - mainly voice interaction. |[](https://apps.apple.com/fr/app/mojodex/id6446367743)[](https://play.google.com/store/apps/details?id=com.hoomano.mojodex_mobile)|
21
-
| Chrome extension (soon) | Open-source Chrome extension project to access the digital assistant directly from the browser. | [](https://chromewebstore.google.com/detail/mojodex/jagemmajllamdahinjidkopehkffbkho)
17
+
| Link to the repo | Description | Live Demo Version|
|[Plaform Core (this repo)](https://github.com/hoomano/mojodex)|[Open-source NextJS](/webapp), [Python backend](backend), [PostgreSQL database](/pgsql) and more, including the [webapp](/webapp/) convenient for laptop usage and the [CLI](/cli) (yes a CLI 💻). |[https://mojodex.hoomano.com](https://mojodex.hoomano.com)|
20
+
|[Mobile app](https://github.com/hoomano/mojodex_mobile)| Open-source Flutter app that allows users to interact with the digital assistant on the go - mainly voice interaction.|[](https://apps.apple.com/fr/app/mojodex/id6446367743)[](https://play.google.com/store/apps/details?id=com.hoomano.mojodex_mobile)|
21
+
| Chrome extension (soon) | Open-source Chrome extension project to access the digital assistant directly from the browser. |[](https://chromewebstore.google.com/detail/mojodex/jagemmajllamdahinjidkopehkffbkho)|
22
22
23
23
__Here we go!__
24
24
25
-
## Quick Start
25
+
## Quick Start: 3-steps installation of the Mojodex platform
26
26
27
27
See the installation video guide here: https://youtu.be/86_S_cXhhTA
28
28
@@ -74,16 +74,33 @@ For a complete experience, you can also build and use the open-source Mojodex mo
74
74
75
75
## Key Features
76
76
77
-
-**Task-Oriented** : Mojodex is designed to assist users by completing specific tasks, making it easier for the assistant to understand and fulfill user needs.
77
+
-**Task-Oriented** : Mojodex is designed to assist final users by completing specific tasks, making it easier for the assistant to understand and fulfill user needs.
78
78
79
-
-**Configurable** : Tailored to various professional uses, allowing for role-specific task configurations (sales, recruitment, personal assistance, etc.).
79
+
-**Configurable** : Easy to tailor to any professional uses, allowing for role-specific task configurations (sales, recruitment, personal assistance, etc.).
80
80
81
-
-**Personalizable** : Builds a memory of user interactions and goals to improve task execution.
81
+
-**Personalizable** : Built-in memory of user interactions and goals to improve task execution.
82
82
83
-
-**Proactive** : Independently manages tasks, freeing users to focus on other activities through a chat-independent architecture.
83
+
-**Proactive** : Independently organizing todos from tasks, freeing users to focus on other activities through a multi-platform architecture.
84
84
85
-
-**Multiple User Interfaces** : Includes a web application in this repository, an open-source mobile application, and a Chrome extension.
85
+
-**Multiple User Interfaces** : Includes a web application in this repository, an open-source mobile application, and a CLI (yes, a CLI).
86
86
87
-
-**API-Centric Back-End** : Enables easy integration with other tools through a well-defined API exposure.
87
+
-**API-Centric Back-End** : Enables easy customization and integration with other tools through a well-defined API exposure.
88
88
89
-
-**Using OpenAI's GPT-4 Turbo** : Accessible directly via OpenAI or through Azure's functionalities.
89
+
-**Multi-LLM** : Take the most of any model. Designed to be working with state of the art models, and customizability to adjust to any LLM
90
+
91
+
## Documentation
92
+
93
+
Access the complete documentation online: https://hoomano.github.io/mojodex
Copy file name to clipboardExpand all lines: docs/design-principles/tasks/whats_a_task.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,16 @@
3
3
## Task
4
4
A task on Mojodex is a discrete piece of work, inspired by the [JRC-Eurofound Tasks Framework](https://joint-research-centre.ec.europa.eu/scientific-activities-z/employment/job-tasks-and-work-organisation_en) and [O*NET OnLine](https://www.onetonline.org/), representing various skills and specializations required to accomplish it.
5
5
6
+
## What does executing a task produces?
7
+
8
+
A text.
9
+
10
+
Yes, it's that simple, and so powerful, because it can be any kind of text, and based on many types of inputs.
11
+
12
+
13
+
14
+
In this example, the `Result` tab contains the result of the execution of a task which helped me create the documentation of Mojodex. I can easily copy / paste the result to VS Code, adjust the text, fix mistakes and ship it in my repo.
15
+
6
16
## Why?
7
17
We build this "task-centric" assistant to provide the best help to the user, tailored to their needs. Technically, a task is described as a configuration file containing all information the assistant needs. This way, any expert can create a really specific task and the assistant will be able to guide the user through the process of accomplishing it in a conversational, seamless way.
Copy file name to clipboardExpand all lines: docs/design-principles/workflows/execute_workflow.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Workflow Execution Workflow in Mojodex
1
+
# How `Workflows` are run?
2
2
3
-
This document provides an overview of the concept related to the workflow execution process in the Mojodex platform and describes the sequence of events that occur from the moment a user initiates a new workflow execution until the workflow is completed and the result is delivered.
3
+
This document provides an overview of the concept related to the workflow execution process in the Mojodex platform and describes the sequence of events that occurs from the moment a user initiates a new workflow execution until the workflow is completed and the result is delivered.
It's a particular type of [`Task`](../tasks/whats_a_task.md).
4
+
5
+
*By the way, the `What's a task` page example is a workflow, actually.*
6
+
7
+
8
+
9
+
10
+
## What's different with an `instruct` task?
11
+
12
+
Workflows are tasks:
13
+
14
+
- composed of multiple steps
15
+
- orchestrated with code
16
+
17
+
As a consequence of these differences, developers can make more customized tasks, with more complex user interactions and more interoperability with other programs through APIs.
18
+
19
+
There are examples in the `mojodex_core/workflows/` directory.
20
+
21
+
22
+
## Differences between `instruct` and `workflow` tasks
| Quick and direct task. | Step-by-step process. |
27
+
| Made of a simple interaction = message exchanges, between the assistant and the user. | A step is code. Anything can be done in this code including complex actions as API calls. |
28
+
| Uses the same prompt template for every task. | User can visualize and take action on each step results. |
29
+
| Example: `Write a poem`: The user gives a subject and a number of stanzas and the poem is written straight-forward by conversation btw user and assistant. | Example: `Write a poem stanza by stanza`: The user gives a subject and a number of stanzas and the assistant writes 1 stanza, user can edit or ask for edition before moving on to the next one etc… API calls could also be done to enrich poem, associate images… |
30
+
31
+
32
+
## Usage
33
+
34
+
A user has access to the workflows in the same section as the new task creation:
35
+
36
+
37
+
38
+
39
+
Provide the first input required to launch the first step of the workflow
40
+
41
+
42
+
43
+
44
+
For each step, interact with your assistant depending on how it's been designed, here, we want the user to review and validate the chapters of the documentation
45
+
46
+
47
+
Once the final step of the workflow is done, the user has access to the result.
48
+
49
+
50
+
51
+
52
+
53
+
## How to create a `workflow`?
54
+
55
+
See the doc in [`guides/workflows/new_workflow.md`](../../guides/workflows/new_workflow.md)
0 commit comments