IQuery Interface

This interface defines and executes a FAQ query. It exposes properties that affect execution and logging operations, and can duplicate query objects.

Methods

Clone

This method clones (copies) the current object, for reuse in another query.

Execute

This method executes a query object on the server. It returns a QueryResultSet object.

Properties

AbsThreshold (Get)

This property returns the absolute score threshold. Entries with an absolute score below this value are not considered. The absolute score of an entry can be between 0.0 to 1.0.

AbsThreshold (Put)

This property returns the absolute score threshold. Entries with an absolute score below this value are not considered. The absolute score of an entry can be between 0.0 to 1.0. The absolute scores of all entries is used to calculate the Grade.

AnswerWordWeight (Get)

This property returns the relative weight given to words in answer text compared to words in question text of the FAQ entries. Values must be in the range 0.0 to 1.0. The default = 0.7.

AnswerWordWeight (Put)

This property assigns the relative weight given to words in answer text compared to words in question text of the FAQ entries. Values must be in the range 0.0 to 1.0. The default = 0.7.

CacheResultEntries (Get)

This property determines whether entries selected by the query are cached on the client. When this property is True, all entries chosen by the query are cached to reduce server round trips.

CacheResultEntries (Put)

To reduce server round trips, by caching all entries chosen by the query, set this property True.

LogQuery (Get)

This property indicates whether a query is logged for reporting purposes. The default value is True, indicating that the query will be logged for reporting.

LogQuery (Put)

Set this property True to specify that the result of the query is logged for reporting purposes.

LogResultAsUsed (Get)

This property indicates whether e-FAQ automatically logs entries in the result-set as used, in order to avoid server round trip.

LogResultAsUsed (Put)

When this property is True, e-FAQ automatically logs entries in the result-set as used. This avoids server round trip.

MaxHits (Get)

The property returns the maximum number of answers in the result-set.

MaxHits (Put)

The property sets the maximum number of answers in the result-set. The default is 5.

MinGrade (Get)

This property returns the minimum grade threshold, which is a number between 1.0 and 10.0. The default value is 2.0.

MinGrade (Put)

This property assigns the minimum grade threshold, which is a number between 1.0 and 10.0. The default value is 2.0.

POSTagQuestion (Get)

When True, this property indicates that Part of Speech tagging is applied to the question text. This will slow down queries, but the result will be better.

POSTagQuestion (Put)

To apply Part of Speech tagging to the question text, set POSTagQuestion True. Enabling parts of speech tagging will slow down the query slightly, but will increase the match quality.

QueryFAQs (Get)

This property returns a collection of FAQs to be queried.

QueryFAQs (Put)

This property assigns a collection of FAQ names to be queried. Use this to copy the FAQs to be queried from one query object to another.

Question (Get)

This property contains the question text that will be asked.

Question (Put)

This property assigns the question text that will be processed.

RequestId (Get)

This property contains a string representing the custom request identifier to be logged into the remote query table for reporting purposes.

RequestId (Put)

This property assigns a string representing the custom request identifier to be logged into a remote query table for reporting purposes.

Server (Get)

This property returns a server object that the query will be run against.