http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/6e02047e/templates/leadscoring/quickstart/index.html
----------------------------------------------------------------------
diff --git a/templates/leadscoring/quickstart/index.html
b/templates/leadscoring/quickstart/index.html
index 5ae79bc..d01882a 100644
--- a/templates/leadscoring/quickstart/index.html
+++ b/templates/leadscoring/quickstart/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html><head><title>Quick Start - Lead Scoring Engine
Template</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 - Lead Scoring Engine
Template"/><link rel="canonical"
href="https://predictionio.apache.org/templates/leadscoring/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.cloudflare.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 - Lead
Scoring Engine Template</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-menu-toggler hidden-md
hidden-lg"></div></div></div></div><div id="page" clas
s="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>I
ntegrating 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></l
i><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="fin
al" 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 class="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
>Items 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/q
uickstart/"><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>Recommend
Users</span></a></li></ul></li><li class="level-2"><a class="expandib
le" 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-template/"><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"
href="/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 - Lead Scoring Engine
Template</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="#usa
ge">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>
</ul> </aside><hr/><a id="edit-page-link"
href="https://github.com/apache/predictionio/tree/livedoc/docs/manual/source/templates/leadscoring/quickstart.html.md.erb";><img
src="/images/icons/edit-pencil-d6c1bb3d.png"/>Edit this page</a></div><div
class="content-header hidden-sm hidden-xs"><div id="page-title"><h1>Quick Start
- Lead Scoring Engine Template</h1></div></div><div class="content"> <h2
id='overview' class='header-anchors'>Overview</h2><p>Th
is engine template predicts the probability of an user will convert
(conversion event by user) in the current session.</p><div class="alert-message
warning"><p>This template requires PredictionIO version >=
0.9.0</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, the template requires the following events to
be collected:</p> <ul> <li>'page view' events with session ID</li>
<li>the first page view event can optionally provide the browser and referrer
ID</li> <li>user 'buy' event with session ID</li> </ul> <p>The landing
page ID, referrer ID, browser information and user's buy event will be used
to train the model.</p><div class="alert-message note"><p>You can customize
what the "conversion" event is. It's "buy" item event
by default but it can be modified to others such as
"subscribe".</p></div><h3 id='input-query' class='h
eader-anchors'>Input Query</h3> <ul> <li>Landing page ID</li> <li>Referrer
ID</li> <li>Browser</li> </ul> <h3 id='output-predictedresult'
class='header-anchors'>Output PredictedResult</h3> <ul> <li>score</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 - Lead Scoring Engine
Template</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 - Lead Scoring Engine
Template"/><link rel="canonical"
href="https://predictionio.apache.org/templates/leadscoring/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.cloudflare.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 - Lead
Scoring Engine Template</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-menu-toggler hidden-md
hidden-lg"></div></div></div></div><div id="page" clas
s="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>I
ntegrating 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></l
i><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="fin
al" 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 class="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
>Items 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/q
uickstart/"><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>Recommend
Users</span></a></li></ul></li><li class="level-2"><a class="expandib
le" 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-template/"><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"
href="/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 - Lead Scoring Engine
Template</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="#usa
ge">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>
</ul> </aside><hr/><a id="edit-page-link"
href="https://github.com/apache/predictionio/tree/livedoc/docs/manual/source/templates/leadscoring/quickstart.html.md.erb";><img
src="/images/icons/edit-pencil-d6c1bb3d.png"/>Edit this page</a></div><div
class="content-header hidden-sm hidden-xs"><div id="page-title"><h1>Quick Start
- Lead Scoring Engine Template</h1></div></div><div class="content"> <h2
id='overview' class='header-anchors'>Overview</h2><p>Th
is engine template predicts the probability of an user will convert
(conversion event by user) in the current session.</p><div class="alert-message
warning"><p>This template requires PredictionIO version >=
0.9.0</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, the template requires the following events to
be collected:</p> <ul> <li>'page view' events with session ID</li>
<li>the first page view event can optionally provide the browser and referrer
ID</li> <li>user 'buy' event with session ID</li> </ul> <p>The landing
page ID, referrer ID, browser information and user's buy event will be used
to train the model.</p><div class="alert-message note"><p>You can customize
what the "conversion" event is. It's "buy" item event
by default but it can be modified to others such as
"subscribe".</p></div><h3 id='input-query' class='h
eader-anchors'>Input Query</h3> <ul> <li>Landing page ID</li> <li>Referrer
ID</li> <li>Browser</li> </ul> <h3 id='output-predictedresult'
class='header-anchors'>Output PredictedResult</h3> <ul> <li>score</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, Lead Scoring
Engine Template supports the following entities: <strong>user</strong>,
<strong>page</strong>, and <strong>item</strong>. An user views a page, and
buys an item.</p><p>Note that a "sessionId" property is required to
indicate these events happen in the same session. In the first visit of a user,
you should specify the optional "referrral ID" and
"browser" information. These are used to determine where the user
comes from and the browser information.</p><p>In summary, this template
requires user-view-page event and user-buy-item events with the session ID,
referrer ID and browser properties.</p> <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 an user with ID u0 views a URL page "example.com/page0"
on time <code>2014-11-02T09:39:45.618-08:00</code>, with session ID
"akdj230fj8ass" (current time will be used if eventTime is not
specified) you can send the event to Event Server. Run the following
<code>curl</code> command:</p><div class="tabs"> <ul class="control"> <li
data-lang="json"><a href="#tab-ef5f7ecb-dff6-45f6-
8ed5-30ab39d32a9a">REST API</a></li> <li data-lang="python"><a
href="#tab-7829a710-04dc-421e-bcb0-7b60e31d7256">Python SDK</a></li> <li
data-lang="php"><a href="#tab-a67cfef8-a83b-4b64-b454-bc72f8b90edd">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-69cee151-0c79-4db0-a79c-59b337d923b8">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-9831acf0-f413-4b3a-bab6-9422937524f5">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-ef5f7ecb-dff6-45f6-8ed5-30ab39d32a9a"> <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, Lead Scoring
Engine Template supports the following entities: <strong>user</strong>,
<strong>page</strong>, and <strong>item</strong>. An user views a page, and
buys an item.</p><p>Note that a "sessionId" property is required to
indicate these events happen in the same session. In the first visit of a user,
you should specify the optional "referrral ID" and
"browser" information. These are used to determine where the user
comes from and the browser information.</p><p>In summary, this template
requires user-view-page event and user-buy-item events with the session ID,
referrer ID and browser properties.</p> <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 an user with ID u0 views a URL page "example.com/page0"
on time <code>2014-11-02T09:39:45.618-08:00</code>, with session ID
"akdj230fj8ass" (current time will be used if eventTime is not
specified) you can send the event to Event Server. Run the following
<code>curl</code> command:</p><div class="tabs"> <ul class="control"> <li
data-lang="json"><a href="#tab-fcd5e1c3-7987-46e7-
b45f-6eeb83453eb6">REST API</a></li> <li data-lang="python"><a
href="#tab-0741702d-241f-4de1-a99f-fdb26b883893">Python SDK</a></li> <li
data-lang="php"><a href="#tab-95f04c4e-9357-4a59-845a-1f24800ebac9">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-fad1bf2c-c5f1-44b5-8153-cf5d0c314830">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-4f8d0bfe-4719-4270-950e-25b5d3eaf76b">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-fcd5e1c3-7987-46e7-b45f-6eeb83453eb6"> <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
@@ -61,7 +61,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-7829a710-04dc-421e-bcb0-7b60e31d7256"> <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-0741702d-241f-4de1-a99f-fdb26b883893"> <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
@@ -106,7 +106,7 @@ Your system is all ready to go.
<span class="s">"browser"</span><span class="p">:</span> <span
class="o"><</span><span class="n">BROWSER</span><span class="o">></span>
<span class="c"># optinal. but should specify this if you have this information
when user views the landing page</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-a67cfef8-a83b-4b64-b454-bc72f8b90edd"> <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-95f04c4e-9357-4a59-845a-1f24800ebac9"> <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
@@ -145,7 +145,7 @@ Your system is all ready to go.
<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-69cee151-0c79-4db0-a79c-59b337d923b8"> <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-fad1bf2c-c5f1-44b5-8153-cf5d0c314830"> <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
@@ -178,7 +178,7 @@ Your system is all ready to go.
<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-9831acf0-f413-4b3a-bab6-9422937524f5"> <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-4f8d0bfe-4719-4270-950e-25b5d3eaf76b"> <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
@@ -213,7 +213,7 @@ Your system is all ready to go.
<span class="o">.</span><span class="na">property</span><span
class="o">(</span><span class="s">"referrerId"</span><span class="o">,</span>
<span class="s">"<REFERRER ID>"</span><span class="o">)</span>
<span class="o">.</span><span class="na">property</span><span
class="o">(</span><span class="s">"browser"</span><span class="o">,</span>
<span class="s">"<BROWSER>"</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>In the same browing
session "akdj230fj8ass", the user with ID u0 buys an item i0 on time
<code>2014-11-02T09:42:00.123-08:00</code> (current time will be used if
eventTime is not specified), you can send the following buy event. Run the
following <code>curl</code> command:</p><div class="tabs"> <ul class="control">
<li data-lang="json"><a href="#tab-522b8f55-0bfc-4acc-964f-a8fbdd816284">REST
API</a></li> <li data-lang="python"><a
href="#tab-47801c76-3a53-4085-8364-a37ae651844f">Python SDK</a></li> <li
data-lang="php"><a href="#tab-6961b98b-d8ad-416f-a0d2-c638e916496d">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-c059e3b3-3fa7-4450-92c3-e24529671b87">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-88872f3f-2d64-49b7-bce3-6f20c05c8302">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-522b8f55-0bfc-4acc-964f-a8fbdd816284"> <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>In the same browing
session "akdj230fj8ass", the user with ID u0 buys an item i0 on time
<code>2014-11-02T09:42:00.123-08:00</code> (current time will be used if
eventTime is not specified), you can send the following buy event. Run the
following <code>curl</code> command:</p><div class="tabs"> <ul class="control">
<li data-lang="json"><a href="#tab-db78173a-a00f-42ef-9ad4-72f858fccba4">REST
API</a></li> <li data-lang="python"><a
href="#tab-5ab8c391-8a20-4a1d-90a7-c8a0cb5192b0">Python SDK</a></li> <li
data-lang="php"><a href="#tab-65fee2d7-4ce7-475b-b778-9e06b37fbd4d">PHP
SDK</a></li> <li data-lang="ruby"><a
href="#tab-504a127e-fff1-423b-b004-e5af98df7f6b">Ruby SDK</a></li> <li
data-lang="java"><a href="#tab-3f315edf-3e07-467f-b12a-3b9bf8271266">Java
SDK</a></li> </ul> <div data-tab="REST API" data-lang="json"
id="tab-db78173a-a00f-42ef-9ad4-72f858fccba4"> <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
@@ -238,7 +238,7 @@ Your system is all ready to go.
}
"eventTime" : "2014-11-02T09:42:00.123-08:00"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK"
data-lang="python" id="tab-47801c76-3a53-4085-8364-a37ae651844f"> <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-5ab8c391-8a20-4a1d-90a7-c8a0cb5192b0"> <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
@@ -261,7 +261,7 @@ Your system is all ready to go.
<span class="s">"sessionId"</span><span class="p">:</span> <span
class="o"><</span><span class="n">SESSION</span> <span
class="n">ID</span><span class="o">></span><span class="p">,</span> <span
class="c"># required</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-6961b98b-d8ad-416f-a0d2-c638e916496d"> <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-65fee2d7-4ce7-475b-b778-9e06b37fbd4d"> <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
@@ -288,7 +288,7 @@ Your system is all ready to go.
<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-c059e3b3-3fa7-4450-92c3-e24529671b87"> <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-504a127e-fff1-423b-b004-e5af98df7f6b"> <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
@@ -311,7 +311,7 @@ Your system is all ready to go.
<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-88872f3f-2d64-49b7-bce3-6f20c05c8302"> <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-3f315edf-3e07-467f-b12a-3b9bf8271266"> <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
@@ -371,7 +371,7 @@ User u5 buys item i5
</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 the
results. When a user lands on your page "example.com/page9", with
referrer "referrer10.com" and browser "Firefox", you can
get the predicted lead score by sending this JSON '{
"landingPageId" : "example.com/page9",
"referrerId" : "referrer10.com", "browser":
"Firefox" }' to the deployed engine. The engine will return a
JSON with the score.</p><p>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 data-lang="json"><a
href="#tab-d77c25b5-8be5-4662-b636-9624ffd88e33">REST API</a></li> <li
data-lang="python"><a href="#tab-947c77ff-d930-4e61-b8ad-050313245225">Python
SDK</a></li> <li data-lang="php"><a
href="#tab-1b860b04-e1fc-432d-9665-354c9a3ddfc3">PHP SDK</a></li> <li
data-lang="ruby"><a href="#tab-5ff1ee5b-110d-4bf1-b0c7-8336cc72dcd4">Ruby
SDK</a></li> <li data-lang="java"><a
href="#tab-d15ea609-b642-454b-8bc4-d4173096ef45">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-d77c25b5-8be5-4662-b636-9624ffd88e33"> <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 the
results. When a user lands on your page "example.com/page9", with
referrer "referrer10.com" and browser "Firefox", you can
get the predicted lead score by sending this JSON '{
"landingPageId" : "example.com/page9",
"referrerId" : "referrer10.com", "browser":
"Firefox" }' to the deployed engine. The engine will return a
JSON with the score.</p><p>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 data-lang="json"><a
href="#tab-e9d11c57-9b97-4d7a-aeef-48da508150e8">REST API</a></li> <li
data-lang="python"><a href="#tab-5fbfa154-d0a5-4b9b-9499-00244e647923">Python
SDK</a></li> <li data-lang="php"><a
href="#tab-b51547c8-7257-4d52-9b7d-1ceaa68a0060">PHP SDK</a></li> <li
data-lang="ruby"><a href="#tab-0ddfbdb6-1f2a-4603-a794-326a75c473b7">Ruby
SDK</a></li> <li data-lang="java"><a
href="#tab-386534e3-6b07-4fc3-b7a4-8c6c19804dbb">Java SDK</a></li> </ul> <div
data-tab="REST API" data-lang="json"
id="tab-e9d11c57-9b97-4d7a-aeef-48da508150e8"> <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
@@ -384,7 +384,7 @@ User u5 buys item i5
"browser": "Firefox" }'</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-947c77ff-d930-4e61-b8ad-050313245225"> <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-5fbfa154-d0a5-4b9b-9499-00244e647923"> <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
@@ -397,7 +397,7 @@ http://localhost:8000/queries.json
<span class="s">"referrerId"</span> <span class="p">:</span> <span
class="s">"referrer10.com"</span><span class="p">,</span>
<span class="s">"browser"</span><span class="p">:</span> <span
class="s">"Firefox"</span>
<span class="p">})</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK"
data-lang="php" id="tab-1b860b04-e1fc-432d-9665-354c9a3ddfc3"> <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-b51547c8-7257-4d52-9b7d-1ceaa68a0060"> <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
@@ -426,7 +426,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-5ff1ee5b-110d-4bf1-b0c7-8336cc72dcd4"> <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-0ddfbdb6-1f2a-4603-a794-326a75c473b7"> <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
@@ -447,7 +447,7 @@ http://localhost:8000/queries.json
<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-d15ea609-b642-454b-8bc4-d4173096ef45"> <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-386534e3-6b07-4fc3-b7a4-8c6c19804dbb"> <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
