1. API Reference
  2. /
  3. GroupDocs.Search
  4. /
  5. GroupDocs.Search for Python via .NET
  6. /
  7. groupdocs.search
  8. /
  9. IndexSettings class

IndexSettings class

On this page

IndexSettings class

Represents the index settings that allow customizing the indexing operations.

Learn more:

The IndexSettings type exposes the following members:

Constructors

Constructor Description
init Initializes a new instance of the IndexSettings class.

Properties

Property Description
custom_extractors The custom extractor collection.
document_filter The document filter applied during indexing; when None, all added documents are indexed.
in_memory_index The property returns a value indicating whether the index is stored in memory or on disk.
index_type The index type. The default value is IndexType.normal_index.
logger The logger used for logging events and errors in the index; it is not saved and must be created and assigned each time the index is created or loaded.
max_indexing_report_count The maximum number of indexing reports. The default value is 5.
max_search_report_count The maximum number of search reports, defaulting to 10.
replace_unpaired_surrogates The flag for replacing unpaired surrogates. The default value is True.
search_threads The number of threads used for the search.
skip_blended_only_terms The flag indicating whether to skip terms consisting solely of blended characters. The default value is True.
text_storage_settings The text storage settings. The default value is None, which means that document texts are not stored.
use_character_replacements The property indicates whether character replacements are used during indexing. The default value is False.
use_stop_words The flag indicating whether to use stop words during indexing. The default value is True.

Example 

from groupdocs.search import Index, IndexSettings
from groupdocs.search.options import IndexType

settings = IndexSettings()
settings.index_type = IndexType.COMPACT_INDEX  # Set the index type

index = Index("./MyIndex", settings)  # Create an index with the specified settings

Guides

Task guides that use IndexSettings:

See Also

On this page

© Groupdocs 2001-2026. All Rights Reserved.