http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/6e02047e/templates/javaecommercerecommendation/quickstart/index.html
----------------------------------------------------------------------
diff --git a/templates/javaecommercerecommendation/quickstart/index.html
b/templates/javaecommercerecommendation/quickstart/index.html
index 2fc296f..bf52354 100644
--- a/templates/javaecommercerecommendation/quickstart/index.html
+++ b/templates/javaecommercerecommendation/quickstart/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html><head><title>Quick Start - E-Commerce Recommendation
Engine Template (Java)</title><meta charset="utf-8"/><meta
content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"/><meta name="viewport"
content="width=device-width, initial-scale=1.0"/><meta class="swiftype"
name="title" data-type="string" content="Quick Start - E-Commerce
Recommendation Engine Template (Java)"/><link rel="canonical"
href="https://predictionio.apache.org/templates/javaecommercerecommendation/quickstart/"/><link
href="/images/favicon/normal-b330020a.png" rel="shortcut icon"/><link
href="/images/favicon/apple-c0febcf2.png" rel="apple-touch-icon"/><link
href="//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800"
rel="stylesheet"/><link
href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
rel="stylesheet"/><link href="/stylesheets/application-eccfc6cb.css"
rel="stylesheet" type="text/css"/><script src="//cdnjs.c
loudflare.com/ajax/libs/html5shiv/3.7.2/html5shiv.min.js"></script><script
src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><script
src="//use.typekit.net/pqo0itb.js"></script><script>try{Typekit.load({ async:
true });}catch(e){}</script></head><body><div id="global"><header><div
class="container" id="header-wrapper"><div class="row"><div
class="col-sm-12"><div id="logo-wrapper"><span id="drawer-toggle"></span><a
href="#"></a><a href="http://predictionio.apache.org/";><img alt="Apache
PredictionIO" id="logo"
src="/images/logos/logo-ee2b9bb3.png"/></a><span>®</span></div><div
id="menu-wrapper"><div id="pill-wrapper"><a class="pill left"
href="/gallery/template-gallery">TEMPLATES</a> <a class="pill right"
href="//github.com/apache/predictionio/">OPEN SOURCE</a></div></div><img
class="mobile-search-bar-toggler hidden-md hidden-lg"
src="/images/icons/search-glass-704bd4ff.png"/></div></div></div></header><div
id="search-bar-row-wrapper"><div class=
"container-fluid" id="search-bar-row"><div class="row"><div class="col-md-9
col-sm-11 col-xs-11"><div class="hidden-md hidden-lg"
id="mobile-page-heading-wrapper"><p>PredictionIO Docs</p><h4>Quick Start -
E-Commerce Recommendation Engine Template (Java)</h4></div><h4 class="hidden-sm
hidden-xs">PredictionIO Docs</h4></div><div class="col-md-3 col-sm-1 col-xs-1
hidden-md hidden-lg"><img id="left-menu-indicator"
src="/images/icons/down-arrow-dfe9f7fe.png"/></div><div class="col-md-3
col-sm-12 col-xs-12 swiftype-wrapper"><div class="swiftype"><form
class="search-form"><img class="search-box-toggler hidden-xs hidden-sm"
src="/images/icons/search-glass-704bd4ff.png"/><div class="search-box"><img
src="/images/icons/search-glass-704bd4ff.png"/><input type="text"
id="st-search-input" class="st-search-input" placeholder="Search
Doc..."/></div><img class="swiftype-row-hider hidden-md hidden-lg"
src="/images/icons/drawer-toggle-active-fcbef12a.png"/></form></div></div><div
class="mobile-left-m
enu-toggler hidden-md hidden-lg"></div></div></div></div><div id="page"
class="container-fluid"><div class="row"><div id="left-menu-wrapper"
class="col-md-3"><nav id="nav-main"><ul><li class="level-1"><a
class="expandible" href="/"><span>Apache PredictionIO®
Documentation</span></a><ul><li class="level-2"><a class="final"
href="/"><span>Welcome to Apache PredictionIO®</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Getting
Started</span></a><ul><li class="level-2"><a class="final"
href="/start/"><span>A Quick Intro</span></a></li><li class="level-2"><a
class="final" href="/install/"><span>Installing Apache
PredictionIO</span></a></li><li class="level-2"><a class="final"
href="/start/download/"><span>Downloading an Engine Template</span></a></li><li
class="level-2"><a class="final" href="/start/deploy/"><span>Deploying Your
First Engine</span></a></li><li class="level-2"><a class="final"
href="/start/customize/"><span>Customizing the Engine</span><
/a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Integrating with Your App</span></a><ul><li class="level-2"><a
class="final" href="/appintegration/"><span>App Integration
Overview</span></a></li><li class="level-2"><a class="expandible"
href="/sdk/"><span>List of SDKs</span></a><ul><li class="level-3"><a
class="final" href="/sdk/java/"><span>Java & Android SDK</span></a></li><li
class="level-3"><a class="final" href="/sdk/php/"><span>PHP
SDK</span></a></li><li class="level-3"><a class="final"
href="/sdk/python/"><span>Python SDK</span></a></li><li class="level-3"><a
class="final" href="/sdk/ruby/"><span>Ruby SDK</span></a></li><li
class="level-3"><a class="final" href="/sdk/community/"><span>Community Powered
SDKs</span></a></li></ul></li></ul></li><li class="level-1"><a
class="expandible" href="#"><span>Deploying an Engine</span></a><ul><li
class="level-2"><a class="final" href="/deploy/"><span>Deploying as a Web
Service</span></a></li><li class="level-2"
><a class="final" href="/batchpredict/"><span>Batch
>Predictions</span></a></li><li class="level-2"><a class="final"
>href="/deploy/monitoring/"><span>Monitoring Engine</span></a></li><li
>class="level-2"><a class="final" href="/deploy/engineparams/"><span>Setting
>Engine Parameters</span></a></li><li class="level-2"><a class="final"
>href="/deploy/enginevariants/"><span>Deploying Multiple Engine
>Variants</span></a></li><li class="level-2"><a class="final"
>href="/deploy/plugin/"><span>Engine Server
>Plugin</span></a></li></ul></li><li class="level-1"><a class="expandible"
>href="#"><span>Customizing an Engine</span></a><ul><li class="level-2"><a
>class="final" href="/customize/"><span>Learning DASE</span></a></li><li
>class="level-2"><a class="final" href="/customize/dase/"><span>Implement
>DASE</span></a></li><li class="level-2"><a class="final"
>href="/customize/troubleshooting/"><span>Troubleshooting Engine
>Development</span></a></li><li class="level-2"><a class="final"
>href="/api/current/#
package"><span>Engine Scala APIs</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Collecting and Analyzing
Data</span></a><ul><li class="level-2"><a class="final"
href="/datacollection/"><span>Event Server Overview</span></a></li><li
class="level-2"><a class="final"
href="/datacollection/eventapi/"><span>Collecting Data with
REST/SDKs</span></a></li><li class="level-2"><a class="final"
href="/datacollection/eventmodel/"><span>Events Modeling</span></a></li><li
class="level-2"><a class="final"
href="/datacollection/webhooks/"><span>Unifying Multichannel Data with
Webhooks</span></a></li><li class="level-2"><a class="final"
href="/datacollection/channel/"><span>Channel</span></a></li><li
class="level-2"><a class="final"
href="/datacollection/batchimport/"><span>Importing Data in
Batch</span></a></li><li class="level-2"><a class="final"
href="/datacollection/analytics/"><span>Using Analytics
Tools</span></a></li><li class="level-2"><a class="final" href
="/datacollection/plugin/"><span>Event Server
Plugin</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Choosing an Algorithm</span></a><ul><li class="level-2"><a
class="final" href="/algorithm/"><span>Built-in Algorithm
Libraries</span></a></li><li class="level-2"><a class="final"
href="/algorithm/switch/"><span>Switching to Another
Algorithm</span></a></li><li class="level-2"><a class="final"
href="/algorithm/multiple/"><span>Combining Multiple
Algorithms</span></a></li><li class="level-2"><a class="final"
href="/algorithm/custom/"><span>Adding Your Own
Algorithms</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Tuning and Evaluation</span></a><ul><li class="level-2"><a
class="final" href="/evaluation/"><span>Overview</span></a></li><li
class="level-2"><a class="final"
href="/evaluation/paramtuning/"><span>Hyperparameter Tuning</span></a></li><li
class="level-2"><a class="final" href="/evaluation/evaluationdashboard/"
><span>Evaluation Dashboard</span></a></li><li class="level-2"><a
>class="final" href="/evaluation/metricchoose/"><span>Choosing Evaluation
>Metrics</span></a></li><li class="level-2"><a class="final"
>href="/evaluation/metricbuild/"><span>Building Evaluation
>Metrics</span></a></li></ul></li><li class="level-1"><a class="expandible"
>href="#"><span>System Architecture</span></a><ul><li class="level-2"><a
>class="final" href="/system/"><span>Architecture Overview</span></a></li><li
>class="level-2"><a class="final" href="/system/anotherdatastore/"><span>Using
>Another Data Store</span></a></li></ul></li><li class="level-1"><a
>class="expandible" href="#"><span>PredictionIO® Official
>Templates</span></a><ul><li class="level-2"><a class="final"
>href="/templates/"><span>Intro</span></a></li><li class="level-2"><a
>class="expandible" href="#"><span>Recommendation</span></a><ul><li
>class="level-3"><a class="final"
>href="/templates/recommendation/quickstart/"><span>Quick
>Start</span></a></li><li c
lass="level-3"><a class="final"
href="/templates/recommendation/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/recommendation/evaluation/"><span>Evaluation
Explained</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/recommendation/reading-custom-events/"><span>Read Custom
Events</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/customize-data-prep/"><span>Customize Data
Preparator</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/customize-serving/"><span>Customize
Serving</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/training-with-implicit-preference/"><span>Train
with Implicit Preference</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/blacklist-items/"><span>Filter Recommended It
ems by Blacklist in Query</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/batch-evaluator/"><span>Batch Persistable
Evaluator</span></a></li></ul></li><li class="level-2"><a class="expandible"
href="#"><span>E-Commerce Recommendation</span></a><ul><li class="level-3"><a
class="final" href="/templates/ecommercerecommendation/quickstart/"><span>Quick
Start</span></a></li><li class="level-3"><a class="final"
href="/templates/ecommercerecommendation/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/ecommercerecommendation/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/ecommercerecommendation/train-with-rate-event/"><span>Train
with Rate Event</span></a></li><li class="level-3"><a class="final"
href="/templates/ecommercerecommendation/adjust-score/"><span>Adjust
Score</span></a></li></ul></li><li class="level-2"><a class="expandible"
href="#"><span>Similar Product</span></
a><ul><li class="level-3"><a class="final"
href="/templates/similarproduct/quickstart/"><span>Quick
Start</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/similarproduct/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/similarproduct/multi-events-multi-algos/"><span>Multiple
Events and Multiple Algorithms</span></a></li><li class="level-3"><a
class="final"
href="/templates/similarproduct/return-item-properties/"><span>Returns Item
Properties</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/train-with-rate-event/"><span>Train with Rate
Event</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/rid-user-set-event/"><span>Get Rid of Events
for Users</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/recommended-user/"><span>Rec
ommend Users</span></a></li></ul></li><li class="level-2"><a
class="expandible" href="#"><span>Classification</span></a><ul><li
class="level-3"><a class="final"
href="/templates/classification/quickstart/"><span>Quick
Start</span></a></li><li class="level-3"><a class="final"
href="/templates/classification/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/classification/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/classification/add-algorithm/"><span>Use Alternative
Algorithm</span></a></li><li class="level-3"><a class="final"
href="/templates/classification/reading-custom-properties/"><span>Read Custom
Properties</span></a></li></ul></li></ul></li><li class="level-1"><a
class="expandible" href="#"><span>Engine Template Gallery</span></a><ul><li
class="level-2"><a class="final"
href="/gallery/template-gallery/"><span>Browse</span></a></li><li
class="level-2"><a class="final" href="/community/submit-te
mplate/"><span>Submit your Engine as a Template</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Demo
Tutorials</span></a><ul><li class="level-2"><a class="final"
href="/demo/tapster/"><span>Comics Recommendation Demo</span></a></li><li
class="level-2"><a class="final" href="/demo/community/"><span>Community
Contributed Demo</span></a></li><li class="level-2"><a class="final"
href="/demo/textclassification/"><span>Text Classification Engine
Tutorial</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="/community/"><span>Getting Involved</span></a><ul><li class="level-2"><a
class="final" href="/community/contribute-code/"><span>Contribute
Code</span></a></li><li class="level-2"><a class="final"
href="/community/contribute-documentation/"><span>Contribute
Documentation</span></a></li><li class="level-2"><a class="final"
href="/community/contribute-sdk/"><span>Contribute a SDK</span></a></li><li
class="level-2"><a class="final" href=
"/community/contribute-webhook/"><span>Contribute a Webhook</span></a></li><li
class="level-2"><a class="final" href="/community/projects/"><span>Community
Projects</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Getting Help</span></a><ul><li class="level-2"><a class="final"
href="/resources/faq/"><span>FAQs</span></a></li><li class="level-2"><a
class="final" href="/support/"><span>Support</span></a></li></ul></li><li
class="level-1"><a class="expandible"
href="#"><span>Resources</span></a><ul><li class="level-2"><a class="final"
href="/cli/"><span>Command-line Interface</span></a></li><li class="level-2"><a
class="final" href="/resources/release/"><span>Release
Cadence</span></a></li><li class="level-2"><a class="final"
href="/resources/intellij/"><span>Developing Engines with IntelliJ
IDEA</span></a></li><li class="level-2"><a class="final"
href="/resources/upgrade/"><span>Upgrade Instructions</span></a></li><li
class="level-2"><a class="final" h
ref="/resources/glossary/"><span>Glossary</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Apache Software
Foundation</span></a><ul><li class="level-2"><a class="final"
href="https://www.apache.org/";><span>Apache Homepage</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/licenses/";><span>License</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/foundation/sponsorship.html";><span>Sponsorship</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/foundation/thanks.html";><span>Thanks</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/security/";><span>Security</span></a></li></ul></li></ul></nav></div><div
class="col-md-9 col-sm-12"><div class="content-header hidden-md
hidden-lg"><div id="page-title"><h1>Quick Start - E-Commerce Recommendation
Engine Template (Java)</h1></div></div><div
id="table-of-content-wrapper"><h5>On this page</h5><
aside id="table-of-contents"><ul> <li> <a href="#overview">Overview</a> </li>
<li> <a href="#usage">Usage</a> </li> <li> <a
href="#1-install-and-run-predictionio">1. Install and Run PredictionIO</a>
</li> <li> <a href="#2-create-a-new-engine-from-an-engine-template">2. Create a
new Engine from an Engine Template</a> </li> <li> <a
href="#3-generate-an-app-id-and-access-key">3. Generate an App ID and Access
Key</a> </li> <li> <a href="#4-collecting-data">4. Collecting Data</a> </li>
<li> <a href="#5-deploy-the-engine-as-a-service">5. Deploy the Engine as a
Service</a> </li> <li> <a href="#6-use-the-engine">6. Use the Engine</a> </li>
<li> <a href="#setting-constraint-unavailableitems">Setting constraint
"unavailableItems"</a> </li> <li> <a href="#advanced-query">Advanced Query</a>
</li> </ul> </aside><hr/><a id="edit-page-link"
href="https://github.com/apache/predictionio/tree/livedoc/docs/manual/source/templates/javaecommercerecommendation/quickstart.html.md.erb";><img
src="/images/ic
ons/edit-pencil-d6c1bb3d.png"/>Edit this page</a></div><div
class="content-header hidden-sm hidden-xs"><div id="page-title"><h1>Quick Start
- E-Commerce Recommendation Engine Template (Java)</h1></div></div><div
class="content"> <h2 id='overview' class='header-anchors'>Overview</h2><p>This
engine template provides personalized recommendation for e-commerce
applications with the following features by default:</p> <ul> <li>Exclude
out-of-stock items</li> <li>Provide recommendation to new users who sign up
after the model is trained</li> <li>Recommend unseen items only
(configurable)</li> <li>Recommend popular items if no information about the
user is available</li> </ul> <div class="alert-message warning"><p>This
template requires PredictionIO version >= 0.9.3</p></div><h2 id='usage'
class='header-anchors'>Usage</h2><h3 id='event-data-requirements'
class='header-anchors'>Event Data Requirements</h3><p>By default, this template
takes the following data from Event Server:</p> <ul> <l
i>Users' <em>view</em> events</li> <li>Users' <em>buy</em> events</li>
<li>Items with <em>categories</em> properties</li> <li>Constraint
<em>unavailableItems</em> set events</li> </ul> <div class="alert-message
info"><p>This template can easily be customized to consider more user events
such as <em>rate</em> and <em>like</em>.</p></div><p>The <em>view</em> events
are used as Training Data to train the model. The algorithm has a parameter
<em>unseenOnly</em>; when this parameter is set to true, the engine would
recommend unseen items only. You can specify a list of events which are
considered as <em>seen</em> events with the algorithm parameter
<em>seenItemEvents</em>. The default values are <em>view</em> and <em>buy</em>
events, which means that the engine by default recommends un-viewed and
un-bought items only. You can also define your own events which are considered
as <em>seen</em>.</p><p>The constraint <em>unavailableItems</em> set events are
used to exclude a list of u
navailable items (such as out of stock) for all users in real time.</p><h3
id='input-query' class='header-anchors'>Input Query</h3> <ul> <li>User entity
ID</li> <li>Number of items to be recommended</li> <li>List of whitelisted item
categories (optional)</li> <li>List of whitelisted item entity IDs
(optional)</li> <li>List of blacklisted item entity IDs (optional)</li> </ul>
<p>This template also supports blacklist and whitelist. If a whitelist is
provided, the engine will include only those products in the recommendation.
Likewise, if a blacklist is provided, the engine will exclude those products in
the recommendation.</p><h3 id='output-predictedresult'
class='header-anchors'>Output PredictedResult</h3> <ul> <li>A ranked list of
recommended item entity IDs</li> </ul> <h2 id='1.-install-and-run-predictionio'
class='header-anchors'>1. Install and Run PredictionIO</h2> <p>First you need
to <a href="/install">install PredictionIO 0.12.1</a> (if you haven't done
it).</p><p>Let'
s say you have installed PredictionIO at
<code>/home/yourname/PredictionIO/</code>. For convenience, add
PredictionIO's binary command path to your <code>PATH</code>, i.e.
<code>/home/yourname/PredictionIO/bin</code>:</p><div class="highlight
shell"><table style="border-spacing: 0"><tbody><tr><td class="gutter gl"
style="text-align: right"><pre class="lineno">1</pre></td><td
class="code"><pre><span class="gp">$ </span><span class="nv">PATH</span><span
class="o">=</span><span
class="nv">$PATH</span>:/home/yourname/PredictionIO/bin; <span
class="nb">export </span>PATH
+<!DOCTYPE html><html><head><title>Quick Start - E-Commerce Recommendation
Engine Template (Java)</title><meta charset="utf-8"/><meta
content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"/><meta name="viewport"
content="width=device-width, initial-scale=1.0"/><meta class="swiftype"
name="title" data-type="string" content="Quick Start - E-Commerce
Recommendation Engine Template (Java)"/><link rel="canonical"
href="https://predictionio.apache.org/templates/javaecommercerecommendation/quickstart/"/><link
href="/images/favicon/normal-b330020a.png" rel="shortcut icon"/><link
href="/images/favicon/apple-c0febcf2.png" rel="apple-touch-icon"/><link
href="//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800"
rel="stylesheet"/><link
href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
rel="stylesheet"/><link href="/stylesheets/application-eccfc6cb.css"
rel="stylesheet" type="text/css"/><script src="//cdnjs.c
loudflare.com/ajax/libs/html5shiv/3.7.2/html5shiv.min.js"></script><script
src="//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><script
src="//use.typekit.net/pqo0itb.js"></script><script>try{Typekit.load({ async:
true });}catch(e){}</script></head><body><div id="global"><header><div
class="container" id="header-wrapper"><div class="row"><div
class="col-sm-12"><div id="logo-wrapper"><span id="drawer-toggle"></span><a
href="#"></a><a href="http://predictionio.apache.org/";><img alt="Apache
PredictionIO" id="logo"
src="/images/logos/logo-ee2b9bb3.png"/></a><span>®</span></div><div
id="menu-wrapper"><div id="pill-wrapper"><a class="pill left"
href="/gallery/template-gallery">TEMPLATES</a> <a class="pill right"
href="//github.com/apache/predictionio/">OPEN SOURCE</a></div></div><img
class="mobile-search-bar-toggler hidden-md hidden-lg"
src="/images/icons/search-glass-704bd4ff.png"/></div></div></div></header><div
id="search-bar-row-wrapper"><div class=
"container-fluid" id="search-bar-row"><div class="row"><div class="col-md-9
col-sm-11 col-xs-11"><div class="hidden-md hidden-lg"
id="mobile-page-heading-wrapper"><p>PredictionIO Docs</p><h4>Quick Start -
E-Commerce Recommendation Engine Template (Java)</h4></div><h4 class="hidden-sm
hidden-xs">PredictionIO Docs</h4></div><div class="col-md-3 col-sm-1 col-xs-1
hidden-md hidden-lg"><img id="left-menu-indicator"
src="/images/icons/down-arrow-dfe9f7fe.png"/></div><div class="col-md-3
col-sm-12 col-xs-12 swiftype-wrapper"><div class="swiftype"><form
class="search-form"><img class="search-box-toggler hidden-xs hidden-sm"
src="/images/icons/search-glass-704bd4ff.png"/><div class="search-box"><img
src="/images/icons/search-glass-704bd4ff.png"/><input type="text"
id="st-search-input" class="st-search-input" placeholder="Search
Doc..."/></div><img class="swiftype-row-hider hidden-md hidden-lg"
src="/images/icons/drawer-toggle-active-fcbef12a.png"/></form></div></div><div
class="mobile-left-m
enu-toggler hidden-md hidden-lg"></div></div></div></div><div id="page"
class="container-fluid"><div class="row"><div id="left-menu-wrapper"
class="col-md-3"><nav id="nav-main"><ul><li class="level-1"><a
class="expandible" href="/"><span>Apache PredictionIO®
Documentation</span></a><ul><li class="level-2"><a class="final"
href="/"><span>Welcome to Apache PredictionIO®</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Getting
Started</span></a><ul><li class="level-2"><a class="final"
href="/start/"><span>A Quick Intro</span></a></li><li class="level-2"><a
class="final" href="/install/"><span>Installing Apache
PredictionIO</span></a></li><li class="level-2"><a class="final"
href="/start/download/"><span>Downloading an Engine Template</span></a></li><li
class="level-2"><a class="final" href="/start/deploy/"><span>Deploying Your
First Engine</span></a></li><li class="level-2"><a class="final"
href="/start/customize/"><span>Customizing the Engine</span><
/a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Integrating with Your App</span></a><ul><li class="level-2"><a
class="final" href="/appintegration/"><span>App Integration
Overview</span></a></li><li class="level-2"><a class="expandible"
href="/sdk/"><span>List of SDKs</span></a><ul><li class="level-3"><a
class="final" href="/sdk/java/"><span>Java & Android SDK</span></a></li><li
class="level-3"><a class="final" href="/sdk/php/"><span>PHP
SDK</span></a></li><li class="level-3"><a class="final"
href="/sdk/python/"><span>Python SDK</span></a></li><li class="level-3"><a
class="final" href="/sdk/ruby/"><span>Ruby SDK</span></a></li><li
class="level-3"><a class="final" href="/sdk/community/"><span>Community Powered
SDKs</span></a></li></ul></li></ul></li><li class="level-1"><a
class="expandible" href="#"><span>Deploying an Engine</span></a><ul><li
class="level-2"><a class="final" href="/deploy/"><span>Deploying as a Web
Service</span></a></li><li class="level-2"
><a class="final" href="/batchpredict/"><span>Batch
>Predictions</span></a></li><li class="level-2"><a class="final"
>href="/deploy/monitoring/"><span>Monitoring Engine</span></a></li><li
>class="level-2"><a class="final" href="/deploy/engineparams/"><span>Setting
>Engine Parameters</span></a></li><li class="level-2"><a class="final"
>href="/deploy/enginevariants/"><span>Deploying Multiple Engine
>Variants</span></a></li><li class="level-2"><a class="final"
>href="/deploy/plugin/"><span>Engine Server
>Plugin</span></a></li></ul></li><li class="level-1"><a class="expandible"
>href="#"><span>Customizing an Engine</span></a><ul><li class="level-2"><a
>class="final" href="/customize/"><span>Learning DASE</span></a></li><li
>class="level-2"><a class="final" href="/customize/dase/"><span>Implement
>DASE</span></a></li><li class="level-2"><a class="final"
>href="/customize/troubleshooting/"><span>Troubleshooting Engine
>Development</span></a></li><li class="level-2"><a class="final"
>href="/api/current/#
package"><span>Engine Scala APIs</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Collecting and Analyzing
Data</span></a><ul><li class="level-2"><a class="final"
href="/datacollection/"><span>Event Server Overview</span></a></li><li
class="level-2"><a class="final"
href="/datacollection/eventapi/"><span>Collecting Data with
REST/SDKs</span></a></li><li class="level-2"><a class="final"
href="/datacollection/eventmodel/"><span>Events Modeling</span></a></li><li
class="level-2"><a class="final"
href="/datacollection/webhooks/"><span>Unifying Multichannel Data with
Webhooks</span></a></li><li class="level-2"><a class="final"
href="/datacollection/channel/"><span>Channel</span></a></li><li
class="level-2"><a class="final"
href="/datacollection/batchimport/"><span>Importing Data in
Batch</span></a></li><li class="level-2"><a class="final"
href="/datacollection/analytics/"><span>Using Analytics
Tools</span></a></li><li class="level-2"><a class="final" href
="/datacollection/plugin/"><span>Event Server
Plugin</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Choosing an Algorithm</span></a><ul><li class="level-2"><a
class="final" href="/algorithm/"><span>Built-in Algorithm
Libraries</span></a></li><li class="level-2"><a class="final"
href="/algorithm/switch/"><span>Switching to Another
Algorithm</span></a></li><li class="level-2"><a class="final"
href="/algorithm/multiple/"><span>Combining Multiple
Algorithms</span></a></li><li class="level-2"><a class="final"
href="/algorithm/custom/"><span>Adding Your Own
Algorithms</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Tuning and Evaluation</span></a><ul><li class="level-2"><a
class="final" href="/evaluation/"><span>Overview</span></a></li><li
class="level-2"><a class="final"
href="/evaluation/paramtuning/"><span>Hyperparameter Tuning</span></a></li><li
class="level-2"><a class="final" href="/evaluation/evaluationdashboard/"
><span>Evaluation Dashboard</span></a></li><li class="level-2"><a
>class="final" href="/evaluation/metricchoose/"><span>Choosing Evaluation
>Metrics</span></a></li><li class="level-2"><a class="final"
>href="/evaluation/metricbuild/"><span>Building Evaluation
>Metrics</span></a></li></ul></li><li class="level-1"><a class="expandible"
>href="#"><span>System Architecture</span></a><ul><li class="level-2"><a
>class="final" href="/system/"><span>Architecture Overview</span></a></li><li
>class="level-2"><a class="final" href="/system/anotherdatastore/"><span>Using
>Another Data Store</span></a></li></ul></li><li class="level-1"><a
>class="expandible" href="#"><span>PredictionIO® Official
>Templates</span></a><ul><li class="level-2"><a class="final"
>href="/templates/"><span>Intro</span></a></li><li class="level-2"><a
>class="expandible" href="#"><span>Recommendation</span></a><ul><li
>class="level-3"><a class="final"
>href="/templates/recommendation/quickstart/"><span>Quick
>Start</span></a></li><li c
lass="level-3"><a class="final"
href="/templates/recommendation/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/recommendation/evaluation/"><span>Evaluation
Explained</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/recommendation/reading-custom-events/"><span>Read Custom
Events</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/customize-data-prep/"><span>Customize Data
Preparator</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/customize-serving/"><span>Customize
Serving</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/training-with-implicit-preference/"><span>Train
with Implicit Preference</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/blacklist-items/"><span>Filter Recommended It
ems by Blacklist in Query</span></a></li><li class="level-3"><a class="final"
href="/templates/recommendation/batch-evaluator/"><span>Batch Persistable
Evaluator</span></a></li></ul></li><li class="level-2"><a class="expandible"
href="#"><span>E-Commerce Recommendation</span></a><ul><li class="level-3"><a
class="final" href="/templates/ecommercerecommendation/quickstart/"><span>Quick
Start</span></a></li><li class="level-3"><a class="final"
href="/templates/ecommercerecommendation/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/ecommercerecommendation/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/ecommercerecommendation/train-with-rate-event/"><span>Train
with Rate Event</span></a></li><li class="level-3"><a class="final"
href="/templates/ecommercerecommendation/adjust-score/"><span>Adjust
Score</span></a></li></ul></li><li class="level-2"><a class="expandible"
href="#"><span>Similar Product</span></
a><ul><li class="level-3"><a class="final"
href="/templates/similarproduct/quickstart/"><span>Quick
Start</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/similarproduct/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/similarproduct/multi-events-multi-algos/"><span>Multiple
Events and Multiple Algorithms</span></a></li><li class="level-3"><a
class="final"
href="/templates/similarproduct/return-item-properties/"><span>Returns Item
Properties</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/train-with-rate-event/"><span>Train with Rate
Event</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/rid-user-set-event/"><span>Get Rid of Events
for Users</span></a></li><li class="level-3"><a class="final"
href="/templates/similarproduct/recommended-user/"><span>Rec
ommend Users</span></a></li></ul></li><li class="level-2"><a
class="expandible" href="#"><span>Classification</span></a><ul><li
class="level-3"><a class="final"
href="/templates/classification/quickstart/"><span>Quick
Start</span></a></li><li class="level-3"><a class="final"
href="/templates/classification/dase/"><span>DASE</span></a></li><li
class="level-3"><a class="final"
href="/templates/classification/how-to/"><span>How-To</span></a></li><li
class="level-3"><a class="final"
href="/templates/classification/add-algorithm/"><span>Use Alternative
Algorithm</span></a></li><li class="level-3"><a class="final"
href="/templates/classification/reading-custom-properties/"><span>Read Custom
Properties</span></a></li></ul></li></ul></li><li class="level-1"><a
class="expandible" href="#"><span>Engine Template Gallery</span></a><ul><li
class="level-2"><a class="final"
href="/gallery/template-gallery/"><span>Browse</span></a></li><li
class="level-2"><a class="final" href="/community/submit-te
mplate/"><span>Submit your Engine as a Template</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Demo
Tutorials</span></a><ul><li class="level-2"><a class="final"
href="/demo/tapster/"><span>Comics Recommendation Demo</span></a></li><li
class="level-2"><a class="final" href="/demo/community/"><span>Community
Contributed Demo</span></a></li><li class="level-2"><a class="final"
href="/demo/textclassification/"><span>Text Classification Engine
Tutorial</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="/community/"><span>Getting Involved</span></a><ul><li class="level-2"><a
class="final" href="/community/contribute-code/"><span>Contribute
Code</span></a></li><li class="level-2"><a class="final"
href="/community/contribute-documentation/"><span>Contribute
Documentation</span></a></li><li class="level-2"><a class="final"
href="/community/contribute-sdk/"><span>Contribute a SDK</span></a></li><li
class="level-2"><a class="final" href=
"/community/contribute-webhook/"><span>Contribute a Webhook</span></a></li><li
class="level-2"><a class="final" href="/community/projects/"><span>Community
Projects</span></a></li></ul></li><li class="level-1"><a class="expandible"
href="#"><span>Getting Help</span></a><ul><li class="level-2"><a class="final"
href="/resources/faq/"><span>FAQs</span></a></li><li class="level-2"><a
class="final" href="/support/"><span>Support</span></a></li></ul></li><li
class="level-1"><a class="expandible"
href="#"><span>Resources</span></a><ul><li class="level-2"><a class="final"
href="/cli/"><span>Command-line Interface</span></a></li><li class="level-2"><a
class="final" href="/resources/release/"><span>Release
Cadence</span></a></li><li class="level-2"><a class="final"
href="/resources/intellij/"><span>Developing Engines with IntelliJ
IDEA</span></a></li><li class="level-2"><a class="final"
href="/resources/upgrade/"><span>Upgrade Instructions</span></a></li><li
class="level-2"><a class="final" h
ref="/resources/glossary/"><span>Glossary</span></a></li></ul></li><li
class="level-1"><a class="expandible" href="#"><span>Apache Software
Foundation</span></a><ul><li class="level-2"><a class="final"
href="https://www.apache.org/";><span>Apache Homepage</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/licenses/";><span>License</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/foundation/sponsorship.html";><span>Sponsorship</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/foundation/thanks.html";><span>Thanks</span></a></li><li
class="level-2"><a class="final"
href="https://www.apache.org/security/";><span>Security</span></a></li></ul></li></ul></nav></div><div
class="col-md-9 col-sm-12"><div class="content-header hidden-md
hidden-lg"><div id="page-title"><h1>Quick Start - E-Commerce Recommendation
Engine Template (Java)</h1></div></div><div
id="table-of-content-wrapper"><h5>On this page</h5><
aside id="table-of-contents"><ul> <li> <a href="#overview">Overview</a> </li>
<li> <a href="#usage">Usage</a> </li> <li> <a
href="#1-install-and-run-predictionio">1. Install and Run PredictionIO</a>
</li> <li> <a href="#2-create-a-new-engine-from-an-engine-template">2. Create a
new Engine from an Engine Template</a> </li> <li> <a
href="#3-generate-an-app-id-and-access-key">3. Generate an App ID and Access
Key</a> </li> <li> <a href="#4-collecting-data">4. Collecting Data</a> </li>
<li> <a href="#5-deploy-the-engine-as-a-service">5. Deploy the Engine as a
Service</a> </li> <li> <a href="#6-use-the-engine">6. Use the Engine</a> </li>
<li> <a href="#setting-constraint-unavailableitems">Setting constraint
"unavailableItems"</a> </li> <li> <a href="#advanced-query">Advanced Query</a>
</li> </ul> </aside><hr/><a id="edit-page-link"
href="https://github.com/apache/predictionio/tree/livedoc/docs/manual/source/templates/javaecommercerecommendation/quickstart.html.md.erb";><img
src="/images/ic
ons/edit-pencil-d6c1bb3d.png"/>Edit this page</a></div><div
class="content-header hidden-sm hidden-xs"><div id="page-title"><h1>Quick Start
- E-Commerce Recommendation Engine Template (Java)</h1></div></div><div
class="content"> <h2 id='overview' class='header-anchors'>Overview</h2><p>This
engine template provides personalized recommendation for e-commerce
applications with the following features by default:</p> <ul> <li>Exclude
out-of-stock items</li> <li>Provide recommendation to new users who sign up
after the model is trained</li> <li>Recommend unseen items only
(configurable)</li> <li>Recommend popular items if no information about the
user is available</li> </ul> <div class="alert-message warning"><p>This
template requires PredictionIO version >= 0.9.3</p></div><h2 id='usage'
class='header-anchors'>Usage</h2><h3 id='event-data-requirements'
class='header-anchors'>Event Data Requirements</h3><p>By default, this template
takes the following data from Event Server:</p> <ul> <l
i>Users' <em>view</em> events</li> <li>Users' <em>buy</em> events</li>
<li>Items with <em>categories</em> properties</li> <li>Constraint
<em>unavailableItems</em> set events</li> </ul> <div class="alert-message
info"><p>This template can easily be customized to consider more user events
such as <em>rate</em> and <em>like</em>.</p></div><p>The <em>view</em> events
are used as Training Data to train the model. The algorithm has a parameter
<em>unseenOnly</em>; when this parameter is set to true, the engine would
recommend unseen items only. You can specify a list of events which are
considered as <em>seen</em> events with the algorithm parameter
<em>seenItemEvents</em>. The default values are <em>view</em> and <em>buy</em>
events, which means that the engine by default recommends un-viewed and
un-bought items only. You can also define your own events which are considered
as <em>seen</em>.</p><p>The constraint <em>unavailableItems</em> set events are
used to exclude a list of u
navailable items (such as out of stock) for all users in real time.</p><h3
id='input-query' class='header-anchors'>Input Query</h3> <ul> <li>User entity
ID</li> <li>Number of items to be recommended</li> <li>List of whitelisted item
categories (optional)</li> <li>List of whitelisted item entity IDs
(optional)</li> <li>List of blacklisted item entity IDs (optional)</li> </ul>
<p>This template also supports blacklist and whitelist. If a whitelist is
provided, the engine will include only those products in the recommendation.
Likewise, if a blacklist is provided, the engine will exclude those products in
the recommendation.</p><h3 id='output-predictedresult'
class='header-anchors'>Output PredictedResult</h3> <ul> <li>A ranked list of
recommended item entity IDs</li> </ul> <h2 id='1.-install-and-run-predictionio'
class='header-anchors'>1. Install and Run PredictionIO</h2> <p>First you need
to <a href="/install">install PredictionIO 0.13.0</a> (if you haven't done
it).</p><p>Let'
s say you have installed PredictionIO at
<code>/home/yourname/PredictionIO/</code>. For convenience, add
PredictionIO's binary command path to your <code>PATH</code>, i.e.
<code>/home/yourname/PredictionIO/bin</code>:</p><div class="highlight
shell"><table style="border-spacing: 0"><tbody><tr><td class="gutter gl"
style="text-align: right"><pre class="lineno">1</pre></td><td
class="code"><pre><span class="gp">$ </span><span class="nv">PATH</span><span
class="o">=</span><span
class="nv">$PATH</span>:/home/yourname/PredictionIO/bin; <span
class="nb">export </span>PATH
</pre></td></tr></tbody></table> </div> <div class="alert-message note"><p>If
you launched <strong>PredictionIO AWS instance</strong>, the path is located at
<code>/opt/PredictionIO/bin</code>.</p></div><p>Once you have completed the
installation process, please make sure all the components (PredictionIO Event
Server, Elasticsearch, and HBase) are up and running.</p><div
class="alert-message note"><p>If you launched <strong>PredictionIO AWS
instance</strong>, you can skip <code>pio-start-all</code>. All components
should have been started automatically.</p></div><p>If you are using PostgreSQL
or MySQL, run the following to start PredictionIO Event Server:</p><div
class="highlight shell"><table style="border-spacing: 0"><tbody><tr><td
class="gutter gl" style="text-align: right"><pre class="lineno">1</pre></td><td
class="code"><pre><span class="gp">$ </span>pio eventserver &
</pre></td></tr></tbody></table> </div> <p>If instead you are running HBase
and Elasticsearch, run the following to start all PredictionIO Event Server,
HBase, and Elasticsearch:</p><div class="highlight shell"><table
style="border-spacing: 0"><tbody><tr><td class="gutter gl" style="text-align:
right"><pre class="lineno">1</pre></td><td class="code"><pre><span class="gp">$
</span>pio-start-all
</pre></td></tr></tbody></table> </div> <p>You can check the status by
running:</p><div class="highlight shell"><table style="border-spacing:
0"><tbody><tr><td class="gutter gl" style="text-align: right"><pre
class="lineno">1</pre></td><td class="code"><pre><span class="gp">$ </span>pio
status
@@ -32,7 +32,7 @@ Your system is all ready to go.
<span class="o">[</span>INFO] <span class="o">[</span>App<span
class="nv">$]</span> MyApp1 | 1 |
3mZWDzci2D5YsqAnqNnXH9SB6Rg3dsTBs8iHkK6X2i54IQsIZI1eEeQQyMfs7b3F | <span
class="o">(</span>all<span class="o">)</span>
<span class="o">[</span>INFO] <span class="o">[</span>App<span
class="nv">$]</span> MyApp2 | 2 |
io5lz6Eg4m3Xe4JZTBFE13GMAf1dhFl6ZteuJfrO84XpdOz9wRCrDU44EUaYuXq5 | <span
class="o">(</span>all<span class="o">)</span>
<span class="o">[</span>INFO] <span class="o">[</span>App<span
class="nv">$]</span> Finished listing 2 app<span class="o">(</span>s<span
class="o">)</span>.
-</pre></td></tr></tbody></table> </div> <p><a href="#"></a></p> <h2
id='4.-collecting-data' class='header-anchors'>4. Collecting Data</h2><p>Next,
let's collect training data for this Engine. By default, the E-Commerce
Recommendation Engine Template supports 2 types of entities and 2 events:
<strong>user</strong> and <strong>item</strong>; events <strong>view</strong>
and <strong>buy</strong>. An item has the <strong>categories</strong> property,
which is a list of category names (String). A user can view and buy an item.
The specical <strong>constraint</strong> entiy with entityId
<strong>unavailableItems</strong> defines a list of unavailable items and is
taken into account in realtime during serving.</p><p>In summary, this template
requires '$set' user event, '$set' item event, user-view-item
events, user-buy-item event and '$set' constraint event.</p><div
class="alert-message info"><p>This template can easily be customized to
consider other user-to-it
em events.</p></div> <p>You can send these events to PredictionIO Event Server
in real-time easily by making a HTTP request or through the provided SDK.
Please see <a href="/appintegration/">App Integration Overview</a> for more
details how to integrate your app with SDK.</p><p>Let's try sending events
to EventServer with the following <code>curl</code> commands (The corresponding
SDK code is showed in other tabs).</p><p>Replace
<code><ACCCESS_KEY></code> by the Access Key generated in above steps.
Note that <code>localhost:7070</code> is the default URL of the Event
Server.</p><p>For convenience, set your access key to the shell variable,
run:</p><p><code>$ ACCESS_KEY=<ACCESS_KEY></code></p> <p><a
href="#"></a></p> <p>For example, when a new user with id "u0" is
created in your app on time <code>2014-11-02T09:39:45.618-08:00</code> (current
time will be used if eventTime is not specified), you can send a
<code>$set</code> event for this user. To send this
event, run the following <code>curl</code> command:</p><div class="tabs"> <ul
class="control"> <li data-lang="json"><a
href="#tab-ba46f6db-f20a-4a3b-a9d3-63df0c4dc1a1">REST API</a></li> <li
data-lang="python"><a href="#tab-b3c7d9ed-ed04-4022-98e1-92cae0614243">Python
SDK</a></li> <li data-lang="php"><a
href="#tab-589f3a11-a9ac-4748-8dd1-e7dc6b4953a0">PHP SDK</a></li> <li
data-lang="ruby"><a href="#tab-31cbbd95-486f-4650-9334-23f70dd9792f">Ruby
SDK</a></li> <li data-lang="java"><a
href="#tab-96ae99bb-3dcf-4adb-8c3a-03f90d6516cd">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-ba46f6db-f20a-4a3b-a9d3-63df0c4dc1a1"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl"
style="text-align: right"><pre class="lineno">1
+</pre></td></tr></tbody></table> </div> <p><a href="#"></a></p> <h2
id='4.-collecting-data' class='header-anchors'>4. Collecting Data</h2><p>Next,
let's collect training data for this Engine. By default, the E-Commerce
Recommendation Engine Template supports 2 types of entities and 2 events:
<strong>user</strong> and <strong>item</strong>; events <strong>view</strong>
and <strong>buy</strong>. An item has the <strong>categories</strong> property,
which is a list of category names (String). A user can view and buy an item.
The specical <strong>constraint</strong> entiy with entityId
<strong>unavailableItems</strong> defines a list of unavailable items and is
taken into account in realtime during serving.</p><p>In summary, this template
requires '$set' user event, '$set' item event, user-view-item
events, user-buy-item event and '$set' constraint event.</p><div
class="alert-message info"><p>This template can easily be customized to
consider other user-to-it
em events.</p></div> <p>You can send these events to PredictionIO Event Server
in real-time easily by making a HTTP request or through the provided SDK.
Please see <a href="/appintegration/">App Integration Overview</a> for more
details how to integrate your app with SDK.</p><p>Let's try sending events
to EventServer with the following <code>curl</code> commands (The corresponding
SDK code is showed in other tabs).</p><p>Replace
<code><ACCCESS_KEY></code> by the Access Key generated in above steps.
Note that <code>localhost:7070</code> is the default URL of the Event
Server.</p><p>For convenience, set your access key to the shell variable,
run:</p><p><code>$ ACCESS_KEY=<ACCESS_KEY></code></p> <p><a
href="#"></a></p> <p>For example, when a new user with id "u0" is
created in your app on time <code>2014-11-02T09:39:45.618-08:00</code> (current
time will be used if eventTime is not specified), you can send a
<code>$set</code> event for this user. To send this
event, run the following <code>curl</code> command:</p><div class="tabs"> <ul
class="control"> <li data-lang="json"><a
href="#tab-9b8c531d-f1d4-4ee5-b6ee-accb4c80a156">REST API</a></li> <li
data-lang="python"><a href="#tab-2f76c73d-9421-48f4-85b6-bfe7e7945ac4">Python
SDK</a></li> <li data-lang="php"><a
href="#tab-81cc496b-0f36-464c-bd03-06db01e15a17">PHP SDK</a></li> <li
data-lang="ruby"><a href="#tab-7c747d89-17ba-4c33-8fa6-e22fc888e9ba">Ruby
SDK</a></li> <li data-lang="java"><a
href="#tab-6b6fe27e-4e9a-4dac-8225-c7aac830182e">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-9b8c531d-f1d4-4ee5-b6ee-accb4c80a156"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl"
style="text-align: right"><pre class="lineno">1
2
3
4
@@ -47,7 +47,7 @@ Your system is all ready to go.
"entityId" : "u0",
"eventTime" : "2014-11-02T09:39:45.618-08:00"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-b3c7d9ed-ed04-4022-98e1-92cae0614243"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-2f76c73d-9421-48f4-85b6-bfe7e7945ac4"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -78,7 +78,7 @@ Your system is all ready to go.
<span class="n">entity_type</span><span class="o">=</span><span
class="s">"user"</span><span class="p">,</span>
<span class="n">entity_id</span><span class="o">=<</span><span
class="n">USER_ID</span><span class="o">></span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-589f3a11-a9ac-4748-8dd1-e7dc6b4953a0"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-81cc496b-0f36-464c-bd03-06db01e15a17"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -119,7 +119,7 @@ Your system is all ready to go.
<span class="s1">'properties'</span> <span class="o">=></span> <span
class="k">array</span><span class="p">(</span><span
class="s1">'categories'</span> <span class="o">=></span> <span
class="k">array</span><span class="p">(</span><span
class="s1">'<CATEGORY_1>'</span><span class="p">,</span> <span
class="s1">'<CATEGORY_2>'</span><span class="p">))</span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-31cbbd95-486f-4650-9334-23f70dd9792f"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-7c747d89-17ba-4c33-8fa6-e22fc888e9ba"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -136,7 +136,7 @@ Your system is all ready to go.
<span class="s1">'user'</span><span class="p">,</span>
<span class="o"><</span><span class="no">USER</span> <span
class="no">ID</span><span class="o">></span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-96ae99bb-3dcf-4adb-8c3a-03f90d6516cd"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-6b6fe27e-4e9a-4dac-8225-c7aac830182e"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -161,7 +161,7 @@ Your system is all ready to go.
<span class="o">.</span><span class="na">entityType</span><span
class="o">(</span><span class="s">"user"</span><span class="o">)</span>
<span class="o">.</span><span class="na">entityId</span><span
class="o">(<</span><span class="n">USER_ID</span><span
class="o">>);</span>
<span class="n">client</span><span class="o">.</span><span
class="na">createEvent</span><span class="o">(</span><span
class="n">userEvent</span><span class="o">);</span>
-</pre></td> </tr></tbody></table> </div> </div> </div> <p>When a new item
"i0" is created in your app on time
<code>2014-11-02T09:39:45.618-08:00</code> (current time will be used if
eventTime is not specified), you can send a <code>$set</code> event for the
item. Note that the item is set with categories properties:
<code>"c1"</code> and <code>"c2"</code>. Run the following
<code>curl</code> command:</p><div class="tabs"> <ul class="control"> <li
data-lang="json"><a href="#tab-02940adb-1e90-4a13-97bc-2a85730cd51d">REST
API</a></li> <li data-lang="python"><a
href="#tab-e61c7424-19a0-4727-9237-2b124fe81805">Python SDK</a></li> <li
data-lang="php"><a href="#tab-451e5981-e00f-4dd8-a172-9d814159dec4">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-110a421f-0ad1-4dab-8676-09e8d29e3e47">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-663bb4a8-27e4-4be5-9170-801c459e002e">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json" id="tab-02940a
db-1e90-4a13-97bc-2a85730cd51d"> <div class="highlight shell"> <table
style="border-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-align:
right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> </div> <p>When a new item
"i0" is created in your app on time
<code>2014-11-02T09:39:45.618-08:00</code> (current time will be used if
eventTime is not specified), you can send a <code>$set</code> event for the
item. Note that the item is set with categories properties:
<code>"c1"</code> and <code>"c2"</code>. Run the following
<code>curl</code> command:</p><div class="tabs"> <ul class="control"> <li
data-lang="json"><a href="#tab-e55b8856-50aa-4b87-8b55-0abbf3ea8442">REST
API</a></li> <li data-lang="python"><a
href="#tab-76884aaf-b06a-4a1e-ba71-e1279354ed6f">Python SDK</a></li> <li
data-lang="php"><a href="#tab-2c1f9fc1-6e01-4eda-ada1-36177d168a92">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-5d8e10dc-b1f5-49a3-8aca-84afb68b9c98">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-64d7ba7a-6d80-4bdc-809e-2714d3e5d164">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json" id="tab-e55b88
56-50aa-4b87-8b55-0abbf3ea8442"> <div class="highlight shell"> <table
style="border-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-align:
right"><pre class="lineno">1
2
3
4
@@ -182,7 +182,7 @@ Your system is all ready to go.
}
"eventTime" : "2014-11-02T09:39:45.618-08:00"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-e61c7424-19a0-4727-9237-2b124fe81805"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-76884aaf-b06a-4a1e-ba71-e1279354ed6f"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -201,7 +201,7 @@ Your system is all ready to go.
<span class="s">"categories"</span> <span class="p">:</span> <span
class="p">[</span><span class="s">"<CATEGORY_1>"</span><span
class="p">,</span> <span class="s">"<CATEGORY_2>"</span><span
class="p">]</span>
<span class="p">}</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-451e5981-e00f-4dd8-a172-9d814159dec4"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-2c1f9fc1-6e01-4eda-ada1-36177d168a92"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -218,7 +218,7 @@ Your system is all ready to go.
<span class="s1">'properties'</span> <span class="o">=></span> <span
class="k">array</span><span class="p">(</span><span
class="s1">'categories'</span> <span class="o">=></span> <span
class="k">array</span><span class="p">(</span><span
class="s1">'<CATEGORY_1>'</span><span class="p">,</span> <span
class="s1">'<CATEGORY_2>'</span><span class="p">))</span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-110a421f-0ad1-4dab-8676-09e8d29e3e47"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-5d8e10dc-b1f5-49a3-8aca-84afb68b9c98"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -235,7 +235,7 @@ Your system is all ready to go.
<span class="p">}</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-663bb4a8-27e4-4be5-9170-801c459e002e"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-64d7ba7a-6d80-4bdc-809e-2714d3e5d164"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -248,7 +248,7 @@ Your system is all ready to go.
<span class="o">.</span><span class="na">entityId</span><span
class="o">(<</span><span class="n">ITEM_ID</span><span class="o">>)</span>
<span class="o">.</span><span class="na">property</span><span
class="o">(</span><span class="s">"categories"</span><span class="o">,</span>
<span class="n">ImmutableList</span><span class="o">.</span><span
class="na">of</span><span class="o">(</span><span
class="s">"<CATEGORY_1>"</span><span class="o">,</span> <span
class="s">"<CATEGORY_2>"</span><span class="o">));</span>
<span class="n">client</span><span class="o">.</span><span
class="na">createEvent</span><span class="o">(</span><span
class="n">itemEvent</span><span class="o">)</span>
-</pre></td> </tr></tbody></table> </div> </div> </div> <p>The properties of
the <code>user</code> and <code>item</code> can be set, unset, or delete by
special events <strong>$set</strong>, <strong>$unset</strong> and
<strong>$delete</strong>. Please refer to <a
href="/datacollection/eventapi/#note-about-properties">Event API</a> for more
details of using these events.</p><p>When the user "u0" view item
"i0" on time <code>2014-11-10T12:34:56.123-08:00</code> (current time
will be used if eventTime is not specified), you can send a view event. Run the
following <code>curl</code> command:</p><div class="tabs"> <ul class="control">
<li data-lang="json"><a href="#tab-e71c18a1-53b6-46c5-b085-d553e63e026a">REST
API</a></li> <li data-lang="python"><a
href="#tab-24880c9c-6421-4042-88bd-295f371761cc">Python SDK</a></li> <li
data-lang="php"><a href="#tab-e9d2e144-d65b-4f23-b13d-3f5df71937f6">PHP
SDK</a></li> <li data-lang="ruby"><a href="#tab-8796b71f-a625-4272-89fe-29dcd9
87e995">Ruby SDK</a></li> <li data-lang="java"><a
href="#tab-86a9331b-832b-4f52-bcc0-b21867b09b77">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-e71c18a1-53b6-46c5-b085-d553e63e026a"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl"
style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> </div> <p>The properties of
the <code>user</code> and <code>item</code> can be set, unset, or delete by
special events <strong>$set</strong>, <strong>$unset</strong> and
<strong>$delete</strong>. Please refer to <a
href="/datacollection/eventapi/#note-about-properties">Event API</a> for more
details of using these events.</p><p>When the user "u0" view item
"i0" on time <code>2014-11-10T12:34:56.123-08:00</code> (current time
will be used if eventTime is not specified), you can send a view event. Run the
following <code>curl</code> command:</p><div class="tabs"> <ul class="control">
<li data-lang="json"><a href="#tab-8e798e11-2fc4-4aea-b361-0c272425497f">REST
API</a></li> <li data-lang="python"><a
href="#tab-06cfd842-95e4-4f5b-8e56-d818806cfe81">Python SDK</a></li> <li
data-lang="php"><a href="#tab-7c654868-e2a4-41a0-8ba4-83b8ee396834">PHP
SDK</a></li> <li data-lang="ruby"><a href="#tab-a10da1ec-7cbf-4d8b-8426-43fab1
ab000b">Ruby SDK</a></li> <li data-lang="java"><a
href="#tab-89e67b80-d189-4e40-a469-0ef79a3ce420">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-8e798e11-2fc4-4aea-b361-0c272425497f"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl"
style="text-align: right"><pre class="lineno">1
2
3
4
@@ -267,7 +267,7 @@ Your system is all ready to go.
"targetEntityId" : "i0",
"eventTime" : "2014-11-10T12:34:56.123-08:00"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-24880c9c-6421-4042-88bd-295f371761cc"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-06cfd842-95e4-4f5b-8e56-d818806cfe81"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -284,7 +284,7 @@ Your system is all ready to go.
<span class="n">target_entity_type</span><span class="o">=</span><span
class="s">"item"</span><span class="p">,</span>
<span class="n">target_entity_id</span><span class="o">=<</span><span
class="n">ITEM</span> <span class="n">ID</span><span class="o">></span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-e9d2e144-d65b-4f23-b13d-3f5df71937f6"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-7c654868-e2a4-41a0-8ba4-83b8ee396834"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -303,7 +303,7 @@ Your system is all ready to go.
<span class="s1">'targetEntityId'</span> <span class="o">=></span> <span
class="o"><</span><span class="nx">ITEM</span> <span
class="nx">ID</span><span class="o">></span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-8796b71f-a625-4272-89fe-29dcd987e995"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-a10da1ec-7cbf-4d8b-8426-43fab1ab000b"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -322,7 +322,7 @@ Your system is all ready to go.
<span class="p">}</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-86a9331b-832b-4f52-bcc0-b21867b09b77"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-89e67b80-d189-4e40-a469-0ef79a3ce420"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -337,7 +337,7 @@ Your system is all ready to go.
<span class="o">.</span><span class="na">targetEntityType</span><span
class="o">(</span><span class="s">"item"</span><span class="o">)</span>
<span class="o">.</span><span class="na">targetEntityId</span><span
class="o">(<</span><span class="n">ITEM_ID</span><span
class="o">>);</span>
<span class="n">client</span><span class="o">.</span><span
class="na">createEvent</span><span class="o">(</span><span
class="n">viewEvent</span><span class="o">);</span>
-</pre></td> </tr></tbody></table> </div> </div> </div> <p>When the user
"u0" buy item "i0" on time
<code>2014-11-10T13:00:00.123-08:00</code> (current time will be used if
eventTime is not specified), you can send a view event. Run the following
<code>curl</code> command:</p><div class="tabs"> <ul class="control"> <li
data-lang="json"><a href="#tab-3895ea4f-c696-4d8f-bdc1-e2aacb24b01c">REST
API</a></li> <li data-lang="python"><a
href="#tab-d3bfa412-b8d0-49af-a7f8-d03940330da6">Python SDK</a></li> <li
data-lang="php"><a href="#tab-896af9b7-e3fa-4c8a-8f76-d5c76b864227">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-9cfc880f-c6ea-442b-b910-fd8751385566">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-c720a57d-123a-4df6-8a7d-ecff431a8389">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-3895ea4f-c696-4d8f-bdc1-e2aacb24b01c"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-
align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> </div> <p>When the user
"u0" buy item "i0" on time
<code>2014-11-10T13:00:00.123-08:00</code> (current time will be used if
eventTime is not specified), you can send a view event. Run the following
<code>curl</code> command:</p><div class="tabs"> <ul class="control"> <li
data-lang="json"><a href="#tab-c0b78339-23e8-46ac-a7ec-ce8a08bef21c">REST
API</a></li> <li data-lang="python"><a
href="#tab-2b3d1e23-587c-49ff-9b7b-2559142d3b3f">Python SDK</a></li> <li
data-lang="php"><a href="#tab-5ff5fd35-f248-41fa-ae3c-b56b6984e9b8">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-35bf8756-b577-4562-9cfd-b32e815b55f2">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-d712c992-80e1-4e27-9e54-809b8a2bab84">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-c0b78339-23e8-46ac-a7ec-ce8a08bef21c"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-
align: right"><pre class="lineno">1
2
3
4
@@ -356,7 +356,7 @@ Your system is all ready to go.
"targetEntityId" : "i0",
"eventTime" : "2014-11-10T13:00:00.123-08:00"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-d3bfa412-b8d0-49af-a7f8-d03940330da6"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-2b3d1e23-587c-49ff-9b7b-2559142d3b3f"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -373,7 +373,7 @@ Your system is all ready to go.
<span class="n">target_entity_type</span><span class="o">=</span><span
class="s">"item"</span><span class="p">,</span>
<span class="n">target_entity_id</span><span class="o">=<</span><span
class="n">ITEM</span> <span class="n">ID</span><span class="o">></span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-896af9b7-e3fa-4c8a-8f76-d5c76b864227"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-5ff5fd35-f248-41fa-ae3c-b56b6984e9b8"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -392,7 +392,7 @@ Your system is all ready to go.
<span class="s1">'targetEntityId'</span> <span class="o">=></span> <span
class="o"><</span><span class="nx">ITEM</span> <span
class="nx">ID</span><span class="o">></span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-9cfc880f-c6ea-442b-b910-fd8751385566"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-35bf8756-b577-4562-9cfd-b32e815b55f2"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -409,7 +409,7 @@ Your system is all ready to go.
<span class="s1">'targetEntityId'</span> <span class="o">=></span>
<span class="o"><</span><span class="no">ITEM</span> <span
class="no">ID</span><span class="o">></span>
<span class="p">}</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-c720a57d-123a-4df6-8a7d-ecff431a8389"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-d712c992-80e1-4e27-9e54-809b8a2bab84"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -490,19 +490,19 @@ User u10 buys item i40
</pre></td></tr></tbody></table> </div> <p>When the engine is deployed
successfully and running, you should see a console message similar to the
following:</p><div class="highlight shell"><table style="border-spacing:
0"><tbody><tr><td class="gutter gl" style="text-align: right"><pre
class="lineno">1
2</pre></td><td class="code"><pre><span class="o">[</span>INFO] <span
class="o">[</span>HttpListener] Bound to /0.0.0.0:8000
<span class="o">[</span>INFO] <span class="o">[</span>MasterActor] Bind
successful. Ready to serve.
-</pre></td></tr></tbody></table> </div> <p>Do not kill the deployed engine
process.</p><p>By default, the deployed engine binds to <a
href="http://localhost:8000";><a
href="http://localhost:8000";>http://localhost:8000</a></a>. You can visit that
page in your web browser to check its status.</p><p><img alt="Engine Status"
src="/images/engine-server-3246414b.png"/></p></p><h2 id='6.-use-the-engine'
class='header-anchors'>6. Use the Engine</h2><p>Now, You can retrieve predicted
results. To recommend 4 items to user ID "u1". You send this JSON
<code>{ "userEntityId": "u1", "number": 4
}</code> to the deployed engine and it will return a JSON of the recommended
items. Simply send a query by making a HTTP request or through the
<code>EngineClient</code> of an SDK.</p><p>With the deployed engine running,
open another terminal and run the following <code>curl</code> command or use
SDK to send the query:</p><div class="tabs"> <ul class="control"> <li da
ta-lang="json"><a href="#tab-ce729b6a-79cd-4a34-b6d4-a28b33818f5b">REST
API</a></li> <li data-lang="python"><a
href="#tab-89d53fd8-1f87-4698-85d3-7534d8e9d00e">Python SDK</a></li> <li
data-lang="php"><a href="#tab-2af7926b-3aa4-498c-9462-02f7697830a5">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-cd403631-5faf-4a61-952f-446582f67893">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-8935459c-9c5b-4d66-9438-357fd8f5dbcc">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-ce729b6a-79cd-4a34-b6d4-a28b33818f5b"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl"
style="text-align: right"><pre class="lineno">1
+</pre></td></tr></tbody></table> </div> <p>Do not kill the deployed engine
process.</p><p>By default, the deployed engine binds to <a
href="http://localhost:8000";><a
href="http://localhost:8000";>http://localhost:8000</a></a>. You can visit that
page in your web browser to check its status.</p><p><img alt="Engine Status"
src="/images/engine-server-3246414b.png"/></p></p><h2 id='6.-use-the-engine'
class='header-anchors'>6. Use the Engine</h2><p>Now, You can retrieve predicted
results. To recommend 4 items to user ID "u1". You send this JSON
<code>{ "userEntityId": "u1", "number": 4
}</code> to the deployed engine and it will return a JSON of the recommended
items. Simply send a query by making a HTTP request or through the
<code>EngineClient</code> of an SDK.</p><p>With the deployed engine running,
open another terminal and run the following <code>curl</code> command or use
SDK to send the query:</p><div class="tabs"> <ul class="control"> <li da
ta-lang="json"><a href="#tab-f885c29d-7fab-4517-bcad-0cb74397f1fd">REST
API</a></li> <li data-lang="python"><a
href="#tab-8444dc2c-2bb8-433f-876d-817d29583673">Python SDK</a></li> <li
data-lang="php"><a href="#tab-d51448ff-f2d4-49c5-a253-19a9926a0693">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-4c77ffa1-800f-4981-8e4c-c83cb8277373">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-93000ba7-5722-47cc-b085-cc44e8994c0d">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-f885c29d-7fab-4517-bcad-0cb74397f1fd"> <div class="highlight shell">
<table style="border-spacing: 0"><tbody><tr> <td class="gutter gl"
style="text-align: right"><pre class="lineno">1
2
3
4</pre></td> <td class="code"><pre><span class="gp">$ </span>curl -H <span
class="s2">"Content-Type: application/json"</span> <span class="se">\</span>
-d <span class="s1">'{ "userEntityId": "u1", "number": 4 }'</span> <span
class="se">\</span>
http://localhost:8000/queries.json
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-89d53fd8-1f87-4698-85d3-7534d8e9d00e"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-8444dc2c-2bb8-433f-876d-817d29583673"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3</pre></td> <td class="code"><pre><span class="kn">import</span> <span
class="nn">predictionio</span>
<span class="n">engine_client</span> <span class="o">=</span> <span
class="n">predictionio</span><span class="o">.</span><span
class="n">EngineClient</span><span class="p">(</span><span
class="n">url</span><span class="o">=</span><span
class="s">"http://localhost:8000";</span><span class="p">)</span>
<span class="k">print</span> <span class="n">engine_client</span><span
class="o">.</span><span class="n">send_query</span><span
class="p">({</span><span class="s">"userEntityId"</span><span
class="p">:</span> <span class="s">"u1"</span><span class="p">,</span> <span
class="s">"number"</span><span class="p">:</span> <span
class="mi">4</span><span class="p">})</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-2af7926b-3aa4-498c-9462-02f7697830a5"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-d51448ff-f2d4-49c5-a253-19a9926a0693"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -521,7 +521,7 @@ http://localhost:8000/queries.json
<span class="nb">print_r</span><span class="p">(</span><span
class="nv">$response</span><span class="p">);</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-cd403631-5faf-4a61-952f-446582f67893"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-4c77ffa1-800f-4981-8e4c-c83cb8277373"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -534,7 +534,7 @@ http://localhost:8000/queries.json
<span class="n">response</span> <span class="o">=</span> <span
class="n">client</span><span class="p">.</span><span
class="nf">send_query</span><span class="p">(</span><span
class="s1">'userEntityId'</span> <span class="o">=></span> <span
class="s1">'i1'</span><span class="p">,</span> <span class="s1">'number'</span>
<span class="o">=></span> <span class="mi">4</span><span class="p">)</span>
<span class="nb">puts</span> <span class="n">response</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-8935459c-9c5b-4d66-9438-357fd8f5dbcc"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-93000ba7-5722-47cc-b085-cc44e8994c0d"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -578,7 +578,7 @@ http://localhost:8000/queries.json
<span class="o">{</span><span class="s2">"itemEntityId"</span>:<span
class="s2">"i3"</span>,<span
class="s2">"score"</span>:0.003007015026561692<span class="o">}</span>
<span class="o">]</span>
<span class="o">}</span>
-</pre></td></tr></tbody></table> </div> <p><em>MyECommerceRecommendation</em>
is now running.</p> <div class="alert-message info"><p>To update the model
periodically with new data, simply set up a cron job to call <code>pio
train</code> and <code>pio deploy</code>. The engine will continue to serve
prediction results during the re-train process. After the training is
completed, <code>pio deploy</code> will automatically shutdown the existing
engine server and bring up a new process on the same port.</p></div><div
class="alert-message info"><p><strong>Note that if you import a <em>large</em>
data set</strong> and the training seems to be taking forever or getting stuck,
it's likely that there is not enough executor memory. It's recommended
to setup a Spark standalone cluster, you'll need to specify more driver and
executor memory when training with a large data set. Please see <a
href="/resources/faq/#engine-training">FAQ here</a> for instructions.</p></div>
<h2 id='setti
ng-constraint-"unavailableitems"' class='header-anchors'>Setting
constraint "unavailableItems"</h2><p>Now let's send an item
constraint "unavailableItems" (replace accessKey with your Access
Key):</p><div class="alert-message note"><p>You can also use SDK to send this
event as described in the SDK sample above.</p></div><div class="tabs"> <ul
class="control"> <li data-lang="json"><a
href="#tab-89a7f3aa-7331-4eea-9ecc-65c1f44ed7d9">REST API</a></li> <li
data-lang="python"><a href="#tab-1325308f-7124-4d76-a1e8-830f8379923b">Python
SDK</a></li> <li data-lang="php"><a
href="#tab-d8c7f49c-5d51-4865-a031-cfcd2738d7ee">PHP SDK</a></li> <li
data-lang="ruby"><a href="#tab-f4b71453-efa4-4e55-8eed-f086c095d733">Ruby
SDK</a></li> <li data-lang="java"><a
href="#tab-7819e73e-47d8-426e-8e8a-5e3f8351243e">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-89a7f3aa-7331-4eea-9ecc-65c1f44ed7d9"> <div class="highlight shell">
<table style="borde
r-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-align: right"><pre
class="lineno">1
+</pre></td></tr></tbody></table> </div> <p><em>MyECommerceRecommendation</em>
is now running.</p> <div class="alert-message info"><p>To update the model
periodically with new data, simply set up a cron job to call <code>pio
train</code> and <code>pio deploy</code>. The engine will continue to serve
prediction results during the re-train process. After the training is
completed, <code>pio deploy</code> will automatically shutdown the existing
engine server and bring up a new process on the same port.</p></div><div
class="alert-message info"><p><strong>Note that if you import a <em>large</em>
data set</strong> and the training seems to be taking forever or getting stuck,
it's likely that there is not enough executor memory. It's recommended
to setup a Spark standalone cluster, you'll need to specify more driver and
executor memory when training with a large data set. Please see <a
href="/resources/faq/#engine-training">FAQ here</a> for instructions.</p></div>
<h2 id='setti
ng-constraint-"unavailableitems"' class='header-anchors'>Setting
constraint "unavailableItems"</h2><p>Now let's send an item
constraint "unavailableItems" (replace accessKey with your Access
Key):</p><div class="alert-message note"><p>You can also use SDK to send this
event as described in the SDK sample above.</p></div><div class="tabs"> <ul
class="control"> <li data-lang="json"><a
href="#tab-40d72da8-d3c6-4558-a98d-f43c2a9c7038">REST API</a></li> <li
data-lang="python"><a href="#tab-4e8282e0-5d60-499f-bf74-b40e289134d9">Python
SDK</a></li> <li data-lang="php"><a
href="#tab-893fa5f4-46d3-4c95-9789-1191a704f66c">PHP SDK</a></li> <li
data-lang="ruby"><a href="#tab-cf29d3c3-800d-4deb-8f2d-4433cb1eeab9">Ruby
SDK</a></li> <li data-lang="java"><a
href="#tab-464f10a1-f29a-4f00-87ed-d95d2716179a">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-40d72da8-d3c6-4558-a98d-f43c2a9c7038"> <div class="highlight shell">
<table style="borde
r-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-align: right"><pre
class="lineno">1
2
3
4
@@ -599,7 +599,7 @@ http://localhost:8000/queries.json
}
"eventTime" : "2015-02-17T02:11:21.934Z"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-1325308f-7124-4d76-a1e8-830f8379923b"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-4e8282e0-5d60-499f-bf74-b40e289134d9"> <div
class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -618,7 +618,7 @@ http://localhost:8000/queries.json
<span class="s">"items"</span> <span class="p">:</span> <span
class="p">[</span><span class="s">"<ITEM ID1>"</span><span
class="p">,</span> <span class="s">"<ITEM ID2>"</span><span
class="p">]</span>
<span class="p">}</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-d8c7f49c-5d51-4865-a031-cfcd2738d7ee"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-893fa5f4-46d3-4c95-9789-1191a704f66c"> <div
class="highlight php"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -635,7 +635,7 @@ http://localhost:8000/queries.json
<span class="s1">'properties'</span> <span class="o">=></span> <span
class="k">array</span><span class="p">(</span><span class="s1">'items'</span>
<span class="o">=></span> <span class="k">array</span><span
class="p">(</span><span class="s1">'<ITEM ID1>'</span><span
class="p">,</span> <span class="s1">'<ITEM ID2>'</span><span
class="p">))</span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-f4b71453-efa4-4e55-8eed-f086c095d733"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK"
data-lang="ruby" id="tab-cf29d3c3-800d-4deb-8f2d-4433cb1eeab9"> <div
class="highlight ruby"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
@@ -650,7 +650,7 @@ http://localhost:8000/queries.json
<span class="s1">'properties'</span> <span class="o">=></span> <span
class="p">{</span> <span class="s1">'items'</span> <span class="o">=></span>
<span class="p">[</span><span class="s1">'<ITEM ID1>'</span><span
class="p">,</span> <span class="s1">'<ITEM ID2>'</span><span
class="p">]</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-7819e73e-47d8-426e-8e8a-5e3f8351243e"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK"
data-lang="java" id="tab-464f10a1-f29a-4f00-87ed-d95d2716179a"> <div
class="highlight java"> <table style="border-spacing: 0"><tbody><tr> <td
class="gutter gl" style="text-align: right"><pre class="lineno">1
2
3
4
