Vionlabs Docs

Vionlabs Profanity Detection API

Vionlabs API for retrieval of content profanity results.

Get Segment Predictions

Gets a list of speech segments containing profanity, with a corresponding profanity score.

GET
/results/profanity/v1/segments/{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 profanity version code.

Response Body

curl -X GET "https://loading/results/profanity/v1/segments/string?version=string"
{
  "inventory_id": "string",
  "type": "movie",
  "vionlabs_id": "string",
  "version_id": "string",
  "profanity": {
    "segments": [
      {
        "start": 0,
        "end": 0,
        "score": 0
      }
    ],
    "label": "None"
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get Profanity

Gets a profanity classification for a given title.

GET
/results/profanity/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

version?Version

Specify profanity version code.

Response Body

curl -X GET "https://loading/results/profanity/v1/string?version=string"
{
  "inventory_id": "string",
  "type": "movie",
  "vionlabs_id": "string",
  "version_id": "string",
  "label": "None"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get item content profanity result status and data

Gets a profanity result status and classification data for a given title.

GET
/results/profanity/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 profanity version code.

Response Body

curl -X GET "https://loading/results/profanity/v2/string?version=string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie",
  "data": {
    "inventory_id": "string",
    "type": "movie",
    "vionlabs_id": "string",
    "version_id": "string",
    "profanity": {
      "label": "None"
    }
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get paginated list of items with profanity results statuses and data ordered by creation/update timestamp

Gets a paginated list of items with profanity results statuses and metadata for the customer catalog

GET
/results/profanity/v2/
key<token>

In: query

Query Parameters

from_utcdatetime?From Utcdatetime

Specifies start of time window (ISO 8601). If not specified then all results will be returned

Formatdate-time
to_utcdatetime?To Utcdatetime

Specifies end of time window (ISO 8601). If not specified then utcnow() value will be used.It is recommended to fix this argument while looping across pages to establish a fixed time window

Formatdate-time
page_num?Page Num

Specifies a positional number of page with results

Default0
Range0 <= value
page_size?Page Size

Specifies a max number of results per page

Default500
Range1 <= value
version?Version

Specifies Profanity version code

Response Body

curl -X GET "https://loading/results/profanity/v2/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=500&version=string"
{
  "page_num": 0,
  "page_size": 0,
  "total_count": 0,
  "data": []
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Get item content profanity segments result status and data

Gets a list of speech segments containing profanity, with a corresponding profanity score.

GET
/results/profanity/v2/segments/{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 profanity version code.

Response Body

curl -X GET "https://loading/results/profanity/v2/segments/string?version=string"
{
  "status": "success",
  "error": "string",
  "updated": "2019-08-24T14:15:22Z",
  "version_id": "string",
  "inventory_id": "string",
  "type": "movie",
  "data": {
    "inventory_id": "string",
    "type": "movie",
    "vionlabs_id": "string",
    "version_id": "string",
    "profanity": {
      "segments": [
        {
          "start": 0,
          "end": 0,
          "score": 0
        }
      ]
    }
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}