Class RetrievalOptions
Namespace: Cephalon.Retrieval.Configuration
Assembly: Cephalon.Retrieval.dll
Configures the built-in retrieval runtime pack.
public sealed class RetrievalOptionsInheritance
Section titled “Inheritance”Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”These options seed the host-owned part of the retrieval runtime. Installed modules can still
contribute additional knowledge collections through
Constructors
Section titled “Constructors”RetrievalOptions()
Section titled “ RetrievalOptions()”Creates retrieval options with the default host-owned features enabled.
public RetrievalOptions()Properties
Section titled “Properties”BackgroundReindexCollectionIds
Section titled “ BackgroundReindexCollectionIds”Gets the optional collection ids included in background reindexing. When empty, every registered collection is included.
public IList<string> BackgroundReindexCollectionIds { get; }Property Value
Section titled “Property Value”BackgroundReindexInitialDelaySeconds
Section titled “ BackgroundReindexInitialDelaySeconds”Gets or sets the startup delay, in seconds, before the first background reindex run.
public int BackgroundReindexInitialDelaySeconds { get; set; }Property Value
Section titled “Property Value”BackgroundReindexIntervalSeconds
Section titled “ BackgroundReindexIntervalSeconds”Gets or sets the interval, in seconds, between background reindex runs. Values less than one disable repeated runs after the optional startup run.
public int BackgroundReindexIntervalSeconds { get; set; }Property Value
Section titled “Property Value”Collections
Section titled “ Collections”Gets the host-defined knowledge collections that should be available to the retrieval runtime.
public IList<KnowledgeCollectionDescriptor> Collections { get; }Property Value
Section titled “Property Value”IList<KnowledgeCollectionDescriptor>
DefaultQueryLimit
Section titled “ DefaultQueryLimit”Gets or sets the default maximum number of matches returned when a query request does not choose one explicitly.
public int DefaultQueryLimit { get; set; }Property Value
Section titled “Property Value”EnableBackgroundReindexing
Section titled “ EnableBackgroundReindexing”Gets or sets a value indicating whether Cephalon should run the opt-in background reindex scheduler.
public bool EnableBackgroundReindexing { get; set; }Property Value
Section titled “Property Value”EnableIngestion
Section titled “ EnableIngestion”Gets or sets a value indicating whether ingestion features are enabled.
public bool EnableIngestion { get; set; }Property Value
Section titled “Property Value”EnableQuerying
Section titled “ EnableQuerying”Gets or sets a value indicating whether query features are enabled.
public bool EnableQuerying { get; set; }Property Value
Section titled “Property Value”FreshnessStaleAfterSeconds
Section titled “ FreshnessStaleAfterSeconds”Gets or sets the number of seconds after which the latest successful index is considered stale for operator reporting.
public int FreshnessStaleAfterSeconds { get; set; }Property Value
Section titled “Property Value”MaximumQueryLimit
Section titled “ MaximumQueryLimit”Gets or sets the upper bound applied to query result limits.
public int MaximumQueryLimit { get; set; }Property Value
Section titled “Property Value”RunBackgroundReindexOnStartup
Section titled “ RunBackgroundReindexOnStartup”Gets or sets a value indicating whether the scheduler should run once when the host starts.
public bool RunBackgroundReindexOnStartup { get; set; }