Reviews class

Create a Reviews.

new Reviews(client: ContentModeratorClientContext)

Parameters

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

function addVideoFrame(teamName: string, reviewId: string, options?: ReviewsAddVideoFrameOptionalParams): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function addVideoFrame(teamName: string, reviewId: string, options: ReviewsAddVideoFrameOptionalParams, callback: ServiceCallback<void>)

Parameters

function addVideoFrame(teamName: string, reviewId: string, callback: ServiceCallback<void>)

Parameters

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform.Timescale in the Video Moderation output is Ticks/Second.

function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: HttpRequestBody, frameMetadata: string, options?: ReviewsAddVideoFrameStreamOptionalParams): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: HttpRequestBody, frameMetadata: string, options: ReviewsAddVideoFrameStreamOptionalParams, callback: ServiceCallback<void>)

Parameters

function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: HttpRequestBody, frameMetadata: string, callback: ServiceCallback<void>)

Parameters

Use this method to add frames for a video review.Timescale: This parameter is a factor which is used to convert the timestamp on a frame into milliseconds. Timescale is provided in the output of the Content Moderator video media processor on the Azure Media Services platform.Timescale in the Video Moderation output is Ticks/Second.

function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], options?: ReviewsAddVideoFrameUrlOptionalParams): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], options: ReviewsAddVideoFrameUrlOptionalParams, callback: ServiceCallback<void>)

Parameters

function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], callback: ServiceCallback<void>)

Parameters

This API adds a transcript file (text version of all the words spoken in a video) to a video review. The file should be a valid WebVTT format.

function addVideoTranscript(teamName: string, reviewId: string, vTTfile: HttpRequestBody, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function addVideoTranscript(teamName: string, reviewId: string, vTTfile: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

function addVideoTranscript(teamName: string, reviewId: string, vTTfile: HttpRequestBody, callback: ServiceCallback<void>)

Parameters

This API adds a transcript screen text result file for a video review. Transcript screen text result file is a result of Screen Text API . In order to generate transcript screen text result file , a transcript file has to be screened for profanity using Screen Text API.

function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], options?: RequestOptionsBase): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], callback: ServiceCallback<void>)

Parameters

A job Id will be returned for the content posted on this endpoint.

Once the content is evaluated against the Workflow provided the review will be created or ignored based on the workflow expression.

CallBack Schemas

Job Completion CallBack Sample

{
"JobId": ",
"ReviewId": "<Review Id, if the Job resulted in a Review to be created>",
"WorkFlowId": "default",
"Status": "<This will be one of Complete, InProgress, Error>",
"ContentType": "Image",
"ContentId": "",
"CallBackType": "Job",
"Metadata": {
"adultscore": "0.xxx",
"a": "False",
"racyscore": "0.xxx",
"r": "True"
}
}

Review Completion CallBack Sample

{ "ReviewId": "",
"ModifiedOn": "2016-10-11T22:36:32.9934851Z",
"ModifiedBy": "",
"CallBackType": "Review",
"ContentId": "",
"Metadata": {
"adultscore": "0.xxx", "a": "False",
"racyscore": "0.xxx",
"r": "True"
},
"ReviewerResultTags": {
"a": "False",
"r": "True"
}
}

function createJob(teamName: string, contentType: ContentType, contentId: string, workflowName: string, jobContentType: JobContentType, content: Content, options?: ReviewsCreateJobOptionalParams): Promise<ReviewsCreateJobResponse>

Parameters

Returns

Promise<Models.ReviewsCreateJobResponse>

function createJob(teamName: string, contentType: ContentType, contentId: string, workflowName: string, jobContentType: JobContentType, content: Content, options: ReviewsCreateJobOptionalParams, callback: ServiceCallback<JobId>)

Parameters

function createJob(teamName: string, contentType: ContentType, contentId: string, workflowName: string, jobContentType: JobContentType, content: Content, callback: ServiceCallback<JobId>)

Parameters

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], options?: ReviewsCreateReviewsOptionalParams): Promise<ReviewsCreateReviewsResponse>

Parameters

Returns

Promise<Models.ReviewsCreateReviewsResponse>

function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], options: ReviewsCreateReviewsOptionalParams, callback: ServiceCallback<string[]>)

Parameters

function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], callback: ServiceCallback<string[]>)

Parameters

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], options?: ReviewsCreateVideoReviewsOptionalParams): Promise<ReviewsCreateVideoReviewsResponse>

Parameters

Returns

Promise<Models.ReviewsCreateVideoReviewsResponse>

function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], options: ReviewsCreateVideoReviewsOptionalParams, callback: ServiceCallback<string[]>)

Parameters

function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], callback: ServiceCallback<string[]>)

Parameters

Get the Job Details for a Job Id.

function getJobDetails(teamName: string, jobId: string, options?: RequestOptionsBase): Promise<ReviewsGetJobDetailsResponse>

Parameters

Returns

Promise<Models.ReviewsGetJobDetailsResponse>

function getJobDetails(teamName: string, jobId: string, options: RequestOptionsBase, callback: ServiceCallback<Job>)

Parameters

function getJobDetails(teamName: string, jobId: string, callback: ServiceCallback<Job>)

Parameters

Returns review details for the review Id passed.

function getReview(teamName: string, reviewId: string, options?: RequestOptionsBase): Promise<ReviewsGetReviewResponse>

Parameters

Returns

Promise<Models.ReviewsGetReviewResponse>

function getReview(teamName: string, reviewId: string, options: RequestOptionsBase, callback: ServiceCallback<Review>)

Parameters

function getReview(teamName: string, reviewId: string, callback: ServiceCallback<Review>)

Parameters

The reviews created would show up for Reviewers on your team. As Reviewers complete reviewing, results of the Review would be POSTED (i.e. HTTP POST) on the specified CallBackEndpoint.

CallBack Schemas

Review Completion CallBack Sample

{
"ReviewId": "

function getVideoFrames(teamName: string, reviewId: string, options?: ReviewsGetVideoFramesOptionalParams): Promise<ReviewsGetVideoFramesResponse>

Parameters

Returns

Promise<Models.ReviewsGetVideoFramesResponse>

function getVideoFrames(teamName: string, reviewId: string, options: ReviewsGetVideoFramesOptionalParams, callback: ServiceCallback<Frames>)

Parameters

function getVideoFrames(teamName: string, reviewId: string, callback: ServiceCallback<Frames>)

Parameters

Publish video review to make it available for review.

function publishVideoReview(teamName: string, reviewId: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

Returns

Promise<msRest.RestResponse>

function publishVideoReview(teamName: string, reviewId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

function publishVideoReview(teamName: string, reviewId: string, callback: ServiceCallback<void>)

Parameters