Téléchargez et extrayez le package de démo Python.
Le package contient les scripts et la configuration utilisés pour démontrer la gestion de collection, le traitement de document, l’inférence et les opérations API associées.
Dernière mise à jour le
12 oct. 2026
Exécutez, inspectez et adaptez une implémentation Python fonctionnelle des workflows d’API de Knowledge Base courants.
Le démo Python fournit un point de départ fonctionnel pour le développement d’applications. Utilisez le workflow complet pour voir la création de collections, le traitement de documents et l’inférence IA fonctionner ensemble, puis explorez les scripts individuels pour des opérations spécifiques de collection et d’inférence.
Avant de commencer
Vérifiez que vous disposez des éléments suivants :
- Accès à l’API Knowledge Base.
- Informations d’identification requises pour authentifier votre application.
- Python 3.7 ou version ultérieure. Il est recommandé d’utiliser Python 3.11 ou une version ultérieure.
- Un PDF que vous pouvez utiliser pour le workflow de démo complet.
Si vous n’avez pas configuré l’accès API, consultez la rubrique Configuration de l’accès à l’API Knowledge Base.
Télécharger et configurer la démo Python
Créez un environnement virtuel :
python3 -m venv venv
Activez l’environnement :
- Sur macOS ou Linux :
source venv/bin/activate - Sur Windows :
venv\Scripts\activate
Installez les dépendances :
pip install --upgrade pip
pip install -e .
Ajoutez les informations d’identification API requises et la configuration de service à config.yaml.
Accédez au sous-dossier python avant d’exécuter les scripts d’exemple.
La démo utilise requests, pyyaml et tqdm. Les informations d’identification sont stockées dans config.yaml, et les jetons d’authentification sont gérés automatiquement.
Ne validez pas les fichiers config.yaml ou .token générés dans le contrôle source.
Exécutez le workflow complet
Exécutez :
python knowledgebase.py
Pour utiliser un PDF spécifique :
python knowledgebase.py --document=<chemin-vers-pdf>
La démo :
- S’authentifie avec l’API.
- Crée une collection nommée demo-collection.
- Charge un PDF.
- Surveille le document jusqu’à ce que l’indexation soit terminée.
- Exécute une demande d’inférence sur le document traité.
Le chargement et l’indexation constituent des parties distinctes de l’ingestion de documents. L’indexation extrait le contenu du document et le rend disponible pour les opérations d’IA.
Si vous ne spécifiez pas de PDF, la démonstration en sélectionne un dans le répertoire de documents du package. Le traitement du document expire après cinq minutes s’il n’atteint pas un état complet.
Annotation
Le workflow complet crée une collection nommée demo-collection et y charge un PDF. La démonstration ne supprime pas la collection ou le document chargé lorsque le workflow se termine.
Explorer les opérations de collection
Après avoir exécuté le workflow complet, utilisez des scripts individuels pour explorer des opérations d’API spécifiques.
Créer une collection
python collection.py --action create --name <collection-name>
Les noms de collection peuvent contenir jusqu’à 255 caractères.
Répertorier les collections
python collection.py --action list
Indiquez si vous souhaitez répertorier les collections que vous avez créées, que vous avez partagées ou que d’autres personnes ont partagé lorsque vous y êtes invité.
Partager une collection
python collection.py --action share --collection-id <collection-id>
Saisissez les adresses e-mail qui doivent recevoir un accès en lecture ou en écriture lorsque vous y êtes invité.
Charger les documents
python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>
Le script peut charger un fichier unique ou des documents depuis un répertoire spécifié.
Répertorier les documents dans une collection
python collection.py --action get_documents --collection-id <collection-id>
Vérifier le statut de traitement du document
python collection.py --action get_status --document-id <document-id>
La démonstration fournit ces opérations comme exemples autonomes que vous pouvez examiner et adapter indépendamment du workflow complet.
Explorer les opérations d’inférence
Les exemples d’inférence nécessitent un identifiant de collection et un identifiant de document. Utilisez les scripts de collection pour les identifier :
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Réponses aux questions
Répertoriez vos collections et documents, puis exécutez l’exemple de questions-réponses :
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Saisissez l’identifiant de collection, l’identifiant de document et la question lorsque vous y êtes invité.
Synthèse de document
Identifiez la collection et le document, puis exécutez l’exemple de résumé :
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Saisissez l’identifiant de collection et l’identifiant de document lorsque vous y êtes invité.
Recherche contextuelle
Identifiez la collection et le document, puis exécutez l’exemple de recherche contextuelle :
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Saisissez l’identifiant de collection, l’identifiant de document et le texte de recherche lorsque vous y êtes invité.
Extraction de propriétés
Identifiez la collection et le document, puis exécutez l’exemple d’extraction :
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Saisissez l’ID de collection, l’ID de document, le nom de propriété, l’invite d’extraction, le type de données et la description facultative lorsque vous y êtes invité.
Poursuivre la création avec l’API
La démonstration Python fournit des modèles d’implémentation fonctionnels plutôt qu’une documentation complète de l’API.
Utilisez Commencer à utiliser l’API Knowledge Base pour comprendre le modèle de ressource API, le cycle de vie des documents, le comportement d’inférence et la gestion des réponses.
Utilisez la Référence de l’API Knowledge Base lorsque vous avez besoin des chemins d’accès de point d’entrée actuels, des paramètres, des schémas de demande et de réponse, et des informations de statut.
Dépannage
La démonstration écrit des informations de diagnostic détaillées dans :
logs/knowledgebase-demo.log
Le fichier journal enregistre les informations de niveau DEBUG, tandis que la console affiche les messages de niveau WARNING et supérieurs.
Si une opération échoue :
- Consultez logs/kinowledgebase-demo.log pour les détails de demande et d’authentification.
- Vérifiez les paramètres dans config.yaml.
- Confirmez que le PDF que vous utilisez existe et est accessible.
- Confirmez que l’application utilise le point d’entrée de service approprié pour votre organisation.
- Confirmez que l’identité authentifiée a accès à la ressource demandée.
- Pour les échecs d’API, conservez le X-Request-ID renvoyé dans les en-têtes de réponse lorsqu’il est disponible. L’assistance peut utiliser cet identifiant pour tracer la demande.
Considérations relatives à la mise en œuvre
- Le workflow complet accepte les fichiers PDF.
- La démo gère les jetons d’authentification après la configuration de l’accès à l’API.
- Les opérations d’API utilisent les autorisations disponibles pour l’identité authentifiée.
- Le package source inclut une fonctionnalité de découverte de point d’entrée régional, mais les valeurs de point d’entrée de production doivent provenir de la documentation de l’API Knowledge Base actuelle plutôt que des valeurs héritées incluses avec la démonstration.
