Page Comparison

Data is passed in as a JSON object.

Valid object keys:

• item_id – ID of item used for recommendation (optional).
• external_id – External ID of item used for recommendation if item_id is not provided (optional)
• text – Text content used for recommendation if neither item_id nor external_id are not provided (optional)
• method – Recommendation method (optional).
  • These values are supported:
    • smartfilter: Use squirro Smart Filter method (default)
    • mlt: Use "More like this" of elasticsearch
    • tfidf: Use first 100 words of document to find similar documents based on tfidf score.
  method_params – Dictionary of method parameters used for recommendations (optional)
  • • .
• related_fields – Fields used to find relationship for between items for recommendation. If this parameter is not set we use the text in title, body and abstract  of item
• count – Maximum number of items to return.
• fields – Fields to return.
• options –

  Dictionary of options that influence the result-set. Valid options are:

  • fold_near_duplicates to fold near-duplicates together and filter them out of the result-stream. Defaults to False.

• created_before – Restrict result set to items created before created_before.
• created_after – Restrict result set to items created after created_after.
• query – Search query to restrict the recommendation set.
• aggregations – Aggregation of faceted fields

Results.

Response fields:

• items – List of items.
• now – Timestamp for the event of response generation.
• count – The number of items returned with this result set.
• total – Total number of items in recommendation result
• method –Method used for recommendation
• master_item –Original item used to get recommendation
• time_ms – Time of execution main component of recommendation in millisecond.