Getting Started
Information that will help you to get started with SPARQUE.
Datasets
Information on creating knowledge graphs from data sources, defining mappings with SPARQUE Language, and loading triples into Sparque's graph database.
Strategies
Information on managing strategies using the Strategy Editor, connecting and configuring building blocks, setting API outputs, adding parameters, and creating stacked strategies for complex search tasks.
APIs
Information on managing APIs in SPARQUE Desk to connect strategies to your application.
Evaluation
Information on assessing strategy performance in SPARQUE Desk using testsets and evaluations.
Users
Information on managing user permissions and roles.
Settings
Information on managing your account settings.
Query API
Information on using the Query API. Learn about endpoints, faceted search, response types, and request options.
Miscellaneous
Information on Tuple-notation, encoding, error messages and short-hand notation.
Shopware Extension
The SPARQUE Shopware extension allows you to seamlessly integrate our powerful tools into your Shopware store, providing advanced data analytics and insights.
SPARQUE API Wrapper
Information on the SPARQUE API Wrapper, which streamlines interactions between clients, internal users, and SPARQUE Desk.
SPARQUE Hub
Information on SPARQUE Hub, the front-end component designed to simplify the interactions of clients and internal users with SPARQUE Desk.
Glossary
Discover important terms and concepts used throughout SPARQUE Desk.

Home
SPARQUE API Wrapper
Information on the SPARQUE API Wrapper, which streamlines interactions between clients, internal users, and SPARQUE Desk.
Setup for Using the SPARQUE API Wrapper
Required SPARQUE Desk API Result Description

Getting Started
Information that will help you to get started with SPARQUE.
Datasets
Information on creating knowledge graphs from data sources, defining mappings with SPARQUE Language, and loading triples into Sparque's graph database.
Strategies
Information on managing strategies using the Strategy Editor, connecting and configuring building blocks, setting API outputs, adding parameters, and creating stacked strategies for complex search tasks.
APIs
Information on managing APIs in SPARQUE Desk to connect strategies to your application.
Evaluation
Information on assessing strategy performance in SPARQUE Desk using testsets and evaluations.
Users
Information on managing user permissions and roles.
Settings
Information on managing your account settings.
Query API
Information on using the Query API. Learn about endpoints, faceted search, response types, and request options.
Miscellaneous
Information on Tuple-notation, encoding, error messages and short-hand notation.
Shopware Extension
The SPARQUE Shopware extension allows you to seamlessly integrate our powerful tools into your Shopware store, providing advanced data analytics and insights.
SPARQUE API Wrapper
Information on the SPARQUE API Wrapper, which streamlines interactions between clients, internal users, and SPARQUE Desk.
SPARQUE Hub
Information on SPARQUE Hub, the front-end component designed to simplify the interactions of clients and internal users with SPARQUE Desk.
Glossary
Discover important terms and concepts used throughout SPARQUE Desk.

Required SPARQUE Desk API Result Description

SPARQUE allows you to customize the output format of your endpoints by using result descriptions, see Result Description for details.

However, the Wrapper requires certain information to be included in the responses. An OpenAPI specification of the expected data model is available here:

Array Aggregation

Since SPARQUE allows you to freely model your data, there may be multiple values for the same attribute. In such cases, SPARQUE Desk will respond with an array. However, the Wrapper is not designed to handle arrays. To avoid this situation, set aggr to MOST_FREQUENT.

{
  "class": "http://sparque.ai/SortingOption",
  "level": 1,
  "mode": "full",
  "attributes": [
    {
      "name": "identifier",
      "type": "STRING",
      "aggr": "most_frequent"      
      "splitLanguages": true
    },
    {
      "name": "title",
      "type": "STRING",
      "aggr": "most_frequent"
    }
  ],