SearchResult class Leave feedback

SearchResult class

Represents a search result matching a search query.

Learn more

Searching: https://docs.groupdocs.com/search/python-net/searching/
Search results: https://docs.groupdocs.com/search/python-net/search-results/

The SearchResult type exposes the following members:

Methods

Method	Description
get_enumerator	Returns an iterator that iterates through the collection of the documents found.
get_found_document	Returns the found document at the specified index.

Properties

Property	Description
document_count	The number of documents found.
end_time	The end time of the search.
next_chunk_search_token	The chunk search token for searching the next chunk.
occurrence_count	The total number of occurrences found.
search_duration	The search duration.
start_time	The start time of the search.
truncated	The result is truncated.
warnings	The warnings describing the result.

Example

from groupdocs.search import Index
from groupdocs.search.options import SearchOptions, TableDiscreteFunction

index_folder = "./MyIndex"
document_folder = "./documents"

# Create an index and add documents
index = Index(index_folder)
index.add(document_folder)

# Configure search options (enable fuzzy search with max 3 differences)
options = SearchOptions()
options.fuzzy_search.enabled = True
options.fuzzy_search.fuzzy_algorithm = TableDiscreteFunction(3)

# Perform search
result = index.search('Einstein OR "Theory of Relativity"', options)

print(f"Documents: {result.document_count}")
print(f"Total occurrences: {result.occurrence_count}")

for i in range(result.document_count):
    doc = result.get_found_document(i)
    print(f"\tDocument: {doc.document_info.file_path}")
    print(f"\tOccurrences: {doc.occurrence_count}")
    for field in doc.found_fields:
        print(f"\t\tField: {field.field_name}")
        print(f"\t\tOccurrences: {doc.occurrence_count}")
        if field.terms:
            for term, occ in zip(field.terms, field.terms_occurrences):
                print(f"\t\t\t{term.ljust(20)}{occ}")
        if field.term_sequences:
            for seq, occ in zip(field.term_sequences, field.term_sequences_occurrences):
                sequence = " ".join(seq)
                print(f"\t\t\t{sequence.ljust(30)}{occ}")

SearchResult class Leave feedback

On this page

SearchResult class

Methods

Properties

Example

See Also

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!

On this page