You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@predictionio.apache.org by gi...@apache.org on 2018/08/24 17:33:33 UTC
[7/7] predictionio-site git commit: Documentation based on
apache/predictionio#fc481c9c82989e1b484ea5bfeb540bc96758bed5
Documentation based on apache/predictionio#fc481c9c82989e1b484ea5bfeb540bc96758bed5
Project: http://git-wip-us.apache.org/repos/asf/predictionio-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/predictionio-site/commit/107116dc
Tree: http://git-wip-us.apache.org/repos/asf/predictionio-site/tree/107116dc
Diff: http://git-wip-us.apache.org/repos/asf/predictionio-site/diff/107116dc
Branch: refs/heads/asf-site
Commit: 107116dc22c9d6c5467ba0c1506c61b6a9e10e32
Parents: c17b960
Author: jenkins <bu...@apache.org>
Authored: Fri Aug 24 17:33:22 2018 +0000
Committer: jenkins <bu...@apache.org>
Committed: Fri Aug 24 17:33:22 2018 +0000
----------------------------------------------------------------------
datacollection/batchimport/index.html | 4 +-
datacollection/channel/index.html | 6 +-
datacollection/eventapi/index.html | 20 +-
gallery/template-gallery/index.html | 2 +-
gallery/templates.yaml | 14 +
samples/tabs/index.html | 18 +-
sitemap.xml | 260 +++++++++----------
templates/classification/quickstart/index.html | 30 +--
.../complementarypurchase/quickstart/index.html | 20 +-
.../quickstart/index.html | 60 ++---
.../quickstart/index.html | 60 ++---
templates/leadscoring/quickstart/index.html | 30 +--
templates/productranking/quickstart/index.html | 40 +--
templates/recommendation/quickstart/index.html | 30 +--
templates/similarproduct/quickstart/index.html | 40 +--
templates/vanilla/quickstart/index.html | 10 +-
16 files changed, 329 insertions(+), 315 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/107116dc/datacollection/batchimport/index.html
----------------------------------------------------------------------
diff --git a/datacollection/batchimport/index.html b/datacollection/batchimport/index.html
index b4c83b7..4b739a3 100644
--- a/datacollection/batchimport/index.html
+++ b/datacollection/batchimport/index.html
@@ -7,7 +7,7 @@
</span><span class="p">{</span><span class="s2">"event"</span><span class="p">:</span><span class="s2">"rate"</span><span class="p">,</span><span class="s2">"entityType"</span><span class="p">:</span><span class="s2">"user"</span><span class="p">,</span><span class="s2">"entityId"</span><span class="p">:</span><span class="s2">"3"</span><span class="p">,</span><span class="s2">"targetEntityType"</span><span class="p">:</span><span class="s2">"item"</span><span class="p">,</span><span class="s2">"targetEntityId"</span><span class="p">:</span><span class="s2">"2"</span><span class="p">,</span><span class="s2">"properties"</span><span class="p">:{</span><span class="s2">"rating"</span><span class="p">:</span><span class="mf">1.0</span><span class="p">},</span><span class="s2">"eventTime"</span><span class="p">:</span><span class="s2">"2014-11-21T01:04:14.729Z"</span><span class="p">}</span><span class="w">
</span><span class="p">{</span><span class="s2">"event"</span><span class="p">:</span><span class="s2">"buy"</span><span class="p">,</span><span class="s2">"entityType"</span><span class="p">:</span><span class="s2">"user"</span><span class="p">,</span><span class="s2">"entityId"</span><span class="p">:</span><span class="s2">"3"</span><span class="p">,</span><span class="s2">"targetEntityType"</span><span class="p">:</span><span class="s2">"item"</span><span class="p">,</span><span class="s2">"targetEntityId"</span><span class="p">:</span><span class="s2">"7"</span><span class="p">,</span><span class="s2">"eventTime"</span><span class="p">:</span><span class="s2">"2014-11-21T01:04:14.735Z"</span><span class="p">}</span><span class="w">
</span><span class="p">{</span><span class="s2">"event"</span><span class="p">:</span><span class="s2">"buy"</span><span class="p">,</span><span class="s2">"entityType"</span><span class="p">:</span><span class="s2">"user"</span><span class="p">,</span><span class="s2">"entityId"</span><span class="p">:</span><span class="s2">"3"</span><span class="p">,</span><span class="s2">"targetEntityType"</span><span class="p">:</span><span class="s2">"item"</span><span class="p">,</span><span class="s2">"targetEntityId"</span><span class="p">:</span><span class="s2">"8"</span><span class="p">,</span><span class="s2">"eventTime"</span><span class="p">:</span><span class="s2">"2014-11-21T01:04:14.741Z"</span><span class="p">}</span><span class="w">
-</span></pre></td></tr></tbody></table> </div> <div class="alert-message warning"><p>Please make sure your import file does not contain any empty lines. Empty lines will be treated as a null object and will return an error during import.</p></div><h2 id='use-sdk-to-prepare-batch-input-file' class='header-anchors'>Use SDK to Prepare Batch Input File</h2><p>Some of the Apache PredictionIO SDKs also provides FileExporter client. You may use them to prepare the JSON file as described above. The FileExporter creates event in the same way as EventClient except that the events are written to a JSON file instead of being sent to EventSever. The written JSON file can then be used by batch import.</p><div class="tabs"> <ul class="control"> <li data-lang="php"><a href="#tab-df5ba779-acb2-4b89-a3ce-2334d8066514">PHP SDK</a></li> <li data-lang="python"><a href="#tab-b3a6cd3d-a8df-4bb8-94cc-f51f9c6ef8fc">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-580ef14a-aa9a-48f5-871c-c81aee6e8bf9">
Ruby SDK</a></li> <li data-lang="java"><a href="#tab-bc097fca-27c6-473f-8824-74d484efdbe7">Java SDK</a></li> </ul> <div data-tab="PHP SDK" data-lang="php" id="tab-df5ba779-acb2-4b89-a3ce-2334d8066514"> (coming soon) </div> <div data-tab="Python SDK" data-lang="python" id="tab-b3a6cd3d-a8df-4bb8-94cc-f51f9c6ef8fc"> <div class="highlight python"> <table style="border-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-align: right"><pre class="lineno">1
+</span></pre></td></tr></tbody></table> </div> <div class="alert-message warning"><p>Please make sure your import file does not contain any empty lines. Empty lines will be treated as a null object and will return an error during import.</p></div><h2 id='use-sdk-to-prepare-batch-input-file' class='header-anchors'>Use SDK to Prepare Batch Input File</h2><p>Some of the Apache PredictionIO SDKs also provides FileExporter client. You may use them to prepare the JSON file as described above. The FileExporter creates event in the same way as EventClient except that the events are written to a JSON file instead of being sent to EventSever. The written JSON file can then be used by batch import.</p><div class="tabs"> <ul class="control"> <li data-lang="php"><a href="#tab-ca774732-c49a-42a1-9e15-76e93c22de76">PHP SDK</a></li> <li data-lang="python"><a href="#tab-8c9d1810-7929-45ed-bf76-c6a54397b4f7">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-b3d8badd-e157-45b8-98a7-3693440e9e60">
Ruby SDK</a></li> <li data-lang="java"><a href="#tab-b2243419-4fa8-45fc-bc57-6dbf0eb73214">Java SDK</a></li> </ul> <div data-tab="PHP SDK" data-lang="php" id="tab-ca774732-c49a-42a1-9e15-76e93c22de76"> (coming soon) </div> <div data-tab="Python SDK" data-lang="python" id="tab-8c9d1810-7929-45ed-bf76-c6a54397b4f7"> <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
@@ -58,7 +58,7 @@
<span class="c"># close the FileExporter when finish writing all events</span>
<span class="n">exporter</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK" data-lang="ruby" id="tab-580ef14a-aa9a-48f5-871c-c81aee6e8bf9"> (coming soon) </div> <div data-tab="Java SDK" data-lang="java" id="tab-bc097fca-27c6-473f-8824-74d484efdbe7"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK" data-lang="ruby" id="tab-b3d8badd-e157-45b8-98a7-3693440e9e60"> (coming soon) </div> <div data-tab="Java SDK" data-lang="java" id="tab-b2243419-4fa8-45fc-bc57-6dbf0eb73214"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
</pre></td> </tr></tbody></table> </div> </div> </div> <h2 id='import-events-from-input-file' class='header-anchors'>Import Events from Input File</h2><p>Importing events from a file can be done easily using the command line interface. Assuming that <code>pio</code> be in your search path, your App ID be <code>123</code>, and the input file <code>my_events.json</code> be in your current working directory:</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 import --appid 123 --input my_events.json
</pre></td></tr></tbody></table> </div> <p>After a brief while, the tool should return to the console without any error. Congratulations! You have successfully imported your events.</p></div></div></div></div><footer><div class="container"><div class="seperator"></div><div class="row"><div class="col-md-6 footer-link-column"><div class="footer-link-column-row"><h4>Community</h4><ul><li><a href="//predictionio.apache.org/install/" target="blank">Download</a></li><li><a href="//predictionio.apache.org/" target="blank">Docs</a></li><li><a href="//github.com/apache/predictionio" target="blank">GitHub</a></li><li><a href="mailto:user-subscribe@predictionio.apache.org" target="blank">Subscribe to User Mailing List</a></li><li><a href="//stackoverflow.com/questions/tagged/predictionio" target="blank">Stackoverflow</a></li></ul></div></div><div class="col-md-6 footer-link-column"><div class="footer-link-column-row"><h4>Contribute</h4><ul><li><a href="//predictionio.apache.org/community/cont
ribute-code/" target="blank">Contribute</a></li><li><a href="//github.com/apache/predictionio" target="blank">Source Code</a></li><li><a href="//issues.apache.org/jira/browse/PIO" target="blank">Bug Tracker</a></li><li><a href="mailto:dev-subscribe@predictionio.apache.org" target="blank">Subscribe to Development Mailing List</a></li></ul></div></div></div><div class="row"><div class="col-md-12 footer-link-column"><p>Apache PredictionIO, PredictionIO, Apache, the Apache feather logo, and the Apache PredictionIO project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p><p>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p></div></div></div><div id="footer-bottom"><div class="container"><div class="row"><div class="col-md-12"><div id="footer-logo-wrapper"><img alt="PredictionIO" src="/images/logos/logo-white-d1e9c6e6.png"/><span>®</span></div><div id="socia
l-icons-wrapper"><a class="github-button" href="https://github.com/apache/predictionio" data-style="mega" data-count-href="/apache/predictionio/stargazers" data-count-api="/repos/apache/predictionio#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star apache/predictionio on GitHub">Star</a> <a class="github-button" href="https://github.com/apache/predictionio/fork" data-icon="octicon-git-branch" data-style="mega" data-count-href="/apache/predictionio/network" data-count-api="/repos/apache/predictionio#forks_count" data-count-aria-label="# forks on GitHub" aria-label="Fork apache/predictionio on GitHub">Fork</a> <script id="github-bjs" async="" defer="" src="https://buttons.github.io/buttons.js"></script><a href="https://twitter.com/predictionio" target="blank"><img alt="PredictionIO on Twitter" src="/images/icons/twitter-ea9dc152.png"/></a> <a href="https://www.facebook.com/predictionio" target="blank"><img alt="PredictionIO on Facebook" src="/images/ico
ns/facebook-5c57939c.png"/></a> </div></div></div></div></div></footer></div><script>(function(w,d,t,u,n,s,e){w['SwiftypeObject']=n;w[n]=w[n]||function(){
(w[n].q=w[n].q||[]).push(arguments);};s=d.createElement(t);
http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/107116dc/datacollection/channel/index.html
----------------------------------------------------------------------
diff --git a/datacollection/channel/index.html b/datacollection/channel/index.html
index 0237a54..e3d7d65 100644
--- a/datacollection/channel/index.html
+++ b/datacollection/channel/index.html
@@ -12,7 +12,7 @@
[INFO] [App$] Channel Name: myChannel
[INFO] [App$] Channel ID: 2
[INFO] [App$] App ID: 5
-</span></pre></td></tr></tbody></table> </div> <p>Now "myChannel" is created and ready for collecting data.</p><h2 id='collect-data-through-channel' class='header-anchors'>Collect data through Channel</h2><p>The Event API support optional <code>channel</code> query parameter. This allows you to import and query events of the specified channel. When the <code>channel</code> parameter is not specified, the data is collected through the default channel.</p><p>URL: <code>http://localhost:7070/events.json?accessKey=yourAccessKeyString&channel=yourChannelName</code></p><p>Query parameters:</p> <table><thead> <tr> <th style="text-align: left">Field</th> <th style="text-align: left">Type</th> <th style="text-align: left">Description</th> </tr> </thead><tbody> <tr> <td style="text-align: left"><code>accessKey</code></td> <td style="text-align: left">String</td> <td style="text-align: left">The Access Key for your App</td> </tr> <tr> <td style="text-align: left"><code>channel</c
ode></td> <td style="text-align: left">String</td> <td style="text-align: left">The channel name (optional). Specify this to import data to this channel. <strong>NOTE: supported in PIO version >= 0.9.2</strong> only. Channel must be created first.</td> </tr> </tbody></table> <p>For SDK usage, one EventClient should be responsible for collecting data of one specific channel. The channel name is specified when the EventClient object is instantiated.</p><p>For example, the following code import event to "YOUR_CHANNEL" of the corresponding App.</p><div class="tabs"> <ul class="control"> <li data-lang="bash"><a href="#tab-9686b748-ff2d-44b0-b95e-b5b5f4ccf3e4">Raw HTTP</a></li> <li data-lang="php"><a href="#tab-fab4217e-3082-40d9-a73f-c87271c80cd6">PHP SDK</a></li> <li data-lang="python"><a href="#tab-02b989ec-2bbe-480c-a9d1-b0e9f70986cb">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-385486bf-65da-4434-941e-1a11044e7812">Ruby SDK</a></li> <li data-lang="java"><a href
="#tab-73e02180-ece3-41a4-8ec9-a2daae110ab4">Java SDK</a></li> </ul> <div data-tab="Raw HTTP" data-lang="bash" id="tab-9686b748-ff2d-44b0-b95e-b5b5f4ccf3e4"> <div class="highlight shell"> <table style="border-spacing: 0"><tbody><tr> <td class="gutter gl" style="text-align: right"><pre class="lineno">1
+</span></pre></td></tr></tbody></table> </div> <p>Now "myChannel" is created and ready for collecting data.</p><h2 id='collect-data-through-channel' class='header-anchors'>Collect data through Channel</h2><p>The Event API support optional <code>channel</code> query parameter. This allows you to import and query events of the specified channel. When the <code>channel</code> parameter is not specified, the data is collected through the default channel.</p><p>URL: <code>http://localhost:7070/events.json?accessKey=yourAccessKeyString&channel=yourChannelName</code></p><p>Query parameters:</p> <table><thead> <tr> <th style="text-align: left">Field</th> <th style="text-align: left">Type</th> <th style="text-align: left">Description</th> </tr> </thead><tbody> <tr> <td style="text-align: left"><code>accessKey</code></td> <td style="text-align: left">String</td> <td style="text-align: left">The Access Key for your App</td> </tr> <tr> <td style="text-align: left"><code>channel</c
ode></td> <td style="text-align: left">String</td> <td style="text-align: left">The channel name (optional). Specify this to import data to this channel. <strong>NOTE: supported in PIO version >= 0.9.2</strong> only. Channel must be created first.</td> </tr> </tbody></table> <p>For SDK usage, one EventClient should be responsible for collecting data of one specific channel. The channel name is specified when the EventClient object is instantiated.</p><p>For example, the following code import event to "YOUR_CHANNEL" of the corresponding App.</p><div class="tabs"> <ul class="control"> <li data-lang="bash"><a href="#tab-ee4e2b69-3533-46b7-b741-e9a327ca22ac">Raw HTTP</a></li> <li data-lang="php"><a href="#tab-73e589a2-5015-4ed5-8ac1-be88e8396571">PHP SDK</a></li> <li data-lang="python"><a href="#tab-b3ad565f-2464-4f9a-8f91-272c4c2a9e95">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-9f64a097-38eb-4958-9317-e62786542975">Ruby SDK</a></li> <li data-lang="java"><a href
="#tab-2229f9d5-f2cd-4ed8-b374-7c762e0949fc">Java SDK</a></li> </ul> <div data-tab="Raw HTTP" data-lang="bash" id="tab-ee4e2b69-3533-46b7-b741-e9a327ca22ac"> <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
@@ -39,7 +39,7 @@
},
"eventTime" : "2004-12-13T21:39:45.618Z"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK" data-lang="php" id="tab-fab4217e-3082-40d9-a73f-c87271c80cd6"> (TODO: update me) </div> <div data-tab="Python SDK" data-lang="python" id="tab-02b989ec-2bbe-480c-a9d1-b0e9f70986cb"> <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="PHP SDK" data-lang="php" id="tab-73e589a2-5015-4ed5-8ac1-be88e8396571"> (TODO: update me) </div> <div data-tab="Python SDK" data-lang="python" id="tab-b3ad565f-2464-4f9a-8f91-272c4c2a9e95"> <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
@@ -80,7 +80,7 @@
<span class="n">properties</span><span class="o">=</span><span class="n">event_properties</span><span class="p">,</span>
<span class="n">event_time</span><span class="o">=</span><span class="n">datetime</span><span class="p">(</span><span class="mi">2014</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">21</span><span class="p">,</span> <span class="mi">38</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">618000</span><span class="p">,</span> <span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">))</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK" data-lang="ruby" id="tab-385486bf-65da-4434-941e-1a11044e7812"> (TODO: update me) </div> <div data-tab="Java SDK" data-lang="java" id="tab-73e02180-ece3-41a4-8ec9-a2daae110ab4"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK" data-lang="ruby" id="tab-9f64a097-38eb-4958-9317-e62786542975"> (TODO: update me) </div> <div data-tab="Java SDK" data-lang="java" id="tab-2229f9d5-f2cd-4ed8-b374-7c762e0949fc"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
</pre></td> </tr></tbody></table> </div> </div> </div> <p>You can also follow the EventAPI <a href="/datacollection/eventapi/#debugging-recipes">debug receipts</a> to query the events of specific channel by adding the <code>channel</code> query parameter in the URL.</p><h2 id='delete-a-channel-(including-all-imported-data)' class='header-anchors'>Delete a Channel (including all imported data)</h2><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>pio app channel-delete <app name> <channel name>
</pre></td></tr></tbody></table> </div> <h2 id='delete-the-data-only-of-a-channel' class='header-anchors'>Delete the data-only of a Channel</h2><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>pio app data-delete <app name> --channel <channel name>
</pre></td></tr></tbody></table> </div> <h2 id='accessing-channel-data-in-engine' class='header-anchors'>Accessing Channel Data in Engine</h2><p>To acccess channel data, simply specify the channel name when use the PEventStore or LEventStore API. Data is read from from the default channel if channelName is not specified.</p><p>For example, read data from default channel:</p><div class="highlight scala"><table style="border-spacing: 0"><tbody><tr><td class="gutter gl" style="text-align: right"><pre class="lineno">1
http://git-wip-us.apache.org/repos/asf/predictionio-site/blob/107116dc/datacollection/eventapi/index.html
----------------------------------------------------------------------
diff --git a/datacollection/eventapi/index.html b/datacollection/eventapi/index.html
index a3d11db..282c10a 100644
--- a/datacollection/eventapi/index.html
+++ b/datacollection/eventapi/index.html
@@ -22,7 +22,7 @@ Content-Length: 18
<span class="o">[</span>INFO] <span class="o">[</span>App<span class="nv">$]</span> Name: MyTestApp
<span class="o">[</span>INFO] <span class="o">[</span>App<span class="nv">$]</span> ID: 6
<span class="o">[</span>INFO] <span class="o">[</span>App<span class="nv">$]</span> Access Key: WPgcXKd42FPQpZHVbVeMyqF4CQJUnXQmIMTHhX3ZUrSzvy1KXJjdFUrslifa9rnB
-</pre></td></tr></tbody></table> </div> <h3 id='creating-your-first-event' class='header-anchors'>Creating Your First Event</h3><p>You may connect to the Event Server with HTTP request or by using one of many <strong>Apache PredictionIO SDKs</strong>.</p><p>For example, the following shows how one can create an event involving a single entity. Replace the value of <code>accessKey</code> by the <em>Access Key</em> generated for your App.</p><div class="tabs"> <ul class="control"> <li data-lang="bash"><a href="#tab-194583ac-c4b7-4a90-9874-b9757cf1b09f">Raw HTTP</a></li> <li data-lang="php"><a href="#tab-889d5a76-588b-48bc-8824-1115e0ab575a">PHP SDK</a></li> <li data-lang="python"><a href="#tab-5b17f7fa-8344-420e-bfa9-9cc082871842">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-8ee34816-1104-4047-b8bb-149b0b37dfbf">Ruby SDK</a></li> <li data-lang="java"><a href="#tab-877e7d41-a0c2-40b9-9ae2-fca778e653ca">Java SDK</a></li> </ul> <div data-tab="Raw HTTP" data-lang="bash" id="tab-
194583ac-c4b7-4a90-9874-b9757cf1b09f"> <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> <h3 id='creating-your-first-event' class='header-anchors'>Creating Your First Event</h3><p>You may connect to the Event Server with HTTP request or by using one of many <strong>Apache PredictionIO SDKs</strong>.</p><p>For example, the following shows how one can create an event involving a single entity. Replace the value of <code>accessKey</code> by the <em>Access Key</em> generated for your App.</p><div class="tabs"> <ul class="control"> <li data-lang="bash"><a href="#tab-08662d9d-9de2-438a-957e-96f5df0c16b3">Raw HTTP</a></li> <li data-lang="php"><a href="#tab-5424115d-f6e5-4b8d-aa18-3bf43ebcc000">PHP SDK</a></li> <li data-lang="python"><a href="#tab-4edc764c-b48e-4d44-8936-8b6928cad1e2">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-368aa4dc-07d7-444f-b46d-48fe79f237a6">Ruby SDK</a></li> <li data-lang="java"><a href="#tab-dcaa5beb-1091-4f79-a06a-46cbf938c8e5">Java SDK</a></li> </ul> <div data-tab="Raw HTTP" data-lang="bash" id="tab-
08662d9d-9de2-438a-957e-96f5df0c16b3"> <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
@@ -53,7 +53,7 @@ Content-Length: 18
}
"eventTime" : "2004-12-13T21:39:45.618-07:00"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK" data-lang="php" id="tab-889d5a76-588b-48bc-8824-1115e0ab575a"> <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-5424115d-f6e5-4b8d-aa18-3bf43ebcc000"> <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
@@ -94,7 +94,7 @@ Content-Length: 18
<span class="s1">'eventTime'</span> <span class="o">=></span> <span class="s1">'2004-12-13T21:39:45.618-07:00'</span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK" data-lang="python" id="tab-5b17f7fa-8344-420e-bfa9-9cc082871842"> <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-4edc764c-b48e-4d44-8936-8b6928cad1e2"> <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
@@ -137,7 +137,7 @@ Content-Length: 18
<span class="n">properties</span><span class="o">=</span><span class="n">first_event_properties</span><span class="p">,</span>
<span class="n">event_time</span><span class="o">=</span><span class="n">first_event_time</span><span class="p">,</span>
<span class="p">)</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK" data-lang="ruby" id="tab-8ee34816-1104-4047-b8bb-149b0b37dfbf"> <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-368aa4dc-07d7-444f-b46d-48fe79f237a6"> <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
@@ -158,8 +158,8 @@ Content-Length: 18
<span class="s1">'prop4'</span> <span class="o">=></span> <span class="kp">true</span><span class="p">,</span>
<span class="s1">'prop5'</span> <span class="o">=></span> <span class="sx">%w(a b c)</span><span class="p">,</span>
<span class="s1">'prop6'</span> <span class="o">=></span> <span class="mi">4</span><span class="o">.</span><span class="mi">56</span> <span class="p">})</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK" data-lang="java" id="tab-877e7d41-a0c2-40b9-9ae2-fca778e653ca"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
-</pre></td> </tr></tbody></table> </div> </div> </div> <p>For example, the following shows how one can create an event involving two entities (with <code>targetEntity</code>).</p><div class="tabs"> <ul class="control"> <li data-lang="bash"><a href="#tab-90f9e6a1-c4e5-4045-b1d4-054c0548ded5">Raw HTTP</a></li> <li data-lang="php"><a href="#tab-4f039be0-1b1a-4553-93db-b209d5aeb638">PHP SDK</a></li> <li data-lang="python"><a href="#tab-f86a98e9-1609-4305-90b6-2e02eca636d9">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-e6ace4c5-8c1d-4fc1-a13d-05cc1189a850">Ruby SDK</a></li> <li data-lang="java"><a href="#tab-19761dc1-3e13-4f7d-9c36-2e3febda7dae">Java SDK</a></li> </ul> <div data-tab="Raw HTTP" data-lang="bash" id="tab-90f9e6a1-c4e5-4045-b1d4-054c0548ded5"> <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 data-tab="Java SDK" data-lang="java" id="tab-dcaa5beb-1091-4f79-a06a-46cbf938c8e5"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
+</pre></td> </tr></tbody></table> </div> </div> </div> <p>For example, the following shows how one can create an event involving two entities (with <code>targetEntity</code>).</p><div class="tabs"> <ul class="control"> <li data-lang="bash"><a href="#tab-4b0f98bd-144e-4f7a-9d9e-b30386f04a51">Raw HTTP</a></li> <li data-lang="php"><a href="#tab-9dfbb5b5-69b6-4fec-a85a-483db0239200">PHP SDK</a></li> <li data-lang="python"><a href="#tab-479aeb38-1a14-49ac-bbf6-216be78fdd1b">Python SDK</a></li> <li data-lang="ruby"><a href="#tab-d73247a2-b55e-46b0-9dd7-535e04ac21da">Ruby SDK</a></li> <li data-lang="java"><a href="#tab-e96476a0-d977-44e5-8261-441d3f94314f">Java SDK</a></li> </ul> <div data-tab="Raw HTTP" data-lang="bash" id="tab-4b0f98bd-144e-4f7a-9d9e-b30386f04a51"> <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
@@ -186,7 +186,7 @@ Content-Length: 18
},
"eventTime" : "2004-12-13T21:39:45.618Z"
}'</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="PHP SDK" data-lang="php" id="tab-4f039be0-1b1a-4553-93db-b209d5aeb638"> <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-9dfbb5b5-69b6-4fec-a85a-483db0239200"> <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
@@ -221,7 +221,7 @@ Content-Length: 18
<span class="s1">'eventTime'</span> <span class="o">=></span> <span class="s1">'2004-12-13T21:39:45.618Z'</span>
<span class="p">));</span>
<span class="cp">?></span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Python SDK" data-lang="python" id="tab-f86a98e9-1609-4305-90b6-2e02eca636d9"> <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-479aeb38-1a14-49ac-bbf6-216be78fdd1b"> <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
@@ -246,7 +246,7 @@ Content-Length: 18
<span class="n">target_entity_id</span><span class="o">=</span><span class="s">"iid"</span><span class="p">,</span>
<span class="n">properties</span><span class="o">=</span><span class="n">second_event_properties</span><span class="p">,</span>
<span class="n">event_time</span><span class="o">=</span><span class="n">datetime</span><span class="p">(</span><span class="mi">2014</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">13</span><span class="p">,</span> <span class="mi">21</span><span class="p">,</span> <span class="mi">38</span><span class="p">,</span> <span class="mi">45</span><span class="p">,</span> <span class="mi">618000</span><span class="p">,</span> <span class="n">pytz</span><span class="o">.</span><span class="n">utc</span><span class="p">))</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Ruby SDK" data-lang="ruby" id="tab-e6ace4c5-8c1d-4fc1-a13d-05cc1189a850"> <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-d73247a2-b55e-46b0-9dd7-535e04ac21da"> <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
@@ -263,7 +263,7 @@ Content-Length: 18
<span class="s1">'eventTime'</span> <span class="o">=></span> <span class="s1">'2004-12-13T21:39:45.618Z'</span><span class="p">,</span>
<span class="s1">'properties'</span> <span class="o">=></span> <span class="p">{</span> <span class="s1">'someProperty'</span> <span class="o">=></span> <span class="s1">'value1'</span><span class="p">,</span>
<span class="s1">'anotherProperty'</span> <span class="o">=></span> <span class="s1">'value2'</span> <span class="p">})</span>
-</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK" data-lang="java" id="tab-19761dc1-3e13-4f7d-9c36-2e3febda7dae"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
+</pre></td> </tr></tbody></table> </div> </div> <div data-tab="Java SDK" data-lang="java" id="tab-e96476a0-d977-44e5-8261-441d3f94314f"> <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> <td class="code"><pre><span class="o">(</span><span class="n">coming</span> <span class="n">soon</span><span class="o">)</span>
</pre></td> </tr></tbody></table> </div> </div> </div> <p>Sample response:</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
3