Overview
The Debug Search Tool provides a reference query form for basic testing and debugging of AIE application queries. This form returns output using the JSON REST API or the XML REST API.
Required Modules
The Debug Search page uses the Legacy HTTP REST API by default, but also supports the optional JSON-oriented rest module when it is included in createproject. Note that rest is part of the default module group, and is included in most projects automatically.
View incoming links.
Performing a Debug Search
To perform a debug search, select Query -> Debug Search in the AIE Administrator. The Debug Search screen appears.
Complete the form as required using the following fields:
Field | Description |
|---|---|
| Output Format | When the rest module is included in the project, an "Output Format" drop list appears at the top of the page. Options are JSON, JSONP, and Legacy-XML. |
Workflows | Specify the workflows to use for the search. The default is "search". |
Query | Specify the query. The default is "*:*" which means "all fields, all terms". This search returns every ingested and committed document. |
Query Language | |
Query Filter | Specify the filter terms that become part of the search. These terms are not used for calculating relevancy. |
| User Realm ID, Principal ID, Name | These are security credential properties as used by AIE's Content Security feature. |
Highlight | Enable/disable the highlighting of query terms in the results list. The default is off. |
Max Resubmits | Specify the maximum number of times to resubmit a query when zero results returne. The default is no re submission. For more information see, Query Resubmission. |
Locale | Specify the locale (language) of a query. Locale is represented by a 2-character ISO 639-1 language code. This is important because some aspects of the parsing of a query, such as tokenization and synonym expansion depend on the language. The default is English ("en"). |
Geo Search Field | Specifies the schema field containing the document position information to use for geographic search functionality. This field should be of type point. |
Latitude | The Latitude coordinate for the query position. |
Longitude | The Longitude coordinate for the query position. |
Units | The units of the Latitude/Longitudecoordinates. |
Geo Distance Filter | Maximum distance from the query position for which query results should return. |
Units | Distance units. |
Geo Polygon Filter | Defines the schema field that contains multiple point values which define a geographic polygon by which to filter results. |
Score Function | Defines scoring function to use in the relevancy calculation for results. |
Hits | Specify the number of results to return. The default is 10 results. |
Offset | Specify which part of the result set (hits) to return. The default is 0 which returns the first set of hits. To see hits 11-20, type 10 in this field. |
Relevancy Model | The configuration defined relevancy profile to apply when scoring the query. |
Sort | Specify the sort key to use for results. The default is blank which sorts the results by relevancy in descending order (that is, most relevant results first). |
Fields | Comma-delimited list of fields to return for the query. If left blank, all stored fields are returned. |
Facet | Specify one or more fields to render as facets. The default is no facets. |
Facet Finder | Select the facet finder mode. The default is OFF. Specify the number of facets to recommend in the Count field. For more information, see Using the FacetFinder for Facet Discovery. |
Stopwords | Set the stopword handling mode to off, remove or block. For more information, see the Configuring Languages in Attivio. |
Acronyms | Enable/disable acronym expansion. Specify the weight (boost) for matches on acronyms in the associated Boost input box. The default boost is 25 which reduces the relevancy value of acronym matches by three-fourths. Set the boost to 100 to give synonyms equal weight with the original search terms. For more information, see the Configuring Languages in Attivio. |
Synonyms | Enable/disable synonym expansion. Specify the weight (boost) for matches on synonyms in the associated Boost input box. The default boost is 25 which reduces the relevancy value of synonym matches by three-fourths. Set the boost to 100 to give synonyms equal weight with the original search terms. For more information, see the Configuring Languages in Attivio. |
Lemmatization | Enable/disable the expansion of word forms, also known as Lemmatization. Specify the weight (boost) for matches on expanded terms in the associated Boost input box. The default boost is 25 which reduces the value of lemma matches by three-fourths. Set the boost to 100 to give expanded terms equal weight with the original term. For more information, see the Configuring Languages in Attivio. |
Spellcheck Mode | Specify how to handle spelling suggestions. The default is OFF. Select AUTOCORRECT to automatically correct spelling errors when a query returns zero results. Select AUTOEXPAND to add multiple possible corrected spellings to the query. Select SUGGEST to only receive spelling corrections as messages, but not have them automatically replace misspelled terms. |
JOIN Rollup Mode | Specify how to render results using the JOIN operator. For more information, see Advanced Query Language. |
| ABC Enabled | When enabled, search queries are treated as UserQuery. |
| Business Center Search Profile | Enter the name of an Attivio Business Center search profile to test. The ABC Enabled checkbox must be selected. |
Debug | Enables/disable debug mode to see more information related to the query request/response. |
| Include Metadata in Response | Be sure this control is enabled (checked) when an Attivio support analyst asks for query-response information. |
Custom Properties | You can pass arbitrary properties along with query requests for use with custom components. |