Discovery Search Engine 4.2
  • Getting Started
    • Overview
      • What is it?
        • Features
        • What the engine is not
      • How do I use it?
        • Web Interface
        • Getting data into the engine
        • Defining the indexes
        • Performing Queries
      • International Support
        • Supported Languages
        • Case-insensitive Comparisons
        • Stemming
        • Time dimension format
        • Locale Exceptions
        • Distances and Location Searches
    • Engine and Data Tool Installation for UNIX Variants
      • Hardware Requirements
      • Software Requirements
      • Recommended Installation Directory Hierarchy
        • Archives Directory
        • Releases Directory
        • Engines Directory
      • Recommended Installation Example
        • Shell Script Configuration Variables
        • Discovery.properties File
        • Datatool.properties and discovery_datatool.xml Files
        • Developer Mode - Starting and Stopping
      • Create a user to run the Discovery Components
      • Extract the Release Archive
      • Configure and Start Engine
      • Starting the Discovery Engine and/or Discovery Data Tool At System Startup (init.d)
      • Startup with Multiple Engine or Data Tool Instances
      • Starting the Discovery Engine or Data Tool At System Startup (chkconfig)
      • Data Tool Log Files
      • Engine Log Files
      • Engine Settings File
  • Working with the Engine
    • Upgrading an Engine for UNIX Variants
      • General Upgrade Procedure
    • Admin Tool Interface
      • Status Page
      • Changesets Page
        • Import/Export
      • Dimensions Page
        • Import/Export
      • Indices Page
      • Feeds
        • Dimension, Changeset, Feed & Checkpoints Configuration
        • Dimensions
        • Changesets
        • Checkpoints
      • Settings
        • Import/Export Settings
        • Engine Preferences
      • Applications
        • JSON
    • Engine Configuration Scenarios
      • Single Engine
      • Data Distribution
        • Data Master Configuration
        • Data Slave Configuration
    • Monitoring Options
      • Admin Tool
      • Discovery Log File
      • System State Web Service
      • Munin plugin
  • Tutorial
    • Tutorial
      • Overview
      • Installation
      • Import Data
      • Define indexes
      • Performing Queries
        • Simple Searches
        • Faceted Search
      • Administration
        • Web-based Administration
      • Example files
        • changeset
        • dimensions
  • Data Integration
    • Integrating
      • Install dependencies and the engine
      • Create a changeset publisher
      • Create the dimension definition
      • Integrate queries into your application
      • Monitor the engine
    • Changesets
      • Getting changesets to the engine
        • Validating and pushing an initial changeset to the engine
        • Changeset document structure
    • Data Tool
      • Summary
      • Optional URL Parameters
      • Configuration
        • accessControl
        • DataSources
        • Profiles
        • Publishers
      • SSL
        • Create the RSA key, Certificate and Java Key Store
        • Configuration options in datatool.properties
      • How-To: Bringing it All Together
        • Design the Data Integration
        • Tracking deletes
        • A note about identifiers
        • Let’s write some SQL
        • Testing with the Discovery Data Tool and the Discovery Engine
        • Some things that we recommend testing
        • Logging
    • Changeset Publisher
      • Summary
      • De-normalized views
      • Changeset publisher
      • Configuring feeds
    • Custom Changeset Publisher
  • Dimensions
    • Overview
      • Importing a Dimension Definition to an Engine
      • Exporting a Dimension Definition to an Engine
    • Dimensions.xml
      • Dimensions Element
      • Dimension Element
      • Element Element
      • Field Element
    • Dimension Types
      • Ordered Type
        • Ordered Element XML Element
      • Tree Type
      • Mutex Type
      • Keyword Type
      • Integer Type (Scalar)
      • Double Type (Scalar)
      • Time Type (Scalar)
      • Geoloc Type
      • Text Type
      • Group By Type
    • Scalar Features
      • Min/Max Values
      • Ranges
    • Faceting
    • Example Dimension Definition XML
    • Defining Word Sets
      • Creating Merged Word Sets
        • Variant 1: Inline Word Set with Dimension
        • Variant 2: Word Set Reference with Dimension
        • Variant 3: Multiple Word Set References with Dimension
        • Variant 4: Word Sets Referring to Wordsets with Dimension
    • Defining Synonyms/Thesauruses
      • Creating Merged Synonym Dictionaries
        • Variant 1: Synonym Dictionary Reference with Dimension
        • Variant 2: Multiple Synonym Dictionary References with Dimension
        • Variant 3: Synonym Dictionaries Referring to Thesauruses with Dimension
  • Query API
    • Overview
      • JSON
    • Query Request
      • Top Level Request Fields
      • Search Criterion
        • integer, double, time
        • geoloc
        • builtin
        • text
        • Field Boosts
      • Nested Queries
      • Facets Criterion
      • Drilldown Criterion
      • Geographic Polygons
      • Highlighting Criterion
      • DidYouMean Criterion
      • Did You Mean? Highlighting Criterion
      • indexValues Criterion
      • Calculate Criterion
      • Values Criterion
      • Sort By Criterion
      • Group By Criterion
      • Debug Request
      • Render Parameters
    • Query Response
      • Top Level Response Fields
        • Response Example
      • facets Response
        • facets data Response
        • facets data bounds Response
      • drillDown
      • Properties
      • Highlighting
      • Index Values
      • Calculate
      • Values
      • sortBy Response
      • DidYouMean
      • Groups
      • Debug Response
      • renderParmeters
    • Examples
      • Querying geoloc dimensions
        • exactDistance
        • normalDistance
        • cullDistance
      • Querying mutex dimensions
      • Querying tree dimensions
      • Weight
      • Querying with drill down counts
      • Rendering parameters
  • Reference
    • Query Parameters Quick Reference
      • Top level
      • Criteria
      • DrillDown
      • SortBy
      • Highlighting
      • GroupBy
    • Dimension Type Attributes Quick Reference
      • Geoloc
      • keyword
      • tree, ordered, mutex
      • text
      • integer, long, double
      • time
      • groupBy
      • random
    • About Text Dimensions
      • Analysis
      • Tokenization
        • Word Delimiter Tokenizer (wordDelimiter)
        • Standard Tokenizer (standard)
        • Whitespace Tokenizer (whitespace)
        • Smart Chinese Tokenizer (smartcn)
      • Query Parsers
        • Starts With Queries
      • Accented Characters
      • Stop Words
        • Default Stop Word Lists for Supported Languages
      • Stemming
      • Phonetic Analysis
        • Soundex
        • Refined Soundex
        • Metaphone
        • Double Metaphone
      • Word Sets
      • Synonyms & Thesauruses
      • Did You Mean? and Spelling Correction
    • Web Services
      • Changesets
        • Listing Stored Changesets
        • Exporting a Stored Changeset
        • Apply/Store Changeset
      • Dimensions
        • Export the Dimensions Document
        • Post a new Dimensions Document
      • Item
        • Parameters
        • Example Request
        • Example Response
      • DidYouMean
        • Parameters
        • Example Request
        • Example Response
      • Items
        • Parameters (GET)
        • Example Request (GET)
        • Example Request (POST)
        • Example Response (POST and GET)
      • Statistics
        • Example Usage
        • Field details
      • Checkpoint
        • Example Usage
      • Queryable
        • Optional URL Parameters
        • Example Usage
      • System State
        • Example Response
    • discovery.properties Reference
      • Basic Configuration Options
        • port
        • jvm.memory
        • jvm.args
        • total-partitions
      • Advanced Configuration Options
        • max-paged-docs
        • max-groupby-topn
    • Discovery Script Command Line Options
      • start
      • stop
      • status
      • restart
      • kill
      • threads
    • Locale Specs
    • Interval Notation
    • Example Real Estate Dataset
      • Download
    • Changelog
      • 4.2 (May 24 2017)
        • Compatibility Changes
        • Improvements
        • Bug Fixes
      • 4.1 (October 11 2016)
        • Compatibility Changes
        • Improvements
        • Bug Fixes
      • 4.0 (December 16 2015)
        • Upgrading
        • Compatibility Changes
        • Improvements
      • 3.18 (December 16 2015)
        • Compatibility Changes
        • Improvements
      • 3.17 (August 28 2015)
        • Compatibility Changes
        • Bug fixes
        • Removed Features
      • 3.16 (May 8 2015)
        • Improvements
        • Compatibility Changes
        • Bug Fixes
      • 3.15 (August 27 2014)
        • Improvements
        • Bug Fixes
      • 3.14 (August 4 2014)
        • Improvements
        • Bug Fixes
        • Compatibility Changes
        • Removed features
      • 3.13 (June 12 2014)
        • Improvements
        • Bug Fixes
        • Compatibility Changes
        • Removed features
      • 3.12 (December 18 2013)
        • Improvements
        • Bug Fixes
        • Compatibility Changes
        • Removed features
      • 3.11 (September 3 2013)
        • Improvements
        • Documentation
        • Compatibility Changes
        • Removed features
      • 3.10 (March 11 2013)
        • Improvements
        • Compatibility
      • 3.9 (November 20 2012)
        • Improvements
      • 3.8.4 (September 25 2012)
        • ENGINE-808 Improves performance when using facet and groupBy features at the same time
      • 3.8.3.1 (May 8 2013)
        • Bug Fixes
      • 3.8.3 (September 5 2012)
        • Bug Fixes
      • 3.8.2 (August 10 2012)
        • Behavioral Changes
        • Bug Fixes
      • 3.8.1 (August 7 2012)
        • Bug Fixes
      • 3.8 (August 2 2012)
        • New Features
        • Improvements
      • 3.7.4 (June 29 2012)
        • New Features
        • Improvements
        • Behavioral Changes
        • Bug Fixes
      • 3.7.3 (June 19 2012)
        • Improvements
        • Bug Fixes
      • 3.7.2 (June 19 2012)
        • Improvements
      • 3.7.1 (June 7 2012)
        • Bug Fixes
      • 3.7.0 (June 6 2012)
        • New Features
        • Improvements
        • Behavioral Changes
        • Bug Fixes
      • 3.6.1 (March 12 2012)
      • 3.6.0 (February 15 2012)
        • Improvements
        • Behavioral Changes
        • Obsolete Features
      • 3.5.1 (Janurary 30 2012)
        • Improvements
        • Bug Fixes
      • 3.5.0 (Janurary 11 2012)
        • Improvements
        • Bug Fixes
      • 3.4.0 (December 16 2011)
        • Improvements
        • Bug Fixes
      • 3.3.0 (October 21 2011)
        • New Features
        • Improvements
        • Behavioral Changes
        • Obsolete Features
        • Bug Fixes
      • 3.2.0 (August 1 2011)
        • New Features
        • Improvements
        • Behavioral Changes
        • Bug Fixes
      • 3.1.0 (June 29 2011)
        • New Features
        • Improvements
        • Behavioral Changes
        • Bug Fixes
      • 3.0.0 (May 19 2011)
        • New Features
        • Improvements
      • 2.9.1 (May 2 2011)
        • New Features
        • Behavioral Changes
      • 2.9.0 (April 28 2011)
        • New Features
        • Behavioral Changes
        • Bug Fixes
      • 2.8.7 (February 11 2011)
        • Enhancements
        • Bug Fixes
      • 2.8.6 (February 2 2011)
        • New Features
        • Enhancements
        • Behavioral Changes
        • Bug Fixes
      • 2.8.5 (December 29 2010)
        • New Features
        • Enhancements
        • Behavioral Changes
        • Bug Fixes
      • 2.8.4 (November 29 2010)
        • New Features
        • Improvements
        • Bug Fixes
      • 2.8.3 (November 9 2010)
        • New Features
        • Improvements
        • Bug Fixes
      • 2.8.2 (September 14 2010)
        • New Features
        • Bug Fixes
      • 2.8.1 (September 1 2010)
        • New Features
        • Improvements
        • Deprecated Features
        • Bug Fixes
      • 2.7.1 (July 20 2010)
        • Improvements
      • 2.7.0 (July 1 2010)
        • Bug Fixes
        • Improvements
        • Improvements
        • New Features
 
Discovery Search Engine 4.2
  • Docs »
  • Query API

Query APIΒΆ

  • Overview
    • JSON
  • Query Request
    • Top Level Request Fields
    • Search Criterion
      • integer, double, time
      • geoloc
      • builtin
      • text
      • Field Boosts
    • Nested Queries
    • Facets Criterion
    • Drilldown Criterion
    • Geographic Polygons
    • Highlighting Criterion
    • DidYouMean Criterion
    • Did You Mean? Highlighting Criterion
    • indexValues Criterion
    • Calculate Criterion
    • Values Criterion
    • Sort By Criterion
    • Group By Criterion
    • Debug Request
    • Render Parameters
  • Query Response
    • Top Level Response Fields
      • Response Example
    • facets Response
      • facets data Response
      • facets data bounds Response
    • drillDown
    • Properties
    • Highlighting
    • Index Values
    • Calculate
    • Values
    • sortBy Response
    • DidYouMean
    • Groups
    • Debug Response
    • renderParmeters
  • Examples
    • Querying geoloc dimensions
      • exactDistance
      • normalDistance
      • cullDistance
    • Querying mutex dimensions
    • Querying tree dimensions
    • Weight
    • Querying with drill down counts
    • Rendering parameters
Next Previous

© Copyright Transparensee Systems.