Conseils & meilleures pratiques

Ce que vous allez apprendre

Dans cette page vous trouverez des conseils concrets et faciles à suivre pour :

  • décider quand lancer une ré-indexation complète ou une ré-indexation incrémentale,
  • utiliser les templates d’agents (ex. SEO) et choisir le LLM adapté,
  • automatiser des releases avec des hooks programmés,
  • prévisualiser les sorties avant publication,
  • configurer retries/backoff pour les webhooks,
  • pré-remplir le branding en scrappant une URL,
  • sécuriser vos tokens et webhooks. Tout est expliqué pas à pas, avec des actions réelles disponibles dans l’application.

Aperçu rapide

Indexation

Savoir quand lancer un RAG sync manuel, ou laisser la ré-indexation incrémentale (updateFileIndexAndMilvus) gérer les pushes.

Agents & LLM

Utiliser les templates (ex. SEO Article Generator), dupliquer et choisir un modèle LLM adapté à la tâche.

Sécurité & Webhooks

Génération de webhookSecret, vérification via checkWebhook, et recommandations pour retries/backoff.

1) Re-indexer vs ré-indexation incrémentale

Quand et comment choisir

1

Ré-indexation complète (quand l'utiliser)

Faites une ré-indexation complète si vous avez :

  • modifié massivement la structure du repo (renommages, suppression/imports),
  • changé la méthode d’embeddings ou le pipeline d’indexation,
  • ou si vous suspectez des incohérences dans l’index. Action réelle : Ouvrez le repository dans l’interface et cliquez sur “RAG sync”. Le backend récupère les commits et met à jour l’index.
2

Ré-indexation incrémentale (par défaut)

Pour le flux normal, activez la ré-indexation incrémentale : le webhook Git déclenche updateFileIndexAndMilvus sur push. Cela met à jour FileIndex et Milvus seulement pour les fichiers modifiés—plus rapide et moins coûteux.

3

Exemple pratique

Si vous gérez des corrections quotidiennes (typos, petites améliorations), laissez les webhooks déclencher updateFileIndexAndMilvus. Si vous migrez de Markdown à un autre format ou changez les embeddings, lancez un “RAG sync” complet.

Astuce

Planifiez une ré-indexation complète après une grosse mise à jour du modèle d’embeddings. Entre deux, préférez la ré-indexation incrémentale pour gagner du temps et réduire les coûts.

2) Utiliser les templates d’agents (ex. SEO) et sélectionner le LLM

Créer et adapter un agent à partir d'un template

1

Choisir un template

Ouvrez Dialogue → Agents → Templates. Sélectionnez par exemple “SEO Article Generator” puis cliquez sur “Use template” pour créer une copie.

2

Personnaliser les étapes (JSON)

Dans l’éditeur d’agent, modifiez les steps JSON si besoin (titre, prompts, données d’entrée). Vous pouvez dupliquer un agent via “Duplicate” pour tester sans perdre l’original.

3

Sélectionner le LLM adapté

Pour chaque agent, choisissez le modèle LLM approprié dans le champ modèle :

  • tâches rédactionnelles (SEO) : modèles orientés génération avec meilleur style,
  • extraction/QA : modèles plus rapides et précis sur les faits. Testez le rendu en exécutant l’agent manuellement avant de l’automatiser.
4

Exécuter manuellement pour prévisualiser

Lancez l’agent depuis l’interface pour voir la sortie. Ajustez le prompt/modèle jusqu’à obtenir le résultat attendu, puis associez l’agent à un hook si besoin.

Conseil non-technique

Commencez par un modèle conservateur (moins créatif) pour les contenus SEO structurés, puis basculez vers un modèle plus créatif si vous avez besoin d’un ton plus humain.

3) Configurer des hooks programmés pour automatiser les releases

Automatiser un workflow de publication

1

Assigner un agent à un hook

Dans Agents, ouvrez l’agent → “Associate Hook” → choisissez un Hook (webhook ou endpoint interne). Les hooks peuvent déclencher l’agent automatiquement (par ex. à chaque merge).

2

Programmer un hook récurrent (ex. release hebdo)

Si votre interface propose un scheduler pour hooks, créez un hook programmé (ex. tous les lundis) qui lance l’agent de publication ou génération. Sinon, utilisez un service externe pour appeler l’endpoint d’exécution de l’agent à intervalle régulier.

3

Tester avant activation

Exécutez le hook manuellement pour vérifier le flux complet : génération (agent) -> indexation (si nécessaire) -> publication.

Erreur fréquente

Ne branchez pas immédiatement un hook automatique sur la publication publique sans prévisualiser la sortie. Vous risquez des publications incomplètes ou au ton inadapté.

4) Prévisualiser les outputs avant publication

Procédure simple pour vérifier le rendu

1

Exécuter l'agent manuellement

Avant d’activer la publication automatique, lancez l’agent depuis l’interface pour générer le contenu.

2

Inspecter les résultats

Relisez la sortie et assurez-vous que les liens, le branding et les métadonnées sont corrects. Corrigez le prompt ou le template si besoin.

3

Répéter et sauvegarder

Répétez jusqu’à satisfaction, puis associez le hook/programmez la release.

5) Réglage des retries et du backoff pour les webhooks

Paramétrer fiabilité des webhooks

1

Activer signature et secret

Lors de la création d’un webhook, DeployIt génère un webhookSecret si nécessaire. Toujours utiliser ce secret pour vérifier la signature côté récepteur.

2

Configurer retries/backoff

Si votre endpoint peut être temporairement indisponible, utilisez un mécanisme de retries avec backoff exponentiel (p.ex. 3 tentatives, 2s → 8s → 32s). Si l’interface propose ces réglages, ajustez-les dans la config du webhook.

3

Vérifier l'existence et la santé

Utilisez checkWebhook pour vérifier qu’un webhook existe côté provider et inspectez les logs d’échec pour ajuster les retries.

Bonne pratique

Loggez les échecs et alertez une personne de votre équipe après N échecs consécutifs pour éviter des queues bloquées.

6) Scraper une URL pour pré-remplir le branding du site public

Remplir rapidement le branding

1

Ouvrir Paramètres > Site

Aller à Paramètres → Site.

2

Entrer l'URL et cliquer 'Scrape'

Saisissez l’URL publique que vous voulez utiliser comme référence, puis cliquez sur “Scrape”. L’outil récupère logo, couleurs et métadonnées pour pré-remplir le formulaire.

3

Vérifier et sauvegarder

Ajustez les champs (title, colors, footer_links) puis sauvegardez. Le site utilisera ces variables et les tokens CSS dans src/assets/css/tailwind.css et tailwind.config.js pour le theming.

7) Sécuriser tokens et webhooks

Actions faciles pour protéger vos secrets

1

Ne partagez jamais les tokens en clair

Ne copiez jamais tokens ou webhookSecret dans des canaux non sécurisés (chat, email public).

2

Utiliser les secrets générés par la plateforme

Lors de la création d’un webhook, laissez la plateforme générer le webhookSecret (DeployIt le fait automatiquement si nécessaire). Vérifiez la signature côté récepteur.

3

Supprimer les webhooks inutilisés

Quand un repo ou un projet est supprimé, la plateforme supprime aussi le webhook côté provider. Si vous retirez un service, supprimez ses webhooks et révoquez ses tokens.

4

Vérifier régulièrement

Exécutez périodiquement checkWebhook pour confirmer la présence et validité des webhooks côté provider.

Erreur de sécurité fréquente

Ne laissez pas de tokens hardcodés dans le code du repository. Si un token fuit, régénérez-le immédiatement et mettez à jour les webhooks/connexions.

Pro tip final

Avant d’automatiser une publication complète, mettez en place :

  • prévisualisation manuelle,
  • tests périodiques de vos webhooks (checkWebhook),
  • retries/backoff raisonnables,
  • et une procédure de rollback simple (supprimer le webhook ou désactiver le hook programmé).

Next steps

  • Lancez un “RAG sync” manuel pour un repo de test : Ouvrez le repo → cliquez “RAG sync”.
  • Créez un agent à partir du template “SEO Article Generator”, sélectionnez un modèle LLM adapté et exécutez-le manuellement pour valider la sortie.
  • Configurez un webhook sécurisé (laisser la plateforme générer le webhookSecret) et testez les retries/backoff.
  • Scrapez l’URL de votre site pour pré-remplir le branding : Paramètres → Site → “Scrape”.

Besoin d'aide ?

Consultez nos guides détaillés ou contactez le support si vous avez besoin d’un coup de main pour automatiser vos flux.

Foire aux questions