Rcs-eval-api/v2.1/profile-vector

Jump to: navigation, search

ProfileVector

This is one of several requests that demonstrates how Rovi can generate personalized entertainment recommendations for your customers. To understand this feature, we suggest working with these calls in this order:

This Request . . .       Demonstrates . . .

How an item taste profile gets added to a user taste profile.

What an item taste profile looks like.

What a user taste profile looks like.

How personalized recommendations are generated from a user taste profile.

ProfileVector returns the taste profile of a user as derived from past user events. A taste profile consists of normalized scores of Rovi entertainment categories, listed in order of highest to lowest score. The categories come from the taste profiles of items the user has acted on, and the scores depend on what action was taken. A user taste profile contains the basis for personalized recommendations, as shown in the ForYou request.

Note: You won't see the results of this call in an actual implementation of our personalized recommendations. This call and ItemVector give you an inside look at how our personalization engine works.

Syntax

endpoint/profilevector?apikey=apikey&sig=sig&userid=userid [&size=size]

Request Example 1

Request the taste profile for user ID 100.
http://api.rovicorp.com/snrpreview/v2.1/video/profilevector?apikey=apikey&sig=sig&userid=100

Request Example 2

Request the top five highest scoring categories of the taste profile.
http://api.rovicorp.com/snrpreview/v2.1/video/profilevector?apikey=apikey&sig=sig&userid=100&
size=5

Request Parameters

ParameterRequiredDescription
apikey Yes Access code that authorizes your request for data from Rovi.
endpoint Yes One of the following databases:
  • video
  • music
  • amgvideo

Note: The same results are available for each endpoint.

sig Yes A calculated authorization code. To perform the calculation, execute the MD5 function on the concatenation of the following three strings:
  • Your API key.
  • The secret key you received with your API key.
  • The Unix time. Unix time is a timestamp supported in most development environments, and is generally defined as the number of seconds since January 1, 1970 00:00:00 GMT.

Perform the calculation at the time of each request to be sure it's within a five-minute window of the server time. If you're testing the call in a browser, use our online signature generator to perform the calculation.

userid Yes ID of the user.
size No Number of categories to return. Default is 20.

Response

Response Header

ResponseTypeDescription
controlSet ControlSet The HTTP response status.
id string Server transaction ID for the response.

Response for ProfileVector

ResponseTypeDescription
results result [ ] Taste profile of the user requested.

JSON Response Example

Here's the response for Request Example 1.
Requested with http://api.rovicorp.com/snrpreview/v2.1/video/profilevector?apikey=apikey&sig=sig&userid=100.
{
   "ProfileVectorResponse":{
      "meta:id":"tul1cpgssrapp1:gwy:1z47q",
      "controlSet":{
         "status":"ok",
         "code":200,
         "messages":null
      },
      "results":[
         {
            "id":2726,
            "score":0.9999997,
            "name":"Style :: Sitcom [TV]"
         },
         {
            "id":2079,
            "score":0.999997,
            "name":"Genre :: Comedy"
         },
         {
            "id":13466,
            "score":0.99999684,
            "name":"Misc. :: Animated Sitcom"
         },
         {
            "id":2475,
            "score":0.99999684,
            "name":"Style :: Domestic Comedy"
         },
         {
            "id":5769,
            "score":0.99999684,
            "name":"Style :: Slapstick"
         },
         {
            "id":2031,
            "score":0.9999925,
            "name":"Quality :: Color"
         },
         {
            "id":2321,
            "score":0.99998724,
            "name":"Genre :: Science Fiction"
         },
         {
            "id":3948,
            "score":0.99997926,
            "name":"Style :: Sci-Fi Action"
         },
         {
            "id":1692,
            "score":0.99992645,
            "name":"Mood :: Irreverent"
         },
         {
            "id":1579,
            "score":0.9997447,
            "name":"Mood :: Quirky"
         },
         {
            "id":1722,
            "score":0.9997447,
            "name":"Mood :: Satirical"
         },
         {
            "id":1560,
            "score":0.9997383,
            "name":"Mood :: Tense"
         },
         {
            "id":1605,
            "score":0.9997383,
            "name":"Mood :: Paranoid"
         },
         {
            "id":1680,
            "score":0.9997383,
            "name":"Mood :: Slick"
         },
         {
            "id":1578,
            "score":0.9995094,
            "name":"Mood :: Stylized"
         },
         {
            "id":1728,
            "score":0.9995094,
            "name":"Theme :: Heroic Mission"
         },
         {
            "id":2053,
            "score":0.9995094,
            "name":"Mood :: Explosive"
         },
         {
            "id":1589,
            "score":0.99909204,
            "name":"Mood :: Menacing"
         },
         {
            "id":1672,
            "score":0.99909204,
            "name":"Mood :: Visceral"
         },
         {
            "id":1772,
            "score":0.99909204,
            "name":"Theme :: Time Travel"
         }
      ]
   }
}


See Also

↑ Top

Retrieved from "http://prod-doc.rovicorp.com/mashery/index.php/Rcs-eval-api/v2.1/profile-vector"
Personal tools