Keyoti SearchUnit API Docs
SearchAgent Class
API DocumentationKeyoti.SearchEngine.SearchSearchAgent
Keyoti SearchUnit v6
Performs searches with user defined queries.
Declaration Syntax
C#Visual Basic
public class SearchAgent
Public Class SearchAgent
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
SearchAgent(String, Configuration)
Creates a new instance with no query specified.

SearchAgent(String, String, Configuration) Obsolete.
Creates a new instance.

AddResultItemToResults(ResultItem, ResultItemList)
Add a ResultItem object to the collection

AllDocumentReturnQuery
The query that the user can use to retrieve a list of all documents

Configuration
Configuration of the index

CreateQueryExpressionParser(String)
Creates an instance of QueryExpressionParser.

CreateWholeExpressionGroup(String)
Creates a GroupElement representing the search expression.

DataAccess
The data-access layer.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FilterLoadLevel
Specifies what amount of data to load for any filtering by an AddResultItemToResults override.

Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetContentCategoryRecords()()()()
Gets all content category records from the index.

GetDocumentText(String)
Returns a document's text.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetLocationCategoryRecords()()()()
Gets all location category records from the index.

GetNumberOfResults(ArrayList)
Returns number of results for a each query in queryExpressions collection

GetSearchQuerySuggestions(String, Int32)
Returns a list of words that may be suggestions for segment using the search lexicon only.

GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
LicenseKey
The license key.

LookUpWordInLexicon(String, Boolean)
Returns whether word is in the lexicon

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
QueryGroup
A GroupElement based on the entire search query.

QueryString
Search query

RegisterDataSetBasedSource(Int32, DataSetBasedSource)
Registers a DataSetBasedSource for use in result URL mapping.

Search(String, Int32, Int32)
Runs the search and returns results between lowRange (inclusive and 1 based) and highRange (inclusive and 1 based), ensure the QueryString property is set before calling this.

Search(String, SearchOptions, Int32, Int32)
Runs the search and returns results between lowRange (inclusive) and highRange (inclusive), ensure the QueryString property is set before calling this.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy
Object
SearchAgent

Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2022.8.22.610