commit	87ad4f2e7ee6c8b5840690a138f713980efcf760	[log] [tgz]
author	Kenneth Chan <kenneth@prediction.io>	Tue May 19 15:49:05 2015 -0700
committer	Kenneth Chan <kenneth@prediction.io>	Tue May 19 15:49:05 2015 -0700
tree	c4c5b9f0e0bcbd1da9c17bfc39c075047b252835
parent	aaa45ef2e495c5fb32e9105d701797c33125a7e3 [diff]

tree: c4c5b9f0e0bcbd1da9c17bfc39c075047b252835

README.md

PredictionIO Ruby SDK

The Ruby SDK provides a convenient wrapper for the PredictionIO API. It allows you to quickly record your users' behavior and retrieve personalized predictions for them.

Documentation

Full Ruby SDK documentation can be found here.

Please see the PredictionIO App Integration Overview to understand how the SDK can be used to integrate PredictionIO Event Server and Engine with your application.

Installation

Ruby 1.9.3+ required!

The module is published to RubyGems and can be installed directly by:

gem install predictionio

Or using Bundler with:

gem 'predictionio', '0.9.0'

Sending Events to Event Server

Please refer to Event Server documentation for event format and how the data can be collected from your app.

Instantiate Event Client and connect to PredictionIO Event Server

# Define environment variables.
ENV['PIO_THREADS'] = 50 # For async requests.
ENV['PIO_EVENT_SERVER_URL'] = 'http://localhost:7070'
ENV['PIO_ACCESS_KEY'] = 'YOUR_ACCESS_KEY' # Find your access key with: `$ pio app list`.

# Create PredictionIO event client.
client = PredictionIO::EventClient.new(ENV['PIO_ACCESS_KEY'], ENV['PIO_EVENT_SERVER_URL'], ENV['PIO_THREADS'])

Create a `$set` user event and send it to Event Server

client.create_event(
  '$set',
  'user',
  user_id
)

Create a `$set` item event and send it to Event Server

client.create_event(
  '$set',
  'item',
  item_id,
  { 'properties' => { 'categories' => ['Category 1', 'Category 2'] } }
)

Create a user ‘rate’ item event and send it to Event Server

client.create_event(
  'rate',
  'user',
  user_id, {
    'targetEntityType' => 'item',
    'targetEntityId' => item_id,
    'properties' => { 'rating' => 10 }
  }
)

Asynchronous request

To use an async request simply change create_event to acreate_event. The asynchronous method wont though an error though so it's best to start with the synchronous one.

Query PredictionIO Engine

Connect to the Engine:

# Define environmental variables.
ENV['PIO_ENGINE_URL'] = 'http://localhost:8000'

# Create PredictionIO engine client.
client = PredictionIO::EngineClient.new(ENV['PIO_ENGINE_URL'])

Send a prediction query to the engine and get the predicted result:

# Get 5 recommendations for items similar to 10, 20, 30.
response = client.send_query(items: [10, 20, 30], num: 5)

Forum

View Google Group

Issue Tracker

Use JIRA or GitHub Issues.

Contributing

We follow the [git-flow] (http://nvie.com/posts/a-successful-git-branching-model/) model where all active development goes to the develop branch, and releases go to the master branch. Pull requests should be made against the develop branch and include relevant tests, if applicable. Please sign our Contributor Agreement before submitting a pull request.

License

Apache License 2.0.