Reviews - Create Video Reviews

Service:

Azure AI Services

API Version:

1.0

The created reviews appear for reviewers on your team. As reviewers finish reviewing, results of the reviews are posted (that is, HTTP POST) on the specified CallBackEndpoint value.

CallBack Schemas

Review Completion CallBack Sample

{

"ReviewId": "<Review ID>",

"ModifiedOn": "2016-10-11T22:36:32.9934851Z",

"ModifiedBy": "<Name of the reviewer>",

"CallBackType": "Review",

"ContentId": "<ContentId that was specified on input>",

"Metadata": {

"adultscore": "0.xxx",<br/>

"a": "False",<br/>

"racyscore": "0.xxx",<br/>

"r": "True"<br/>

},

"ReviewerResultTags": {

"a": "False",<br/>

"r": "True"<br/>

}

}

.

POST {Endpoint}/contentmoderator/review/v1.0/teams/{teamName}/reviews

With optional parameters:

POST {Endpoint}/contentmoderator/review/v1.0/teams/{teamName}/reviews?overload=video&subTeam={subTeam}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Azure Cognitive Services endpoints (protocol and host name, such as https://westus.api.cognitive.microsoft.com).
teamName	path	True	string	Your team name.
subTeam	query		string	Subteam that you want to assign the created review to.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string
Content-Type	True	string	Content type.

Request Body

Name	Required	Type	Description
Content	True	string	Video content URL to review.
ContentId	True	string	Content identifier.
Status	True		Status of the video.
Type	True		Type of the content.
CallbackEndpoint		string	Callback endpoint.
Metadata		Metadata[]	Metadata details.
Timescale		integer	Timescale of the video.
VideoFrames		VideoFrames[]	Metadata details.

Responses

Name	Type	Description
200 OK	string[]	OK.
Other Status Codes	APIError	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Create video review request

Sample request

HTTP

POST {Endpoint}/contentmoderator/review/v1.0/teams/ModeratorTeam/reviews?overload=video&subTeam=SubteamA



[
  {
    "VideoFrames": [
      {
        "Id": "frm1",
        "Timestamp": "2334",
        "FrameImage": "https://ae01.alicdn.com/kf/HTB1QMvNMVXXXXbpapXXq6xXFXXXJ/Sexy-Europe-font-b-Racy-b-font-Lingerie-Lace-font-b-Red-b-font-Bow-Bride.jpg",
        "Metadata": [
          {
            "Key": "apiScoreVal",
            "Value": "0.206"
          },
          {
            "Key": "a",
            "Value": "False"
          }
        ],
        "ReviewerResultTags": []
      }
    ],
    "Metadata": [
      {
        "Key": "apiScoreVal",
        "Value": "0.206"
      },
      {
        "Key": "a",
        "Value": "False"
      },
      {
        "Key": "racyScore",
        "Value": "0.151"
      },
      {
        "Key": "r",
        "Value": "False"
      },
      {
        "Key": "ExternalId",
        "Value": "Video1.mp4"
      }
    ],
    "Type": "Video",
    "Content": "https://rvdevmediaservicetest.streaming.mediaservices.windows.net/6405af61-e9d7-42e9-ac1f-f18ec094dfcb/YouTube_chef_c.ism/manifest",
    "ContentId": "sample video",
    "CallbackEndpoint": "",
    "Status": "UnPublished"
  }
]

Sample response

Status code:

200

[
  "201709i9srfj128775481f9955033096ddf"
]

Definitions

Name	Description
APIError	Error information that the API returns.
Error	Error body.
Metadata	Metadata details.
ReviewerResultTags
VideoFrames	Metadata details.

APIError

Object

Error information that the API returns.

Name	Type	Description
Error	Error	Error body.

Error

Object

Error body.

Name	Type	Description
Code	string
Message	string

Metadata

Object

Metadata details.

Name	Type	Description
Key	string	Your key parameter.
Value	string	Your value parameter.

ReviewerResultTags

Object

Name	Type	Description
Key	string	Your key parameter.
Value	string	Your value parameter.

VideoFrames

Object

Metadata details.

Name	Type	Description
FrameImage	string	Frame image URL.
Id	string	ID of the frame.
Metadata	Metadata[]	Metadata details.
ReviewerResultTags	ReviewerResultTags[]
Timestamp	integer	Time stamp of the frame.