Padre query processor options

Whether contextual navigation suggestions are grouped by type.

Set contextual navigation time-out to s seconds (s floating point). processing may be omitted entirely if elapsed time for a query already exceeds s seconds. (dflt 1.0).

Whether or not to activate the contextual navigation system.

String s lists the metadata fields, separated by commas surrounded by square brackets, to scan for contextual navigation suggestions. (dflt '[c,t]'). Note that scanning of document text can be suppressed by including a minus, for example '[-,c,t]'.

Maximum length (in words) of contextual navigation suggestions.

After this number of candidate phrases have been checked, contextual navigation processing will stop.

Maximum number of search results to scan for contextual navigation suggestions.

Maximum number of site clusters to present in contextual navigation.

Maximum number of topic clusters to present in contextual navigation.

Maximum number of type clusters to present in contextual navigation.

Calculate geospatial distance from origin and bounding box ranges when geospatial data is configured and available.

Exclude results not within <f> km of origin.

<lat,long> Set origin to lat, long (floating point degrees).

Write reordered queries to log. (dflt off)

Metadata fields to have their indexed terms counted in the result set (DAAT only). Unlike rmcf multiple term occurrences in a single document are counted e.g. if metadata 'author' has 'Bob Ada|Bob|Bob' in two documents the resulting counts would be 'Ada': 2, 'Bob': 6. As this counts indexed terms long terms may be truncated depending on the indexer options used. To count fields 'a' and 'c', set this to '[a,c]'.

Counts the number of unique metadata values grouped by another metadata. Syntax: -countUniqueByGroup=[classToCount]:[groupBy],[classToCount]:[groupBy]. Example: -countUniqueByGroup=[author]:[project] would show us the number of authors contributing to each project. classToCount is a regex and will be expanded to all matching metadata classes e.g. [author.*]:[project] might expand to -countUniqueByGroup=[author]:[project],[authors]:[project].

Report facet counts for dates such as 'today', 'last week', 'this year'. Note that date categories may overlap. Only value currently supported is 'd'.

Display counts of results grouped by the URL path (Up to depth i). If <I> is 0, then the default value is used. Dflt 5. If <I> is not present count urls is turned off.

Show the number documents each collection contributed to the result set.

Metadata fields to have their words counted in result sets (fields representing facets). If metadata 'author' has 'Bob Ada|Bob|Bob' in two documents the counts would be 'Bob Ada': 2 'Bob': 2. To count fields 'a' and 'c', set this to '[a,c]'.

Numerical and geospatial fields listed will have their ranges calculated in result sets. To see the ranges of field 'height' and the bounding box geospatial field 'X' set this to '[height,X]'.

Print elapsed times for each stage of query processing.

The sum of a numeric metadata in result set. Syntax: -sum=[sumOn],[sumOn]. Example: -sum=[size] would sum all values of numeric metadata 'size' in the result set. Note sumOn my be a regex which expands sumOn to all matching metadata classes e.g. -sum[size.*] might expanded to -sum=[sizeInKb],[sizeLoc].

The sum of a numeric metadata by a group. Syntax: -sumByGroup=[sumOn]:[groupBy],[sumOn]:[groupBy]. Example: -sumByGroup=[size]:[project] would sum all values of numeric metadata 'size' grouped by 'project' giving output project 'Foo' has size '128', project 'Bar' has size '12'. Note sumOn my be a regex which expands sumOn to all matching metadata classes e.g. -sumByGroup[size.*]:[project] might expanded to -sumByGroup=[sizeInKb]:[project],[sizeLoc]:[project].

What form of ip to include in log files: (nothing|ip|ip_hash|remote_user).

Write query log entries (dflt on).

If writing query log entries, write them to <FILE>.

A string identifying the current user to be used in padre’s query log.

s is either "all" or a comma-separated list of gscope bitnumbers for which counts are needed. (Bits numbered from zero.)

Fail when a component has an incompatible index relative to the first (rather than skip).

Use flock when locking the query logfile. If set to no, lockf is used instead. Default on Solaris is 'no', all other systems 'yes'.

Set matchset size to n million (dflt 24). Only need to increase on very large collections.

Don’t do tests on docs, e.g. phantom, zombie, *scope, binary, expired.

Don’t buffer the standard output stream. In some specific cases, setting this to 'no' can improve performance.

The collection view the perform the query against when in CGI mode. Normally 'live' (default), 'offline' or 'snapshot###'.

Specify presentation order of query biased summary excerpts. 0: natural order in doc. 1: sorted by score. (dflt 0)

Set buffer length per displayed metadata field to n bytes (dflt 250 bytes). Warning: setting very large values will increase query processor memory demands and may cause problems.

Set summary buffer length to n bytes. (dflt 250 bytes)

Metadata fields to include in summaries. (if applicable). To include fields author and d set this to [author,d]. This option also supports regex to include all metadata classes set this to [.*] to include fields prefixed with Fun and metadata class author set [Fun.*,author].

Select highlighting method within snippets in XML. 0 - No highlighting ; 1 - HTML strong tags ; 2 - Show highlighting regexp. and unhighlighted summary [dflt]; 5 - Use HTML strong tags but remove accents from summary before highlighting, provided query was not accented.

Summary mode. Possible values are 'both' (or 'def') - Display description or query-bias summary and metadata fields listed in the 'SF' option; 'snip' - display a generated snippet; 'meta' - display metadata fields listed in 'SF'.; 'qb' - display a query-biased summary; 'auto' - Print metadata codes if specified in user query.; 'off' - Turn off all summaries.

Set max no. of query biased summary excerpts to n (dflt 3).

Is text used for generating summaries required in the result

Treat group names and metadata items case sensitively (default no).

Controls behaviour of padre-sw when -ctest is used. 0: no internal evaluation; 1 - internal evaluation only. Output is brief plain text report of measures; 2 - internal evaluation only. Output in plain text with QBQ output followed by measures; 3 - internal evaluation plus normal CTOUT output in XML (with measures presented as comments)

Explain rankings by showing score components. (Note that -explain=on turns off result set diversification).

Show 'explore' links against results. The value specifies how many terms to include in the expanded query.

Specifies the bit number that results will be set to in -res gscope or -res docnums modes (dflt 1).

Are query terms only highlighted in MDSF metadata summaries

Limit number of results to n (min = 0, dflt = 10).

Limit number of result list tiers to n (min = 0 (no ,limit), max = 50, dflt no limit)

Set the value presented for query independent evidence when using the qiecfg result format. (dflt 0.5).

Determines which parts of a search result are highlighted. S - snippet, M - metadata, U - URL, T - title. E.g. -qwhl=MUT

Set result format. Possible values are: trec, web, xml, urls, qiez, qieo, gscope, docnums, ctest, qiecfg or flcfg. Note: setting res to docnums, flcfg, gscope, qiecfg, qieo or qiez will override any num_ranks setting so that all results are returned.

Include the specified number of pre-computed search results under the rmc count element for metadata facet categories.

Set maximum number of RMC items to display per field at n (dflt 100).

Treat facet categories (RMC items) case sensitively (default no).

Include an SVG representation of the query-as-processed in output.

Present results starting from n (dflt 1).

Treat group names case sensitively (default no).

Display tierbars in result list output (XML and HTML). When turned on (for all -res modes) and -sort is used, results will be first sorted by tier then by the sorting mode, otherwise if -sortall is used then all results will be sorted regardless of tier.

Metadata fields which are translucent. Translucent fields are visible on documents which the user can not see. To include fields 'a' and 'd' set this to '[a,d]'. If collapsing is enabled and the collapsing signature contains only fields defined here than collapsing will be permitted on documents the user can not see.

Use the stoplist specified in <file> (one word per line)

Determines whether or not binary documents are returned in the results. 0 - show all documents; 1 - show only binary documents; 2 - show only non-binary documents.

Dynamic metacollections. Specifies a component name within a .sdinfo file(s) to make active. Can be set multiple times to enable multiple collections.

Selects how DAAT early exit is determined. 0 - try for d results with every metafield and every component; 1 - try for d results over every component but not necessarily every metafield; 2 - stop a soon as d results are obtained. (d is the parameter to -daat.)

Impose a soft timeout (in seconds) on the time taken by the DAAT machinery for one query.

In DAAT mode don’t guess the number of full matches when the DAAT depth did not let us processes an entire postings list.

Must be set if event search is to be used

Present full matches only.

If a 2-character language code is specified by this means, then stemmers etc specific to that language will be used, IF AVAILABLE. It is also permissible to use a 5-character code like en_GB, but padre behaviour will be the same as for en. Specifying lang also makes title and metadata sorting of results locale-specific, however support for this on Windows platforms is limited and problematic.

Phrase looseness in words (min = 0, dflt = 0).

Terminate batch query processing after the specified number of queries have been processed.

Truncate queries after the specified number of terms. If the query is reordered, truncation will occur after reordering.

The text part of a query term with a right truncation operator must have at least this length. E.g. if min_truncated_len were 4 funnel* would be accepted but fun* would be processed as fun.

Exclude expired docs from results. (Nullified by -zom)

An empty query submitted via CGI will be processed as a null query. The system query must be empty as well. (dflt is to ignore the request).

Phrase or proximity terms with more than this number of words will be shortened by deleting words from the right. E.g. If this limit were 4 then to be or not to be would be processed as to be or not

Proximity limit in words (min = 0, dflt = 15).

When blending queries, determines sources of supplementary queries to be tried, with corresponding weights assigned to each source (ranging from 0 to 1). No spaces. 'off' may be specified to disable supplementary queries. E.g. -qsup=SPEL/0.9+USUK/0.4+SYNS/0.1+LANG/0.1. Available sources are: SPEL (spelling suggestions); USUK (table of spelling differences between US and UK English); SYNS (synonyms as defined by the blending.cfg file); LANG (experimental German decompunding)

Reorder terms in query so that the most discriminating (least common) appear first. Often coupled with -max_terms=

Remove any stopwords from the query. Possible values: 0 - remove none; 1 - remove dynamically depending on the query; 2 - remove all stopwords (dflt 1).

Either 'high' or 'low'. A convenience setting to increase or reduce allowable query complexity and timeouts according to service volumes — large or small indexes, high or low query volumes.

Controls stemming of queries. 0 - do not stem (dflt); 1 - do not stem (replaces obsolete option); 2 - Stem all query words (light - English/French plural/singular only); 3 - Stem all query words(heavier).

When stemming, stem only lowercase query words (to avoid stemming proper names and acronyms).

Normally, invalid UTF-8 characters are removed during indexing. If this hasn’t happened. This option allows them to be removed from result packets.

If set, the query processor will expand queries using thesaurus in synonyms.cfg.

Enables the use of the * operator, binary valued, it is only valid in use with an option that disables DAAT mode such as, -service_volume='lo' or -daat=0. When applied all contexts are available such as: :funnelback, funnel, back, and *:*elba.

If the postings list for a term is longer than the specified value (in MB) it will be treated as a wildcard.

Include docs in results even if noindex or killed.

Read a batch of queries from testfile (in C_TEST format). Sets output format to RM_CTEST, but that may be overridden. (See es.csiro.au/C-TEST/ for information about C-TEST.)

System-generated query inserted behind the scenes by a form or front-end.

Activate QuickLinks facility for default pages down to the specified level. 0 - off; 1 - server root pages; 2 - next level down.

If QuickLinks capability is active, show quick links for search results down to the specified rank.

If true, the value of QL_rank will be interpreted relative to the start_rank. E.g. if QL_rank=2, the first two results on each page may show QuickLinks.

Same site suppression penalty exponent (dflt 0.5, recommended range 0.2 - 0.7).

Number of additional documents from a site beyond the first that are allowed their full score before applying a same site suppression penalty (dflt 0)

Report content scores as % of max possible Okapi score (Intended for use with -vsimple=on).

Control the use of annotation indexes. 0 - do not use annotation indexes ; 1 - Process queries using annotation indexes only; 2 - Process queries using annotation indexes, falling back to normal indexes if insufficient results. (Most query op.s stripped.) 3 - Process queries using both annotation and normal indexes (Most operators stripped from queries.). Default 0.

Set Okapi b to f (dflt 0.75)

Documents matching this gscope expression (reverse Polish) can be upweighted with -cool.68. Those not matching can be upweighted with -cool.70.

Documents matching this gscope expression (reverse Polish) can be upweighted with -cool.69. Those not matching can be upweighted with -cool.71.

Whether to use topic distillation scoring (cool and cooler). Dflt on.

cool.N=V Set a value for the Nth tune parameter. See cooler ranking options page for possible values of N.

Specifies the maximum number of full matches for Document-At-A-Time processing. If set to 0, Term-At-A-Time is used instead (dflt 5000).

Diversification won’t alter ranking beyond rank n (default 200, min 10).

Present only results whose URL is prefixed by the given URL. Note that the scheme and hostname part are case insensitive, for URI with scheme smb:// the entire prefix is case insensitive. The behaviour of this option may change in the future to suit facets, this should not be used outside of faceted navigation.

Present only results whose gscope bits match reverse Polish expression e (Bits numbered from zero). If set to off, disable any previous expression.

Set Okapi K1 to <f>. (dflt 2.0)

Select special scoring function i for special fields. 0 = normal, 1 = AF1 (dflt 1).

Present only results whose URL matches a sort-of left-anchored pattern.

Whether to correct link scores across meta collection components (default yes).

Penalise score of the homepage of a single-entity-controlled domain to prevent over representation in results sets. E.g. www.anu.edu.au/ in an index of ANU. (dflt 0.90)

If same_meta_suppression is activated, the specified metadata field will be the field to which it applies. Only one metadata field can be treated in this way.

The query processor will penalise a result which is a near-duplicate of a previous result by multiplying by the factor specified. The penalty stiffens with more repetition. (dflt 0.5)

Insert the specified URLs at or near the top of the results list for a query. Value is a space separated list of URLs. URLs must correspond to those recorded by padre-iw. (dflt Inactive)

Set the number of possible score quantisation levels for each cool variable. In general, a high number should give more accurate ranking but may slow query processing.

Limit highest rank requestable to n (dflt 1,000,000,000).

Choose a profile of settings for the ranking function. 0 - current default; 1 - Standard BM25; 2 - Traditional (pre-12.0) Funnelback. Setting a profile does not override explicit settings.

<z,w,m,y,d,c,m> - Define how recency scores decay with time. z w, m, y, d, c, m are floats in the range 0 - 1, which specify the recency score assigned to documents, 0 days, 1 wk, 1 mth, 1 yr, 1 dec, 1 cen, 1 mill. old. (dflt 1.0,0.75,0.5,0.25,0.025,0.0025) Recency scores between key values linearly interpolated. Past the millennium, recency scores are 1/daysold.

If specified, recency is based on this date rather than that of most recent doc. Format is <yyyymmdd>, or 'today'.

Prevent the specified URLs from appearing in the results for a query. Value is a space separated list of URLs. URLs must correspond to those recorded by padre-iw. (dflt Inactive)

<n>[<classes>] Set doc scoring mode to n, using the classes specified. Most common values: 0 - score using doc text only ; 1 - no scoring. Produce an unordered set of results ; 2 - score using anchortext and URLs as well, upweight titles (or whatever fields are configured with -specf). For example to automatically look in fields 'u' and 'v' for the query terms set -sco=2[u,v]

Present only results whose URL satisfies the include/exclude scopes included in list (comma separated). e.g. -scope=anu.edu.au,-anu.edu.au/archives

Sort top results by <string>. Possible values: 'date', 'adate' (ascending date), 'title', 'dtitle' (descending title), 'size' (file size), 'dsize' (descending filesize), 'url', 'durl' (descending url), 'coll' (collection name, then score), 'dcoll' (descending collection name, then score), 'meta<f>' (by metadata field f, then score),'dmeta<f>' (descending metadata field d, then score), 'shuffle' (random to avoid bias), 'collapse_count' (to order by the number of collapsed documents, with the largest collapsed set first), 'acollapse_count' (with the largest collapsed set last), 'prox' (for geo search: Sort top results by proximity to origin), 'dprox' (for geo search: Sort top results by descending proximity to origin). 'score_ignoring_tiers' (descending score, ignoring any tiers. Only useful with sortall.) (dflt is case-insensitive for title and meta). '-sort=' turns off sorting.

Use case-sensitive sorting when sorting results by title or metadata strings.

Include partial matches in the resorting performed by -sort.

Fields listed in string s, as a list of comma separated fields surrounded by square brackets, will be scored specially and added to query when using the -sco=2 mode (dflt '[k,K]').

URLs matching the specified pattern (currently a simple string match) will not be subject to samesite suppression.

Control the extent to which static scores are attenuated with length of query. 0 => no attenuation; 1 => max attenuation. Attenuation by len ** -f.

A doc with unknown date is assumed to be d days old (for recency calcs) (dflt 366).

Use the tf.idf scheme proposed by Jiaul Paik at SIGIR 2013 rather than the more conventional BM25 variant.

When working with domain-importance features in ranking, use SECDs if value is on, and raw domain names otherwise.

Very simple ranking. If set to 'on', equivalent to -sco=0 -cool=off -SSS=0 -kmod=0.

Documents will not be retrieved in DAAT mode if they only match unfielded query terms in one or more of the implicit fields listed here. For example, specifying '[K,k]' will stop the query 'Monica Lewinski' matching a document solely because of click data or referring anchortext.

wmeta.C=F Set upweighting factors for metadata class scoring. C - metadata class; F - weight to set. (dflt 0.5 for 'k' and 'K', 1 for everything else).

Present only results whose URL exactly matches the provided URL (after canonicalization).

Same site suppression depth: 0 - no suppression (dflt); 2 - hosts and their top level dir’s; 10 - org domain (includes sub-domains) e.g. defence.gov.au.

Near dupulicates in ranking are multiplied by f. Setting f to 1 turns off near-dup detection.

Penalise a repetitious result by multiplying by the factor specified. (Repetitiousness may involve same-site, same component or repeated metadata.) The penalty stiffens with more repetition. Setting to 1 turns this off. (dflt 1.0)

While searching a meta-collection, penalise the second result from the same primary collection as a previous result by multiplying by the factor specified. The penalty stiffens with more repetition. Setting to 0 turns this off. (dflt 0)

Penalise the second result with the same value for a specified metafield as a previous result by multiplying by the factor specified. The penalty stiffens with more repetition. Setting to 0 turns this off. (dflt 0)

The query processor will penalise a result which has exactly the same title as a previous result by multiplying by the factor specified. The penalty stiffens with more repetition. Setting to 1 turns this off. (dflt 0.5)

Sort collapsed results by <string>. Possible values: 'date', 'adate' (ascending date), 'title', 'dtitle' (descending title), 'size' (file size), 'dsize' (descending filesize), 'url', 'durl' (descending url), 'coll' (collection name, then score), 'dcoll' (descending collection name, then score), 'meta<f>' (by metadata field f, then score),'dmeta<f>' (descending metadata field d, then score), 'shuffle' (random to avoid bias), 'prox' (for geo search: Sort collapsed results by proximity to origin), 'dprox' (for geo search: Sort collapsed results by descending proximity to origin). 'score_ignoring_tiers' (descending score, ignoring any tiers. Only useful with sortall.)

Activate collapsing. Collapsing will be based on document content ('$') unless a collapsing_sig value is specified. Note that use of this option will disable result set diversification.

Metadata fields to include in display for collapsed documents (assuming collapsing_num_ranks is non-zero). (dflt no fields). To view metadata fields 'id' and 'a' set this to '[id,a]'.

Label to indicate why items have been collapsed. (dflt "which are very similar")

Specify how many collapsed results are to be shown under the uncollapsed ones. (dflt 0)

Scope to only documents which have been collapsed on. Default is off.

The collapsing_control segment to use when collapsing. E.g. "[a,p]", collapse on author+publisher. The value must correspond to one segment of the indexing.collapse_fields string. (A segment is a comma separated list of fields surrounded by square brackets) (dflt '[$]' (Collapsing on document content.))

This allows testing of the padre side of the custom document level security mechanism. There is no call out to an external function. The value is interpreted as a combination of bits: 1 bit - dls_internal_test is active/not active; 2 bit - selects whether MINRESULTS mode is used or not. During internal testing, every odd numbered document in the original ranking is arbitrarily treated as inaccessible.

QUERY_LIMIT,WINDOW_SECONDS,UPPER_QUERY_LIMIT - Use an IP rejector to limit requests from a single machine. Allow QUERY_LIMIT queries per WINDOW_SECONDS, don’t record more than UPPER_QUERY_LIMIT queries.

Full path to security plugin library

Name of locking model, either "trim" or "sharepoint".

Disable DLS, available as a command line option.

Name of security plugin library

Enables translucent DLS DAAT only.

Conduct this search with security keys specified by s. The format is '<collectionName>;key<delim>' where delim is either ',' or new line, spaces are removed for example 'c1;k1 c2;k1,c2;k2'

Activate spelling suggestion mechanism.

Set the weighting between 'closeness to the query' and support in the collection for a candidate suggestion. Big alpha, high weight on closeness to the query. (dflt 0.7)

Confidence threshold for automatically blending results for a query suggestion with those from the user’s original query. (dflt 0.67)

Don’t make suggestions more than i characters longer or shorter than query. (dflt 2)

Confidence threshold for making a 'Did you mean' suggestion. (dflt 0.5)

Don’t make suggestions whose edit distance from the query exceeds f + query_length * spelling_edist_proportion. (dflt 1)

Don’t make suggestions whose edit distance from the query exceeds spelling_edist_constant + query_length * f (0⇐f⇐1). (dflt 0.25)

Don’t look for suggestions if there are at least f * log10(num docs) full matches. (dflt 30.0)

Don’t look for suggestions if there are at least f * log10(num docs) full matches. (dflt 30.0)

Include the non-corrected part of the query in the suggestion link. (dflt 1)

Suggestions not made for queries shorter than this. (dflt 2)

Sets a threshold that determines if a spelling suggestion is returned. If the generated spelling suggestion weight is less than this, the suggestion is not returned. (dflt 0.01)

For TREC participation: Each result in TREC format will include this runid.

For TREC participation: The first query in a batch will get this topic number. Each new query will increase the number by one.

For TREC participation: Each result in TREC format will use the TREC docno rather than a URL