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.
Changelog
Information on changes for each SPARQUE Desk version.
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.
Cookbook
Information on practical, recipe-based solutions for SPARQUE, including typical use cases and recommended approaches.
Project Tasks
Information that will help you perform SPARQUE project tasks.
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 Endpoints

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.
Changelog
Information on changes for each SPARQUE Desk version.
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.
Cookbook
Information on practical, recipe-based solutions for SPARQUE, including typical use cases and recommended approaches.
Project Tasks
Information that will help you perform SPARQUE project tasks.
Glossary
Discover important terms and concepts used throughout SPARQUE Desk.

Required SPARQUE Desk Endpoints

Note that any of the listed parameters are optional when defining the endpoints. If you do not require a specific parameter for the underlying strategy, there is no need to define the parameter in the API endpoint.

Non-Stacked Endpoints


Endpoint	Parameters	Output	Level	Wrapper Endpoint	Comments
attributes	sku (string)	OBJ	-	/product-attributes	Returns a list of property values of a product
brandsuggest	keyword (string) channel (string)	STRING	-	/suggestions	Returns a list of brand names for search suggestions Only required if Brand Suggestions are enabled via the corresponding SPARQUE Hub setting
categorysuggest	keyword (string) channel (string) locale (string)	OBJ	2	/health-check /suggestions	Returns a list of categories for search suggestions Level 2 to include parents if needed Only required if Category Suggestions are enabled and Search Personalization is disabled via the corresponding SPARQUE Hub settings when calling the /suggestions endpoint Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the response code is verified during this process.
categorytree	channel (string)	OBJ	2	/categorytree /health-check	Returns a list of categories with their parents. The Wrapper uses this to build the category tree. Level 2 to include parents if needed Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process.
contentsuggest	keyword (string)	OBJ	-	/suggestions	Returns a list of content elements for search suggestions Only required if Content Suggestions are enabled via the corresponding SPARQUE Hub setting.
fixedFacets	channel (string)	OBJ	-	/facet-options /health-check /products /search	Returns a list of fixed facet groups Only required if the SPARQUE Hub setting Fixed Facets is enabled when calling the /facet-options, /products and /search endpoints. Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process.
health_check	-	OBJ	-	/health-check	Customize this to fit your needs The result is not evaluated, only the HTTP status code and the response time are relevant for the health check.
keywordsuggest	keyword (string) channel (string) locale (string)	STRING	-	/suggestions /health-check	Returns a list of suggested search terms Only required if Keyword Suggestions are enabled and Search Personalization is disabled via the corresponding SPARQUE Hub settings when calling the /suggestions endpoint. Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process.
pdp	channel (string) sku (string)	OBJ	5	/product	Returns a product Level 5 to return more details
products	user (string) channel (string) cartId (tuple_list)	OBJ	-	/categorytree /health-check /products /suggestions	Returns a list of products Only required if Search Personalization is enabled via the corresponding SPARQUE Hub setting when calling the /categorytree endpoint. Only required if Keyword or Category Suggestions as well as Search Personalization are enabled via the corresponding SPARQUE Hub settings when calling the /suggestions endpoint. Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process.
productsuggest	keyword (string) channel (string) locale (string)	OBJ	-	/health-check /suggestions	Returns a list of products Only required if Product Suggestions are enabled via the corresponding SPARQUE Hub setting when calling the /suggestions endpoint Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process
recommendations	locale (string)	OBJ	-	/config	Returns a list of recommendation endpoints available in SPARQUE.AI
redirects	channel (string)	OBJ	-	/products /search	Returns a list of redirects
search	keyword (string) channel (string) cartId (tuple_list)	OBJ	-	/facet-options /health-check /search	Returns a list of products Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process
sortings	channel (string) locale (string)	OBJ, STRING	-	/config /health-check /products /search	Returns a list of sortings and their localized name Only required for the /health-check endpoint if the parameter `ShouldRunExtendedTest` is enabled. Only the HTTP response code is verified during this process
variation_attributes	sku (tuple_list)	OBJ,OBJ,OBJ	-	/product /products /search	Returns a list of triples, each consisting of the master product (by SKU), a related variant product, and the variant’s value for a specific variant attribute Only required for the /products and /search endpoints if the parameter `ReturnVariantAttributes` is enabled or not provided.

Stacked Endpoints

or OBJ,DOUBLE-

/products
/search

Takes a list of products and returns a list of brand names with the corresponding score
Only required if a fixed facet with the name {fixedFacetName} exists, see Defining Fixed Facets in a Lister or Search Result Page for details
Refer to Endpoint brand for more information on the output format


Endpoint	Input	Parameters	Output	Level	Wrapper Endpoint	Comments
boost	OBJ	-	OBJ	-	/facet-options /products /recommendations /search /suggestions	Requires a list of products as input and will return a list of products. Can be used to manipulate the product list or change the scoring of individual products. Only required if boosting is enabled via the corresponding SPARQUE Hub setting Only required if Product Suggestions are enabled via the corresponding SPARQUE Hub setting when calling the /suggestions endpoint
`{fixedFacetName}`; e.g.: brand	OBJ	user (string)	STRING,DOUBLE