get_indexed_document method
Leave feedback
On this page
Gets an indexed document by document key.
The method accepts the file path of a document indexed from a file (as returned by DocumentInfo.file_path, which is a full path) or the key of a document indexed from a stream or a structure, and returns None if there is no such document in the index.
def get_indexed_document(self, document_key):
...
| Parameter | Type | Description |
|---|---|---|
| document_key | str |
The document key. |
Returns: The indexed document.
from groupdocs.search import Index
index = Index("./index")
doc = index.get_indexed_document("example.docx")
if doc is not None:
print(doc.file_path)
These names call get_indexed_document too, limited to the overloads listed.
| Alias | Accepts |
|---|---|
get_indexed_document_file |
get_indexed_document_file(document_key) |
get_indexed_document_string |
get_indexed_document_string(document_key) |
- class
Index
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.