Collection Features APIFusion Admin APIs

Table of Contents

Features
Examples

The Collection Features API lets you observe the status of features across collections. To manipulate features for a specific collection, use the Collections API.

Features

There are four available features:

Property Description

Property	Description
signals	Create a parallel collection for the storage of signals data (such as user clicks, or ratings). Signals will need to be indexed and aggregated in order to be used. See the section on Signals for more information.
partitionByTime	Partition the corresponding Solr collection by time; see Time-Based Partitioning.
recommendations	Get configuration information about recommendations. Parameters (`params`) are: `idField`. The document field that contains the document ID. `itemsForUser`. Whether items-for-user recommendations are enabled (`true`) or disabled (`false`). `itemsForQuery`. Whether items-for-query recommendations are enabled (`true`) or disabled (`false`). `itemsForItem`. Whether items-for-query recommendations are enabled (`true`) or disabled (`false`). `queriesForQuery`. Whether queries-for-query recommendations are enabled (`true`) or disabled (`false`).

signals

Create a parallel collection for the storage of signals data (such as user clicks, or ratings). Signals will need to be indexed and aggregated in order to be used. See the section on Signals for more information.

partitionByTime

Partition the corresponding Solr collection by time; see Time-Based Partitioning.

recommendations

Get configuration information about recommendations. Parameters (params) are:

idField. The document field that contains the document ID.

itemsForUser. Whether items-for-user recommendations are enabled (true) or disabled (false).

itemsForQuery. Whether items-for-query recommendations are enabled (true) or disabled (false).

itemsForItem. Whether items-for-query recommendations are enabled (true) or disabled (false).

queriesForQuery. Whether queries-for-query recommendations are enabled (true) or disabled (false).

Examples

List the status of all features:

REQUEST

curl -u USERNAME:PASSWORD https://FUSION_HOST:FUSION_PORT/api/features/status

RESPONSE

 [ {
  "name" : "searchLogs",
  "collectionId" : "demo",
  "params" : { },
  "enabled" : false
}, {
  "name" : "signals",
  "collectionId" : "demo",
  "params" : { },
  "enabled" : false
} ]