Skip to content

Commit

Permalink
feat: help/welcome message refactored
Browse files Browse the repository at this point in the history
  • Loading branch information
bolinocroustibat committed May 30, 2024
1 parent a947c22 commit 634bade
Showing 1 changed file with 28 additions and 11 deletions.
39 changes: 28 additions & 11 deletions app/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,30 @@ def get_help(self, config: Config) -> str:
model_url = f"https://huggingface.co/{config.albert_model_name}"
model_short_name = config.albert_model_name.split("/")[-1]

help_message = f"Bonjour, je m'appelle Albert et je suis votre assistant automatique dédié aux questions légales et administratives. J'utilise actuellement le modèle _[{model_short_name}]({model_url})_. N'hésitez pas à me soumettre vos interrogations, je suis là pour vous aider au mieux.\n\n"
help_message += "Attention :\n\n"
help_message += "- Je suis en phase de pré-test, il est possible que je sois en maintenance et que je ne réponde pas ou de manière imprécise\n"
help_message += "- Les échanges que j'ai avec vous peuvent être déchiffrés et stockés pour analyser mes performances ultérieurement\n"
help_message += "\n"
help_message += "Vous pouvez utiliser les commandes spéciales suivantes :\n\n"
help_message = "👋 Bonjour, je suis **Albert**, votre **assistant automatique dédié aux questions légales et administratives** mis à disposition par la **DINUM**. Je suis actuellement en phase de **test**.\n\n"
help_message = f"J'utilise le modèle de langage _[{model_short_name}]({model_url})_ et j'ai été alimenté par des bases de connaissances gouvernementales, comme les fiches pratiques de service-public.fr éditées par la Direction de l'information légale et administrative (DILA).\n\n"

help_message = "Maintenant que nous avons fait plus connaissance, quelques **règles pour m'utiliser** :\n\n"

help_message += (
"🔮 Ne m'utilisez pas pour élaborer une décision administrative individuelle.\n\n"
)
help_message += "❌️ Ne me transmettez pas :\n"
help_message += "- des **fichiers** (pdf, images, etc.) ;\n"
help_message += (
"- des données permettant de **vous** identifier ou **d'autres personnes** ;\n"
)
help_message += "- des données **confidentielles** ;\n\n"

help_message += "Enfin, quelques informations pratiques :\n\n"

help_message += "🛠️ **Pour gérer notre conversation** :\n"
help_message += "- " + "\n- ".join(cmds)
help_message += "\n\n"

help_message += "📁 **Sur l'usage des données**\nLes conversations sont stockées de manière anonyme. Elles me permettent de contextualiser les conversations et l'équipe qui me développe les utilise pour m'évaluer et analyser mes performances.\n\n"

help_message += "📯 Nous contacter : [email protected]"

return help_message

Expand Down Expand Up @@ -116,7 +133,7 @@ def decorator(func):
group="basic",
onEvent=RoomMessageText,
command="aide",
help=f"**{COMMAND_PREFIX}aide** : afficher l'aide",
help=f"Pour retrouver ce message informatif, utilisez **{COMMAND_PREFIX}aide**",
)
async def help(ep: EventParser, matrix_client: MatrixClient):
config = user_configs[ep.sender]
Expand Down Expand Up @@ -144,7 +161,7 @@ async def albert_welcome(ep: EventParser, matrix_client: MatrixClient):
group="albert",
onEvent=RoomMessageText,
command="reset",
help=f"**{COMMAND_PREFIX}reset** : remettre à zéro la conversation avec Albert",
help=f"Pour ré-initialiser notre conversation, utilisez **{COMMAND_PREFIX}reset**",
)
async def albert_reset(ep: EventParser, matrix_client: MatrixClient):
config = user_configs[ep.sender]
Expand All @@ -162,7 +179,7 @@ async def albert_reset(ep: EventParser, matrix_client: MatrixClient):
group="albert_debug",
onEvent=RoomMessageText,
command="conversation",
help=f"**{COMMAND_PREFIX}conversation** : activer/désactiver le mode conversation",
help=f"Pour activer/désactiver le mode conversation, utilisez **{COMMAND_PREFIX}conversation**",
)
async def albert_conversation(ep: EventParser, matrix_client: MatrixClient):
config = user_configs[ep.sender]
Expand Down Expand Up @@ -200,7 +217,7 @@ async def albert_debug(ep: EventParser, matrix_client: MatrixClient):
group="albert_debug",
onEvent=RoomMessageText,
command="mode",
help=f"**{COMMAND_PREFIX}mode** MODE : modifier le mode du modèle (c'est-à-dire le modèle de prompt utilisé)",
help=f"Pour modifier le mode du modèle (c'est-à-dire le modèle de prompt utilisé)n utilisez **{COMMAND_PREFIX}mode** MODE",
)
async def albert_mode(ep: EventParser, matrix_client: MatrixClient):
config = user_configs[ep.sender]
Expand All @@ -219,7 +236,7 @@ async def albert_mode(ep: EventParser, matrix_client: MatrixClient):
group="albert",
onEvent=RoomMessageText,
command="sources",
help=f"**{COMMAND_PREFIX}sources** : afficher les références utilisées lors de la dernière réponse",
help=f"Pour obtenir les sources utilisées pour générer mes réponses, utilisez **{COMMAND_PREFIX}sources**",
)
async def albert_sources(ep: EventParser, matrix_client: MatrixClient):
config = user_configs[ep.sender]
Expand Down

0 comments on commit 634bade

Please sign in to comment.