Sparque Desk Documentation

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.
- Changelog
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.
Changelog

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.
- Changelog
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.

Changelog

Here you can find a detailed changelog for the SPARQUE API Wrapper, outlining significant updates, bug fixes, and improvements for each version.

Releases

1.2.58

Ensure Consistent and Valid Token Information Being Returned in JWT

Fix #103366: Endpoint /api/auth: "expiresIn" and "expiresInSeconds" in the returned token are now consistent with the "expiresAt" timestamp.

Fix #105112: Endpoint /api/auth: The returned tokens are now ensured to be unexpired.

1.2.57

Accept Encoded '%' and '+' Characters in Path Parameter Values

Fix #104330: Incoming encoded '+' or '%' characters are now correctly embedded in the SPARQUE Desk requests.

1.2.56

Accept Encoded '%' and '+' Characters in Path Parameter Values

Partial fix #104330: The wrapper now accepts custom parameter values that include '+' or '%' characters.

1.2.55

Do Not Drop Filter When Fetching Fixed Facet Details on Product List Call

Fixed #103509: When calling the products endpoint of the Wrapper, the response may contain a list of facet groups with the number of products associated with each facet in the group. The number returned was incorrect for fixed facets if an additional filter was applied.

1.2.54

Remove Etags from Responses

Fixed #103583: Etags were not modified when the response of a given request changed, rendering them unusable. Therefore, they have been removed for now.

Fix Mapping of the Score Value for the Facet-Options Endpoint

Fixed #103506: The score value as returned by the facet-options endpoint is mapped incorrectly.
The score now correctly represents the number of results for the facet option.

1.2.53

Accept Encoded Whitespaces in Path Parameter Values

Fixed #104591: Wrapper drops URL parameter values with whitespaces.
Note that parameter names with whitespaces are still ignored, like &key%20Name=value.

1.2.52

Stale Cache Refresh Logical Fallacy Fix

Fixed a bug in the /search and /products endpoints to correctly check for cache expiration and trigger a background refresh if the cache is older than 30 minutes.

1.2.51

GZIP Response Compression

Enabled GZIP response compression.