Vionlabs Docs

Vionlabs Content Similarity Results API

Vionlabs API for retrieval of content similarity results.

Get similar movies

Get a list of similar movies to the specified customer inventory id from the customer catalog. Similarity level constraints can be applied using the max_score query parameter. Query parameters skip and count can be used to accumulate longer lists over multiple calls

GET
/results/similar/similar/v2/movies/{inventory_id}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

Query Parameters

version?Version

Specify Fingerprint+ version for the similarity lists

skip?Skip

Number of items to skip from beginning of list

count?Count

Number of items to return in list

max_score?Max Score

Maximum score for which items are included

Response Body

curl -X GET "https://loading/results/similar/similar/v2/movies/string?version=string&skip=0&count=0&max_score=0"
{
  "inventory_id": "string",
  "type": "movie",
  "vionlabs_id": "string",
  "last_updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "similar": [
    {
      "inventory_id": "string",
      "type": "movie",
      "vionlabs_id": "string",
      "score": 0
    }
  ]
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get similar series

Get a list of similar series to the specified customer inventory id from the customer catalog. Similarity level constraints can be applied using the max_score query parameter. Query parameters skip and count can be used to accumulate longer lists over multiple calls

GET
/results/similar/similar/v2/series/{inventory_id}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

Query Parameters

version?Version

Specify Fingerprint+ version for the similarity lists

skip?Skip

Number of items to skip from beginning of list

count?Count

Number of items to return in list

max_score?Max Score

Maximum score for which items are included

Response Body

curl -X GET "https://loading/results/similar/similar/v2/series/string?version=string&skip=0&count=0&max_score=0"
{
  "inventory_id": "string",
  "type": "movie",
  "vionlabs_id": "string",
  "last_updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "similar": [
    {
      "inventory_id": "string",
      "type": "movie",
      "vionlabs_id": "string",
      "score": 0
    }
  ]
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get similar items

Get a list of similar items (movies and series) to the specified customer inventory id from the customer catalog. Similarity level constraints can be applied using the max_score query parameter. Query parameters skip and count can be used to accumulate longer lists over multiple calls

GET
/results/similar/similar/v2/{inventory_id}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

Query Parameters

version?Version

Specify Fingerprint+ version for the similarity lists

skip?Skip

Number of items to skip from beginning of list

count?Count

Number of items to return in list

max_score?Max Score

Maximum score for which items are included

Response Body

curl -X GET "https://loading/results/similar/similar/v2/string?version=string&skip=0&count=0&max_score=0"
{
  "inventory_id": "string",
  "type": "movie",
  "vionlabs_id": "string",
  "last_updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "similar": [
    {
      "inventory_id": "string",
      "type": "movie",
      "vionlabs_id": "string",
      "score": 0
    }
  ]
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get item fingerprint

Gets fingerprint for an item in the customer catalog (movie or series). DEPRECATED. Use the Fingerprint+ API or Fingerprint API instead.

GET
/results/similar/fingerprint/v1/{inventory_id}
key<token>

In: query

Path Parameters

inventory_idInventory Id

Customer identifier for a movie or series item in the catalog

Query Parameters

internal?InternalDeprecated

For vionlabs internal use only

version?Version

Specify fingerprint version code

Response Body

curl -X GET "https://loading/results/similar/fingerprint/v1/string?internal=string&version=string"
{
  "inventory_id": "string",
  "type": "movie",
  "vionlabs_id": "string",
  "version_id": "string",
  "fingerprint": [
    0
  ]
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}