Hyperspace Docs
Hyperspace Homepage
  • Getting started
    • Overview
      • Hyperspace Advantages
      • Hyperspace Search
    • Quick Start
  • flows
    • Setting Up
      • Installing the Hyperspace API Client
      • Connecting to the Hyperspace Server
      • Creating a Database Schema Configuration File
        • Vector Similarity Metrics
        • Index Type Methods
      • Creating a Collection
      • Uploading Data to a Collection
      • Building and Running Queries
        • Building a Lexical Search Query
        • Building a Vector Search Query
        • Building a Hybrid Search Query
      • Retrieving Results
    • Data Collections
      • Uploading Data
      • Accessing Data
      • Supported Data Types
    • Queries
      • DSL Query interface
        • Aggregations
        • Bool Query
        • Candidate Generation and Metadata Filtering
        • Scoring and Ranking
  • Reference
    • Hyperspace Query Flow
    • Features and Benefits
    • Search Processing Unit (SPU)
    • Hyperspace Document Prototype
  • API Documentation
    • Hyperspace Client
      • add_batch
      • add_document
      • async_req
      • clear_collection
      • collections_info
      • commit
      • create_collection
      • delete_collection
      • delete_by_query
      • dsl_search
      • get_schema
      • get_document
      • reset_password
      • search
      • update_by_query
      • update_document
    • DSL Query Framework
      • Aggregations
        • Cardinality Aggregation
        • Date Histogram
        • Metric Aggregations
        • Terms Aggregation
      • Bool Queries
        • Free Text Search
        • 'match' Clause
        • 'filter' Clause
        • 'must' Clause
        • 'must_not' Clause
        • 'should' Clause
        • 'should_not' Clause
      • Candidate Generation and Metadata Filtering
        • Geo Coordinates Match
        • Range Match
        • Term Match
      • Scoring and Ranking
        • Boost
        • 'dis_max'
        • Function Score
        • Rarity Score (TF-IDF)
  • Releases
    • 2024 Releases
Powered by GitBook
On this page
  • Boolean Queries
  • Candidate Generation and Metadata Filtering
  • Scoring and Ranking
  • Aggregations
  • Data Management
  • Coming Up
  1. API Documentation

DSL Query Framework

Previousupdate_documentNextAggregations

Last updated 10 months ago

Hyperspace supports the following commands in a DSL queries

Boolean Queries

  • '

Candidate Generation and Metadata Filtering

  • '

  • ''

Scoring and Ranking

Aggregations

    • sum - Returns the sum of the field over the relevant candidates

    • min - Returns the min of the field over the relevant candidates

    • max - Returns the max of the field over the relevant candidates

    • avg- Returns the average of the field over the relevant candidates

    • count - Returns the total number of valid field entries in the relevant candidates

    • percentiles - Returns the percentiles of the field over the relevant candidates.

Data Management

Coming Up

  • Script Score

  • Fuzzy Matching

''

''

''

Can't find the feature you are looking for?

'filter' clause
'must' clause
'must_not' clause
should' clause
'should_not' clause
'geo_distance '
range'
'term'
Free text search
Boost
dis_max
function_score
Rarity Score (TF-IDF)
cardinality
date_histogram
metric aggregations
terms
Update by script
Update by query
Contact us!