Contents, Properties and Profiles

What is Content?

Content is basically an image or a sequence of images, called frames. Videos are supported, but Robbie Visio™ will translate them into just a sequence of images at a certain rate (FPS, Frames per Second), by default FPS=1. Real-time recording sessions, called RTC for Real-Time Communication, are just videos that are tracked in live with immediate response.

Content Format Diagram

Summary

The Content in Robbie Visio™ is axiomatically a frame, which is a single image, or a certain moment of a video o RTC session. Videos and RTC sessions are just special sequences of frames, the first uploaded at some point in time not necessarily when it was recorded, the latter is processed while it is being recorded.


Frames

A frame is an object/entity holding the minimal unit of information for a single Emotional Behavioral Point. The JSON representation for a Frame object is:

1
2
3
4
5
6
7
{
    "utc_timestamp": 19399533,
    "image": "[encoded_base_64_image]",
    "properties": {
        // Some properties
    }
}

As previously mentioned, Video and RTC session are special objects containing sequences of frames for a given start time stamp. This is the JSON representation of a sequence of frames:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 {
     "start_utc_timestamp": 19399533,
     "type": "VIDEO or RTC",
     "frames": {
         "utc_timestamp": 19399533,
         "image": "[encoded_base_64_image]",
         "properties": {
             // Some properties
         }
     }
 }

What are Properties?

Properties are a set of key-value pairs {k:v} attached to a concrete Frame. Properties follow these rules:

  • Must be of type: string, integer or float. Lists or objects/dictionaries are not allowed.
  • Property name/key max length: 10 characters, alphanumeric, special characters #, , and $ are not allowed.
  • Property name/key is case-sensitive: ABC != abc
1
2
3
4
5
6
7
8
9
{
    "utc_timestamp": 19399533,
    "image": "[encoded_base_64_image]",
    "properties": {
        "movie": "Rio Bravo",
        "cinema": "Old Westerns Cinema",
        "location": "Winterset"
    }
}

What are Profiles?

A Profile is a special subset of properties that refers to a concrete User in your platform or application. This enables Robbie Visio™ to treat your emotional data from a customer behavior perspective.

  • Profile user_id user identifier must be supplied as a property itself with this exact name
  • Profile properties are marked with an initial character prefix #. If user_id property is not supplied but # prefixed properties are, an error is raised.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "utc_timestamp": 19399533,
    "image": "[encoded_base_64_image]",
    "properties": {
        "user_id": "john_wayne",
        "#age": 110,
        "#gender": "male",
        "movie": "Rio Bravo",
        "cinema": "Old Westerns Cinema",
        "location": "Winterset"
    }
}

Warning

If you unintentionally input the user_id incorrectly, it won't raise any error, but will create a different profile if the id does not exist or will aggregate the data to a different user if it clashes with another id currently in the platform.