Documentation Whoosh-NG

Bibliothèque d'indexation et de recherche full-text purement Python, modernisée pour 2025+.

Vitesse de démarrage

pip install whoosh-ng

import whoosh.index as index
from whoosh.fields import Schema, TEXT, ID

schema = Schema(id=ID(stored=True), content=TEXT())
ix = index.create_in("indexdir", schema)

with ix.writer() as w:
    w.add_document(id="1", content="hello world")

with ix.searcher() as s:
    results = s.search("world")
    print(results[0])

Derniere version publiee: v5.1.0 | Voir les releases sur GitHub | Derniere mise a jour: 2026-08-12

Documentation

• API Reference — Documentation complète des modules
• Guides — Tutoriels et bonnes pratiques
• Exemples — Exemples de code exécutables
• English Documentation — Documentation in English

Structure de la documentation

Core (Whoosh classique)

• Démarrage rapide — Tutoriel en 5 minutes
• Installation — Instructions d'installation
• Concepts fondamentaux — Schémas, champs, recherche
• Indexation — Ajout et mise à jour de documents
• Recherche — Analyse de requêtes et résultats
• Conception de schéma — Types de champs et stockage
• Langage de requête — Syntaxe de requête style Lucene
• Backends — Stockage fichier, SQLite, mémoire
• Stemming & Mots Vides — Racines de mots et mots vides
• N-grammes — Sous-chaînes, préfixes et autocomplétion
• Migration — Migration depuis Whoosh classique
• Nettoyage legacy — Suppression du code legacy

Modern (Nouvelles fonctionnalités)

• Middleware — Hooks de pipeline et middleware
• Middleware & Pipeline de Plugins — Pipeline basé sur hooks
• Plugins — Extension de Whoosh-NG
• Système de Plugins — API PluginManager
• Autocomplétion — Fournisseurs d'autocomplétion
• Fournisseurs d'Autocomplétion — NGram, Fuzzy, InvertedIndex
• Recherche vectorielle — NumPy, HNSW, Faiss
• Indexation moderne — BatchIndexWriter, AnalyzerCache
• Monitoring — Métriques et observabilité
• Performance — Benchmarking et optimisation
• Synonymes & Linguistique — SynonymManager
• Fournisseurs de Stemmers — Backends PyStemmer
• Intégration des Providers — Guide complet du pipeline pour tous les providers

API Reference

• Modern API — Sources de données, validation, facettes, middleware

Exemples

• Indexation de base — Exemples d'indexation de documents
• Recherche — Interrogation et récupération de résultats
• Modèles de recherche — Auto-mapping des modèles Python vers Whoosh
• FastAPI — API REST avec FastAPI
• Middleware — Patterns de middleware personnalisés
• Pipeline de middleware — Nouvelle tentative, cache, journalisation
• Application de recherche cinéma — Application de recherche complète
• Développement de plugins — Créer des plugins
• Sources de données — SQLSource, RESTSource, GraphQLSource, FastCSVSource, JSONSource, ParquetSource, PandasSource, PolarsSource, SQLAlchemySource, PeeweeSource, TortoiseSource
• Découverte de schéma — Inspection des jeux de résultats
• Gestionnaire de facettes — Auto-découverte et remplacements manuels
• Framework de validation — Validation 4 niveaux
• SearchView — Intégration du pipeline complet
• Autocomplétion — Exemples de fournisseurs d'autocomplétion
• Recherche vectorielle — Intégration NumPy, HNSW et Faiss

Liens rapides

• Dépôt GitHub: whoosh-ng
• Paquet PyPI: whoosh-ng
• Signalements de bugs: GitHub Issues
• Documentation pour LLM:
  • llms.txt — Index de toutes les pages de documentation
  • llms-full.txt — Documentation API complète