Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Prérequis

Avant de commencer, assurez-vous que :
  1. AnythingLLM est installé
    Téléchargez et installez AnythingLLM depuis le site officiel ou visitez GitHub
  2. Clé API APIMart obtenue
    Connectez-vous à la console APIMart pour obtenir votre clé API (commence par sk-)
Astuce : si vous n’avez pas encore de compte APIMart, inscrivez-vous d’abord sur APIMart et obtenez une clé API.

Étape 1 : Lancer AnythingLLM et accéder aux paramètres

1.1 Démarrer l’application

  1. Lancez l’application de bureau AnythingLLM ou accédez à la version web
  2. Un écran de bienvenue apparaît lors du premier lancement
  3. Cliquez sur le bouton Open settings en bas à gauche
AnythingLLM Main Interface
Remarque : AnythingLLM prend en charge les versions de bureau (Windows, macOS, Linux) et le déploiement Docker.

1.2 Accéder à la configuration LLM

Sur la page des paramètres :
  1. Trouvez LLM Preference dans le menu de gauche
  2. Cliquez pour entrer dans la page de configuration LLM

Étape 2 : Configurer l’API APIMart

2.1 Sélectionner le fournisseur LLM

Sur la page de configuration LLM :
  1. Trouvez le menu déroulant LLM Provider
  2. Sélectionnez Generic OpenAI
LLM Provider Selection
Pourquoi Generic OpenAI ? APIMart fournit une interface API compatible OpenAI, donc en sélectionnant le fournisseur Generic OpenAI dans AnythingLLM, vous pouvez utiliser les services APIMart.

2.2 Configurer les informations API

Après avoir sélectionné Generic OpenAI, remplissez la configuration suivante :
ChampValeur
API KeyVotre clé API APIMart (sk-xxxxxxxxxxxx)
Base URL ou API Base Pathhttps://api.apimart.ai/v1
Chat Model ou Model NameSaisissez le nom du modèle spécifique (voir les modèles recommandés ci-dessous)
API Configuration
Important :
  • La Base URL doit inclure le suffixe /v1 : https://api.apimart.ai/v1
  • La clé API doit être obtenue depuis la console APIMart et commencer par sk-
  • Le nom du modèle doit être l’ID exact du modèle (par ex. gpt-4o, claude-sonnet-4-5-20250929, etc.)
  • Assurez-vous que votre clé API dispose d’un solde suffisant
Modèles recommandés :
Nom du modèleID du modèleCaractéristiques
GPT-5gpt-5Le plus récent et le plus puissant
GPT-4ogpt-4o ou chatgpt-4o-latestConversation de haute qualité
GPT-4o Minigpt-4o-miniRapide et économique
Claude Sonnet 4.5claude-sonnet-4-5-20250929Excellent pour le code et le raisonnement
Claude Haiku 4.5claude-haiku-4-5-20251001Réponse rapide
Gemini 2.0 Flashgemini-2.0-flash-expPrise en charge multimodale
Recommandations de performance :
  • 💰 Économique : gpt-4o-mini, claude-haiku-4-5-20251001
  • 🚀 Haute performance : gpt-5, gpt-4o, claude-sonnet-4-5-20250929
  • Réponse rapide : gemini-2.0-flash-exp, gpt-4o-mini

2.3 Ajuster les paramètres du modèle (optionnel)

Vous pouvez ajuster les paramètres suivants selon vos besoins :
ParamètreDescriptionValeur recommandée
TemperatureContrôle l’aléatoire de la sortie0,7 (créatif) / 0,3 (précis)
Max TokensLongueur maximale de sortie2000-4000
Top PParamètre de nucleus sampling0,9

2.4 Sauvegarder la configuration

  1. Cliquez sur le bouton Save au bas de la page
  2. Le système teste automatiquement la connexion
  3. Un message de succès apparaîtra si la configuration est correcte

Étape 3 : Configurer le modèle d’embedding (optionnel)

AnythingLLM prend en charge les embeddings vectoriels pour la recherche de documents et la fonctionnalité de base de connaissances.

3.1 Accéder aux paramètres d’embedding

Sur la page des paramètres :
  1. Trouvez Embedding Preference dans le menu de gauche
  2. Cliquez pour entrer dans la page de configuration du modèle d’embedding

3.2 Configurer le modèle d’embedding

ChampValeur
Embedding ProviderSélectionnez Generic OpenAI
API KeyVotre clé API APIMart (sk-xxxxxxxxxxxx)
Base URLhttps://api.apimart.ai/v1
Modeltext-embedding-3-small ou text-embedding-3-large
Recommandations de sélection de modèle :
  • text-embedding-3-small — rapide et économique, adapté à la plupart des scénarios
  • text-embedding-3-large — précision plus élevée, adapté aux scénarios exigeant une qualité de recherche élevée

Étape 4 : Créer un workspace et télécharger des documents

4.1 Créer un workspace

  1. Revenez à l’interface principale
  2. Cliquez sur + New Workspace
  3. Saisissez le nom du workspace (par ex. « Assistant de documentation technique », « Base de connaissances du service client »)
  4. Cliquez sur Create

4.2 Télécharger des documents

AnythingLLM prend en charge divers formats de documents : Types de documents pris en charge :
  • 📄 Documents texte — .txt, .md, .pdf, .docx
  • 💻 Fichiers de code — .py, .js, .java, .cpp, etc.
  • 🌐 Pages web — via scraping d’URL
  • 📊 Fichiers de données — .csv, .json, .xml
Étapes de téléchargement :
  1. Sur la page du workspace, cliquez sur Upload Documents
  2. Sélectionnez les fichiers ou faites glisser-déposer dans la zone de téléchargement
  3. Attendez la fin du traitement des documents
  4. Les documents seront automatiquement vectorisés
Traitement des documents : les documents téléchargés sont automatiquement divisés en morceaux et vectorisés à l’aide du modèle d’embedding, stockés dans la base de données locale.

4.3 Gérer les documents

Sur la page de gestion des documents :
  1. Visualisez tous les documents téléchargés
  2. Supprimez les documents inutiles
  3. Visualisez les détails du découpage des documents
  4. Modifiez les métadonnées des documents

Étape 5 : Commencer les conversations

Après la configuration, vous pouvez commencer à utiliser AnythingLLM :

5.1 Conversations de base

  1. Dans le workspace, trouvez la zone de saisie de conversation
  2. Saisissez votre question ou requête
  3. L’IA génère des réponses basées sur vos documents téléchargés et les modèles APIMart

5.2 Utiliser les fonctionnalités de base de connaissances

AnythingLLM va automatiquement :
  1. Analyser votre question
  2. Récupérer le contenu pertinent des documents téléchargés
  3. Générer des réponses précises en combinant le contenu récupéré et le modèle d’IA
Améliorer l’efficacité de la recherche :
  • Téléchargez des documents de qualité et structurés
  • Utilisez des questions claires et spécifiques
  • Mettez à jour et entretenez régulièrement la base de connaissances

5.3 Changer de workspace

Vous pouvez créer plusieurs workspaces pour différents projets ou sujets :
  1. Cliquez sur le nom du workspace en haut à gauche
  2. Sélectionnez d’autres workspaces ou créez-en de nouveaux
  3. Chaque workspace dispose de documents et d’historique de conversation indépendants

Fonctionnalités avancées

1. Mode Agent

AnythingLLM prend en charge la fonctionnalité Agent, permettant à l’IA de :
  • 🔍 Rechercher sur le web — obtenir des informations en temps réel
  • 🧮 Effectuer des calculs — gérer les mathématiques et l’analyse de données
  • 📊 Générer des graphiques — visualiser les données
  • 🔗 Appeler des API — interagir avec des services externes
Activer le mode Agent :
  1. Trouvez Agent Configuration dans les paramètres du workspace
  2. Sélectionnez les outils et fonctionnalités à activer
  3. Sauvegardez la configuration

2. Gestion de l’historique de conversation

  • Exporter les conversations — exporter les conversations au format texte ou JSON
  • Rechercher l’historique — trouver rapidement les conversations passées
  • Supprimer les enregistrements — nettoyer l’historique de conversation inutile

3. Prompts système personnalisés

Dans les paramètres du workspace :
  1. Trouvez System Prompt
  2. Personnalisez le rôle et le comportement de l’IA
  3. Exemple :
You are a professional technical support engineer, skilled at answering technical questions about products.
When answering, please:
1. Maintain professionalism and courtesy
2. Provide detailed step-by-step instructions
3. If uncertain, recommend contacting technical support

4. Gestion multi-utilisateurs (déploiement Docker uniquement)

En cas de déploiement Docker :
  • Créer plusieurs comptes utilisateurs
  • Définir différents niveaux de permission
  • Gérer les permissions d’accès aux workspaces

5. Accès API

AnythingLLM fournit une API REST pour :
  • L’accès programmatique aux workspaces
  • Télécharger et gérer les documents
  • Envoyer des requêtes de conversation
  • Intégrer dans vos applications

FAQ

Q1 : Impossible de se connecter au service APIMart ?

Solution :
  1. Vérifier la Base URL :
    • Assurez-vous qu’il s’agit de https://api.apimart.ai/v1 (inclut /v1)
    • N’ajoutez pas de chemins supplémentaires et n’omettez pas /v1
  2. Vérifier la clé API :
    • Confirmez que la clé API commence par sk-
    • Vérifiez si la clé est valide dans la console APIMart
  3. Vérifier la connexion réseau :
    • Assurez-vous que vous pouvez accéder à https://api.apimart.ai
    • Vérifiez les paramètres du pare-feu ou du proxy

Q2 : Les documents ne sont pas correctement récupérés après le téléchargement ?

Solution :
  1. Vérifier la configuration du modèle d’embedding :
    • Confirmez que le modèle d’embedding est correctement configuré
    • Testez la connexion du modèle d’embedding
  2. Retraiter les documents :
    • Supprimez et retéléchargez les documents
    • Vérifiez si le format du document est pris en charge
  3. Ajuster les paramètres de recherche :
    • Ajustez le seuil de similarité dans les paramètres du workspace
    • Augmentez le nombre de fragments de documents retournés

Q3 : Réponse de conversation lente ?

Solution :
  1. Passer à des modèles plus rapides :
    • Utilisez gpt-4o-mini au lieu de gpt-4o
    • Utilisez gemini-2.0-flash-exp pour une réponse plus rapide
  2. Optimiser la quantité de documents :
    • Réduisez le nombre de documents dans le workspace
    • Supprimez les gros fichiers inutiles
  3. Ajuster Max Tokens :
    • Réduisez la longueur maximale de sortie
    • Utilisez des prompts plus concis

Q4 : Comment consulter l’utilisation et les coûts de l’API ?

Connectez-vous à la console APIMart pour voir :
  • 📊 Statistiques d’appels API
  • 💰 Détails des coûts
  • 📈 Graphiques de tendance d’utilisation
  • 🔍 Journaux détaillés des requêtes

Q5 : Quelles options de déploiement AnythingLLM prend-il en charge ?

AnythingLLM prend en charge plusieurs options de déploiement :
  • 🖥️ Application de bureau — Windows, macOS, Linux
  • 🐳 Docker — déploiement auto-hébergé
  • ☁️ Version cloud — AnythingLLM Cloud (à venir)

Exemples de cas d’utilisation

1. Base de connaissances d’entreprise

Configuration :
  • Modèle : gpt-4o-mini (économique)
  • Documents : documents internes de l’entreprise, manuels, FAQ
  • Fonction : recherche rapide d’informations pour les employés
Exemples d’utilisation :
  • Intégration des nouveaux employés
  • Recherche rapide de politiques d’entreprise
  • Recherche dans la documentation technique

2. Assistant de documentation technique

Configuration :
  • Modèle : claude-sonnet-4-5-20250929 (excellent pour le code)
  • Documents : docs API, spécifications techniques, base de code
  • Fonction : aider les développeurs à trouver des informations techniques
Exemples d’utilisation :
  • Requêtes de documentation d’utilisation d’API
  • Recherche d’exemples de code
  • Réponses aux questions techniques

3. Base de connaissances du service client

Configuration :
  • Modèle : gpt-4o (conversation de haute qualité)
  • Documents : manuels de produit, FAQ, solutions
  • Fonction : réponse rapide aux questions des clients
Exemples d’utilisation :
  • Réponse automatique aux FAQ
  • Guide d’utilisation du produit
  • Suggestions de dépannage

4. Assistant de recherche et d’apprentissage

Configuration :
  • Modèle : gpt-5 (compréhension puissante)
  • Documents : articles de recherche, manuels, notes
  • Fonction : aide à l’apprentissage et à la recherche
Exemples d’utilisation :
  • Synthèse et analyse d’articles
  • Explication des points de connaissance
  • Planification du parcours d’apprentissage

Fonctionnalités

En utilisant AnythingLLM + APIMart, vous pouvez :
  • 📚 Base de connaissances privée — construire une base de connaissances privée sécurisée localement
  • 🔒 Confidentialité des données — toutes les données stockées localement, protégeant la confidentialité
  • 🤖 Prise en charge multi-modèles — basculer de manière flexible entre différents modèles d’IA
  • 📄 Prise en charge multi-formats — prise en charge de divers formats de documents
  • 🎯 Recherche précise — recherche intelligente basée sur les vecteurs
  • 💬 Conversation contextuelle — maintenir le contexte dans les longues conversations
  • 🔧 Hautement personnalisable — prompts personnalisés, paramètres, etc.
  • 🌐 Multi-plateforme — prend en charge Windows, macOS, Linux

Sécurité et confidentialité des données

Stockage local des données

Approche de stockage des données d’AnythingLLM :
  • 📁 Système de fichiers local — documents stockés localement
  • 🗄️ Base de données vectorielle locale — index vectoriels stockés localement
  • 💾 Historique de conversation — enregistrements de conversation stockés localement

Sécurité des appels API

  • 🔐 Transmission chiffrée — tous les appels API utilisent le chiffrement HTTPS
  • 🔑 Protection de la clé — clé API stockée en toute sécurité
  • 🚫 Pas de conservation des données — APIMart ne stocke pas le contenu de vos conversations
Avis de confidentialité : bien que les documents soient stockés localement, les conversations et le contenu récupéré envoyés à l’IA sont transmis aux serveurs APIMart via l’API pour traitement. Veuillez éviter de télécharger ou d’interroger du contenu contenant des informations sensibles.

Bonnes pratiques

1. Gestion des documents

  • Mises à jour régulières — maintenir à jour le contenu des documents
  • Organisation structurée — utiliser une structure de dossiers claire
  • Conventions de nommage — utiliser des noms de fichiers significatifs
  • Supprimer les obsolètes — nettoyer régulièrement les documents obsolètes

2. Optimisation des prompts

❌ Mauvais prompt :
You are an assistant
✅ Bon prompt :
You are a professional technical support assistant specializing in helping users resolve product-related technical issues.

When answering, please follow these principles:
1. Answer based on provided documentation; if information isn't available, clearly state so
2. Provide detailed step-by-step instructions with examples when necessary
3. Use clear, understandable language
4. For complex issues, recommend contacting the technical support team

3. Optimisation des performances

  • Contrôler la taille des documents — éviter de télécharger des fichiers individuels trop volumineux
  • Découpage raisonnable — utiliser les paramètres de découpage de document par défaut
  • Choisir un modèle approprié — sélectionner le modèle en fonction de la complexité de la tâche
  • Surveiller l’utilisation — vérifier régulièrement l’utilisation de l’API

4. Planification des workspaces

  • Diviser par projet — créer des workspaces indépendants pour différents projets
  • Gestion des permissions — définir les permissions des workspaces de manière appropriée (version Docker)
  • Sauvegarder les données — sauvegarder régulièrement les workspaces importants

Support et aide

Si vous rencontrez des problèmes :

Commencer à utiliser APIMart

Inscrivez-vous à APIMart maintenant, obtenez votre clé API et construisez votre base de connaissances privée dans AnythingLLM !