com.primus.searchcommon.constants
Interface AdvancedQueryConstants
public interface AdvancedQueryConstants
|
Field Summary |
static java.lang.String |
ADVANCED
enables/disabled advanced query features, such as queryTerms |
static java.lang.String |
AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES
ATG Search includes a categorization module that applies rules to decide what categories of a taxonomy are
relevant to the content, or in this case user queries. |
static java.lang.String |
AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES_PRUNE
|
static java.lang.String |
ITEM_PROPERTY_CONTROL
ATG Search returns the meta-data properties associated with the index item of each statement result. |
static java.lang.String |
MAX_RELATED_SETS
ATG Search returns the retrieved documents along with the statement results. |
static java.lang.String |
PREFERRED_ANSWER_RESULT_TEXT
ATG Search can index special documents called preferred answers, which consist of a question, an answer, and a reference
document in the collection. |
static java.lang.String |
QUERY_ANALYSIS_MODE
ATG Search includes a query module that analyzes user queries and executes special actions which can modify the search behavior. |
static java.lang.String |
RELATED_QUERY_THRESH
ATG Search can load a report of prior queries and their frequencies into the indexed content. |
static java.lang.String |
RELATED_QUERY_TOP
ATG Search can load a report of prior queries and their frequencies into the indexed content. |
static java.lang.String |
RELATED_SET_CONTROL
ATG Search returns the retrieved documents along with the statement results. |
static java.lang.String |
RETURN_FEEDBACK
ATG Search returns feedback about related terms and phrases for the query. |
static java.lang.String |
SEARCH_CONTEXT_MODE
Normally, ATG Search treats each user query as a separate isolated request, with no pre-existing state or context. |
static java.lang.String |
STRATEGY
ATG Search has a large number of search parameters that control the generic search algorithm. |
static java.lang.String |
SUGGEST_QUERY_CATEGORIES
ATG Search includes a categorization module that applies rules to decide what categories of a taxonomy are relevant to the content,
or in this case user queries. |
ITEM_PROPERTY_CONTROL
static final java.lang.String ITEM_PROPERTY_CONTROL
- ATG Search returns the meta-data properties associated with the index item of each statement result. These returned properties
can be used for user interface functionality, such as customized result pages. By default, ATG Search returns all stored meta-data
properties, but the list of returned properties can be controlled by this attribute.
The value can be "all", which is the default, and simply indicates that all properties are returned.
The value can also be a comma-delimited list of the property names that can be returned.
The value can also be in the form of:
config;testprop|val,...,val|retprop,...;testprop|val,...,val|retprop,...;...
Basically, this syntax allows for conditional selection of returned properties, depending on another property of the index item.
The config; prefix denotes the new special syntax. The testprop is a name of a property that will be tested for one of the values
in the list that follow it. If an index item has one of the values for the testprop, then the list of retprop properties is used
to control what properties to return just for that index item. If not, the next testprop sequence is used, and so on until no
more configuration data is left. If testprop is empty, then the sequence is unconditional and all index items will satisfy it.
This is useful as the last item of the sequence to denote the default properties for any index item that does not satisfy the
specific property tests. If the val list is empty, then any value satisfies the test. If the retprop list is empty, then no
properties will be returned for index items satisfying the given test.
- See Also:
- Constant Field Values
STRATEGY
static final java.lang.String STRATEGY
- ATG Search has a large number of search parameters that control the generic search algorithm. To simplify the adjustment
of these settings, ATG Search provides 5 discrete search strategies that are implemented in terms of a set of parameter values.
The search strategy is selected by this attribute.
The value can be on of the following five values, which represent how restrictive the search should be:
- everything -- try unlimited search, without any parameter values that can restrict the search algorithm; also try all
term expansions during document candidate retrieval.
- expand -- try an expanded search, increasing the default parameter values that can restrict the search algorithm.
- normal -- default system settings, optimized for fast search with good search quality; this is the default value of the attribute.
- restrict -- try a restricted search, decreasing the default parameter values which will further restrict the search algorithm; disable
non-equal term expansions; adjust relevancy calculation to prefer literal matches.
- exact -- try an exact search, which is the same as restrict plus a heavy increase in the /exactWgt setting, which will force results
to contain the literal query string.
- See Also:
- Constant Field Values
RELATED_QUERY_TOP
static final java.lang.String RELATED_QUERY_TOP
- ATG Search can load a report of prior queries and their frequencies into the indexed content. During query processing, ATG
Search can retrieve the most related queries from this data, and return them as part of the query response. This functionality
is controlled by this attribute and RELATED_QUERY_THRESH.
The value specifies the maximum related queries to return in the response, where a value of 0 means that no related queries should be returned.
The default top value is 0.
- See Also:
- Constant Field Values
RELATED_QUERY_THRESH
static final java.lang.String RELATED_QUERY_THRESH
- ATG Search can load a report of prior queries and their frequencies into the indexed content. During query processing, ATG
Search can retrieve the most related queries from this data, and return them as part of the query response. This functionality
is controlled by this attribute and RELATED_QUERY_TOP.
The thresh value is the minimum relevancy threshold for related queries, ranging from 0 to 100. The default thresh value is 0.
- See Also:
- Constant Field Values
MAX_RELATED_SETS
static final java.lang.String MAX_RELATED_SETS
- ATG Search returns the retrieved documents along with the statement results. The retrieved documents contain associated information,
including the document sets (or categories) of the document. How many of these related sets and what kind of sets to return
are controlled by the MAX_RELATED_SETS and RELATED_SETS attributes.
The MAX_RELATED_SETS value specifies the maximum number of related sets to return per document. The default is 1000.
- See Also:
- Constant Field Values
RELATED_SET_CONTROL
static final java.lang.String RELATED_SET_CONTROL
- ATG Search returns the retrieved documents along with the statement results. The retrieved documents contain associated information,
including the document sets (or categories) of the document. How many of these related sets and what kind of sets to return
are controlled by the MAX_RELATED_SETS and RELATED_SETS attributes.
The RELATED_SETS value specifies a comma-delimited list of document sets, which form a constraint on the returned related sets to
return. Only related sets that are descendents of a member of this list are returned. The default is no value, which means there are
no constraints on the related sets.
- See Also:
- Constant Field Values
AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES
static final java.lang.String AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES
- ATG Search includes a categorization module that applies rules to decide what categories of a taxonomy are
relevant to the content, or in this case user queries. One use of this functionality is to automatically add
the most relevant categories as constraints on the query itself, thus narrowing the search to the more
appropriate content. These automatic constraints are controlled by the following attribute.
The value is the maximum number of categories to add as constraints. Multiple categories are added as a Boolean OR of document set constraints,
joined (i.e. AND-ed) to the pre-existing constraints. If the value is appended with a p, then the optional taxonomy pruning post-processing
algorithm is used during categorization.
- See Also:
- Constant Field Values
AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES_PRUNE
static final java.lang.String AUTOMATIC_CONSTRAIN_QUERY_CATEGORIES_PRUNE
- See Also:
- Constant Field Values
SUGGEST_QUERY_CATEGORIES
static final java.lang.String SUGGEST_QUERY_CATEGORIES
- ATG Search includes a categorization module that applies rules to decide what categories of a taxonomy are relevant to the content,
or in this case user queries. One use of this functionality is to provide feedback to the end-user about the most relevant categories
to the current query, allowing the end-user to manually refine (or narrow) the search. This categorization feedback is controlled
by the following attribute.
The value is the maximum number of categories to return in the feedback. If the max value is appended with a p, then the optional
taxonomy pruning post-processing algorithm is used during categorization.
- See Also:
- Constant Field Values
RETURN_FEEDBACK
static final java.lang.String RETURN_FEEDBACK
- ATG Search returns feedback about related terms and phrases for the query. This functionality is enabled by the following attribute.
The value must be either true or false, and defaults to false.
- See Also:
- Constant Field Values
QUERY_ANALYSIS_MODE
static final java.lang.String QUERY_ANALYSIS_MODE
- ATG Search includes a query module that analyzes user queries and executes special actions which can modify the search behavior.
This functionality is controlled by the following attribute.
The value must be one of the following:
- ignore -- no query analysis will be performed
- display -- perform the query analysis, but simply return feedback about the results in the response
- exec -- perform the query analysis and execute the actions, returning feedback about what was executed
The default value for this attribute is display, although only an index that contains query rules will return results.
- See Also:
- Constant Field Values
SEARCH_CONTEXT_MODE
static final java.lang.String SEARCH_CONTEXT_MODE
- Normally, ATG Search treats each user query as a separate isolated request, with no pre-existing state or context.
However, most search interactions by users are interrelated, and a search system might provide better results if
it provided this context. ATG Search captures several types of search context in its query request, and its use is
controlled by this attribute:
The value specifies how the context string in the priorInput element is interpreted, and can be one of the following values:
- normal -- the default value, no search context processing is done.
- subtractDoc -- using the context as a preliminary query, eliminate from the current search results any that are from index items
also returned by the context query.
- subtractAns -- using the context as a preliminary query, eliminate from the current search results any that are statements
also returned by the context query.
- penalizeDoc -- using the context as a preliminary query, penalize any current search results that are from index items
also returned by the context query. If the penalty exceeds the relevancy, the result is eliminated.
- penalizeAns -- using the context as a preliminary query, penalize any current search results that are statements
also returned by the context query. If the penalty exceeds the relevancy, the result is eliminated.
- withinDoc -- using the context as a preliminary query, restrict the current search results to index items
also returned by the context query.
- withinAns -- using the context as a preliminary query, restrict the current search results to statements
also returned by the context query
It should be clear that there are three types of modes, each with a pair of values representing statement versus index item logic.
The subtract modes represent the search scenario known as not like this, where the end-user does a search that returns relevant
and poor results, and then the user directs the system to find results not like the poor results. The penalize modes represent
the search scenario known as less like this, where the end-user does a search that returns relevant and poor results, and then
the user directs the system to find results less like the poor results, but not necessarily eliminating them. The within modes
represent the search scenario known as search within, where the end-user does a search that returns generally relevant results,
and then the user directs the system to find results of a new query within those initial results.
- See Also:
- Constant Field Values
PREFERRED_ANSWER_RESULT_TEXT
static final java.lang.String PREFERRED_ANSWER_RESULT_TEXT
- ATG Search can index special documents called preferred answers, which consist of a question, an answer, and a reference
document in the collection. These preferred answers are retrieved along with normal results, normally in a blended
result list. The following attribute controls which part of the preferred answer should be returned as the matching
statement text.
A value can either be answer or question, reflecting the two textual parts of the preferred answer. The default is answer.
- See Also:
- Constant Field Values
ADVANCED
static final java.lang.String ADVANCED
- enables/disabled advanced query features, such as queryTerms
- See Also:
- Constant Field Values