TypeAheadParameters Class

Ankiro Enterprise Suite Reference Documentation

The TypeAheadParameters class encapsulates the mandatory and optional parameters used to obtain type ahead suggestions from Ankiro Suite. Type ahead is the term used for suggestions as to what the user may be in the process of typing from within a search box. Type ahead suggestions are generated using analysis of previous searches for a specified search profile. Type ahead parameters are used in conjunction with the ISearchWebService.GetTypeAheadSuggestions method.

Inheritance Hierarchy

System Object
Ankiro.SearchServer.Data.Search TypeAheadParameters

Namespace: Ankiro.SearchServer.Data.Search
Assembly: Ankiro.SearchServer.Data (in Ankiro.SearchServer.Data.dll) Version: 1.13.770.19207 (1.13.770.19207)

Syntax

C++

Copy to Clipboard Print

public class TypeAheadParameters : IExtensibleDataObject

public class TypeAheadParameters : IExtensibleDataObject

The TypeAheadParameters type exposes the following members.

Constructors

	Name	Description
	TypeAheadParameters	Initializes a new instance of the TypeAheadParameters class

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	CustomSources	If LookupMethod is CustomSource or SearchLogAndCustomSource, specifies the custom data sources to use for generating typeahead suggestions.
	DateFrom	Obsolete. Optionally limits the range of search statistics processed to a date interval starting from a specified date. May be used with or without simultaneously specifying DateTo.
	DateTo	Obsolete. Optionally limits the range of search statistics processed to a date interval before the specified date. May be used with or without simultaneously specifying DateFrom.
	ExtensionData
	LookupMethod	Optionally specifies a lookup method for the type ahead operation. If left unspecified, the default lookup method is TypeAheadLookupMethod.SearchLog.
	MaxAdditionalWordsInSuggestions	Optionally limits the range of suggestions to distinct search phrases that contains < MaxAdditionalWordsInSuggestions additional words, compared to the partial word submitted from the search user. The default value is undefined, i.e. suggestions may contain any number of additional words.
	MaxSuggestions	The maximum number of suggestions to retrieve. The number of suggestions returned may be lower than the maximum number specified.
	MinAverageNumberOfResults	Optionally limits the range of suggestions to distinct search phrases that have on averaged returned >= MinAverageNumberOfResults search results. The default value is 1.
	MinSearchCount	Optionally limits the range of suggestions to distinct search phrases that have been searched for >= MinSearchCount times. The default value is 1.
	SearchProfileId	The mandatory id of the search profile for which to obtain type ahead suggestions.
	SortMethod	The optional sort method to use. Type ahead suggestions are always primarily sorted based on the number of searches carried out for matching terms, however, SortMethod may be used to apply a subsequent sorting of the results returned.
	TypeAheadString	The partial search string being entered by the user.

Top