Browse our Products
If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.
If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.
Product Page | Docs | Demos | API Reference | Blog | Free Support | Temporary License
GroupDocs.Search for Python via .NET is a full-text search API. Build an index over a folder of documents, keep it on disk, and run keyword, phrase, wildcard, regular-expression, fuzzy, boolean, faceted, date-range, synonym and homophone queries against it, then highlight what was found. It reads Word, Excel, PowerPoint, PDF, email, eBook, web, archive and plain-text formats through one API, with no Microsoft Office or other software installed.
pip install groupdocs-search-net
Every release’s wheels are also on releases.groupdocs.com, for installing offline: download the one for your platform and run pip install on the file.
from groupdocs.search import Index
index = Index("./index") # creates the index folder, or opens an existing index
index.add("./documents") # indexes every supported file in the folder
result = index.search("contract")
print("Found in %d documents (%d occurrences)" % (result.document_count, result.occurrence_count))
The package is a self-contained Python wheel (~250 MB) that bundles the embedded .NET runtime and everything needed to read, index and search documents: just pip install and start indexing. On Linux the system also needs ICU, and libgdiplus for presentations; on macOS, mono-libgdiplus for presentations (see System Requirements below). The wheel works across Python 3.5-3.14 on Windows, Linux, and macOS 13 or newer (Intel + Apple Silicon).
An index is a folder: build it once, reopen it in a later run, and update() re-indexes only the documents that changed. The first call into the engine takes about a second. On Windows, applying a license makes the first call take 15-30 seconds, once per process: the engine’s license check takes that long there, in plain .NET too.
update(), optimize(), merging indexes and deleting documents."..."), wildcards (? for one character, ?(1~5) for one to five), regular expressions (^...), boolean AND / OR / NOT, field (faceted) queries, date and numeric ranges, and queries built as objects.index.events.file_indexing += handler.For the complete list, see supported document formats.
| Category | Formats |
|---|---|
| Word Processing | DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, TXT, ODT, OTT |
| Spreadsheets | XLS, XLSX, XLSM, XLSB, CSV, ODS, OTS |
| Presentations | PPT, PPTX, PPTM, PPS, PPSX, ODP |
| EML, EMLX, MSG, PST, OST, MBOX | |
| Fixed-Layout | |
| eBook | EPUB, FB2, CHM |
| Web & Markup | HTM, HTML, MHT, MHTML, XML, MD |
| Archives | ZIP, and the documents inside them |
from groupdocs.search import Index
index = Index("./index")
index.add("./documents")
print("Indexed documents:", len(index.get_indexed_documents()))
from groupdocs.search import Index
index = Index("./index")
index.add("./documents")
for query in ["contract", '"service agreement"', "?ontract", "^cont.*", "contract AND NOT draft"]:
result = index.search(query)
print("%-28s %d documents" % (query, result.document_count))
from groupdocs.search import Index
from groupdocs.search.options import SearchOptions, SimilarityLevel
index = Index("./index")
index.add("./documents")
options = SearchOptions()
options.fuzzy_search.enabled = True
options.fuzzy_search.fuzzy_algorithm = SimilarityLevel(0.8) # 0.0 (loose) .. 1.0 (strict)
result = index.search("contarct", options) # also matches "contract"
print(result.document_count, result.occurrence_count)
from groupdocs.search import Index
index = Index("./index")
index.add("./documents")
result = index.search("contract")
for found in result:
print(found.document_info.file_path, "-", found.occurrence_count, "occurrences")
from groupdocs.search import Index
from groupdocs.search.common import FileOutputAdapter
from groupdocs.search.highlighters import DocumentHighlighter
from groupdocs.search.options import OutputFormat
index = Index("./index")
index.add("./documents")
result = index.search("contract")
adapter = FileOutputAdapter(OutputFormat.HTML, "./highlighted.html")
index.highlight(result.get_found_document(0), DocumentHighlighter(adapter))
from groupdocs.search import Index
index = Index("./index")
def on_file_indexing(sender, args):
if args.document_full_path.endswith(".tmp"):
args.skip_indexing = True # leave this file out of the index
index.events.file_indexing += on_file_indexing
index.events.operation_progress_changed += lambda sender, args: print(
"%d of %d documents" % (args.processed_documents, args.total_documents))
index.add("./documents")
A handler runs on the thread that raises the event. With IndexingOptions.threads above 1, or with is_async, that is an engine thread: an exception a handler raises there is printed to stderr and ignored. Unsubscribe with -=, or remove every handler with index.events.file_indexing.clear().
from groupdocs.search import Index, IndexSettings
class LogExtractor(object):
"""Text of .log files, which the engine does not read on its own."""
extensions = [".log"]
def get_fields(self, source): # a file path, or the engine's stream
if isinstance(source, str):
with open(source, encoding="utf-8") as f:
text = f.read()
else:
text = source.read().decode("utf-8")
return [("Content", text)]
settings = IndexSettings()
settings.custom_extractors.add(LogExtractor())
index = Index("./index", settings)
index.add("./logs")
print(index.search("timeout").document_count)
Loggers (error(message), trace(message)), word splitters, word-form providers, document loaders and OCR connectors are plain Python objects or functions in the same way.
from groupdocs.search import Index
index = Index("./index")
index.add("./documents")
# ... files in ./documents are added, changed or removed ...
index.update() # re-indexes only what changed since the last add() or update()
index.optimize() # merges index segments so searches stay fast
This package is designed for seamless integration with AI agents, LLMs, and automated code generation tools.
AGENTS.md in the package - AI coding assistants (Claude Code, Cursor, GitHub Copilot) auto-discover the API surface, usage patterns, and troubleshooting tips from the installed package. Setup per tool: AI agents and LLM integration{ "mcpServers": { "groupdocs-docs": { "url": "https://docs.groupdocs.com/mcp" } } }
https://docs.groupdocs.com/search/python-net/llms-full.txt.md to any docs URLThe API works without a license in evaluation mode, with these limitations:
add() does not raise for the rest: it leaves them out and reports “Number of indexed documents is restricted” through index.events.error_occurred.result.get_found_document(10) raises LicenseRestrictionException.To remove these limitations, apply a license or request a temporary license:
from groupdocs.search import License
License().set_license("path/to/license.lic")
Or set the environment variable, which is applied at the first call into the engine:
export GROUPDOCS_LIC_PATH="path/to/license.lic"
A license that cannot be applied raises LicenseError from that first call on, rather than falling back to evaluation mode.
| Issue | Platform | Fix |
|---|---|---|
The process aborts with Couldn't find a valid ICU package, or DOTNET_SYSTEM_GLOBALIZATION_INVARIANT errors | Linux | Install ICU (apt-get install libicu-dev) and do NOT set this variable |
is not a supported wheel on this platform or No matching distribution found for groupdocs-search-net | Linux/macOS | The OS is older than the wheel needs (glibc 2.27, macOS 13), or pip is older than 20.3: python -m pip install --upgrade pip. On an Intel Mac, a Python built against an old SDK reports macOS 10.16 - use pip 24.1+ or SYSTEM_VERSION_COMPAT=0 pip install groupdocs-search-net |
| The first call takes 15-30 seconds when a license is applied | Windows | The engine’s license check, once per process (measured in plain .NET too). Reuse the process for many operations |
A presentation is not indexed, and error_occurred reports The type initializer for 'Gdip' threw an exception or a NullReferenceException | Linux/macOS | Install libgdiplus: apt-get install libgdiplus / brew install mono-libgdiplus. ODP and PPT files need it |
... cannot be changed because the index ... contains documents | All | Since 26.10, dictionaries and the settings that split text into words can change only while the index is empty: set them before the first add() |
AttributeError: 'IndexSettings' object has no attribute ... with a “Did you mean” hint | All | The property name is misspelled; assigning it would have had no effect on the engine |
AttributeError: 'file_indexing' is a .NET event | All | Subscribe with +=, not =: index.events.file_indexing += handler |
LicenseRestrictionException: Only first 10 results can be returned, or only 100 documents indexed | All | Evaluation mode: apply a license (above) |
apt-get install libicu-dev libgdiplus). No fonts are needed.brew install mono-libgdipluserror_occurred says why. Every other format indexes without it.Also available for other platforms: .NET | Java | Node.js
Product Page | Docs | Demos | API Reference | Examples | Blog | Search | Free Support | Temporary License
GroupDocs.Search GroupDocs.Total Python PyPI Full-Text-Search Document-Search Search-Index Fuzzy-Search Faceted-Search Highlighting
Self-contained Python wheel of GroupDocs.Search 26.10 for Windows (x64). Compatible with Python 3.5-3.14. No external dependencies required. Full-text search and indexing for documents.
Added: 4/11/2026
Downloads:
File Size: 243.51MB
Self-contained Python wheel of GroupDocs.Search 26.10 for Linux (x64). Compatible with Python 3.5-3.14. Requires ICU and libgdiplus (apt-get install libicu-dev libgdiplus; libgdiplus serves presentations: without it, ODP and PPT files are left out of the index). Full-text search and indexing for documents.
Added: 4/11/2026
Downloads:
File Size: 245.63MB
Self-contained Python wheel of GroupDocs.Search 26.10 for macOS amd64 (Intel). Compatible with Python 3.5-3.14. Requires mono-libgdiplus (brew install mono-libgdiplus). Full-text search and indexing for documents.
Added: 4/11/2026
Downloads:
File Size: 250.69MB
Self-contained Python wheel of GroupDocs.Search 26.10 for macOS arm64 (Apple Silicon). Compatible with Python 3.5-3.14. Requires mono-libgdiplus (brew install mono-libgdiplus). Full-text search and indexing for documents.
Added: 4/11/2026
Downloads:
File Size: 247.11MB