Reviews class
Class representing a Reviews.
Constructors
| Reviews(Content |
Create a Reviews. |
Methods
| add |
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 SchemasReview Completion CallBack Sample
{ |
| add |
|
| add |
|
| add |
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. |
| add |
|
| add |
|
| add |
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. |
| add |
|
| add |
|
| add |
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. |
| add |
|
| add |
|
| add |
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. |
| add |
|
| add |
|
| create |
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{
Review Completion CallBack Sample{
"ReviewId": "", |
| create |
|
| create |
|
| create |
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 SchemasReview Completion CallBack Sample
{ |
| create |
|
| create |
|
| create |
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 SchemasReview Completion CallBack Sample
{ |
| create |
|
| create |
|
| get |
Get the Job Details for a Job Id. |
| get |
|
| get |
|
| get |
Returns review details for the review Id passed. |
| get |
|
| get |
|
| get |
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 SchemasReview Completion CallBack Sample
{ |
| get |
|
| get |
|
| publish |
Publish video review to make it available for review. |
| publish |
|
| publish |
Constructor Details
Reviews(ContentModeratorClientContext)
Create a Reviews.
new Reviews(client: ContentModeratorClientContext)Parameters
Reference to the service client.
Method Details
addVideoFrame(string, string, ReviewsAddVideoFrameOptionalParams)
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
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
addVideoFrame(string, string, ReviewsAddVideoFrameOptionalParams, ServiceCallback<void>)
function addVideoFrame(teamName: string, reviewId: string, options: ReviewsAddVideoFrameOptionalParams, callback: ServiceCallback<void>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
addVideoFrame(string, string, ServiceCallback<void>)
function addVideoFrame(teamName: string, reviewId: string, callback: ServiceCallback<void>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- callback
-
ServiceCallback<void>
The callback
addVideoFrameStream(string, string, string, HttpRequestBody, string, ReviewsAddVideoFrameStreamOptionalParams)
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
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- frameImageZip
- HttpRequestBody
Zip file containing frame images.
- frameMetadata
-
string
Metadata of the frame.
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
addVideoFrameStream(string, string, string, HttpRequestBody, string, ReviewsAddVideoFrameStreamOptionalParams, ServiceCallback<void>)
function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: HttpRequestBody, frameMetadata: string, options: ReviewsAddVideoFrameStreamOptionalParams, callback: ServiceCallback<void>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- frameImageZip
- HttpRequestBody
Zip file containing frame images.
- frameMetadata
-
string
Metadata of the frame.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
addVideoFrameStream(string, string, string, HttpRequestBody, string, ServiceCallback<void>)
function addVideoFrameStream(contentType: string, teamName: string, reviewId: string, frameImageZip: HttpRequestBody, frameMetadata: string, callback: ServiceCallback<void>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- frameImageZip
- HttpRequestBody
Zip file containing frame images.
- frameMetadata
-
string
Metadata of the frame.
- callback
-
ServiceCallback<void>
The callback
addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ReviewsAddVideoFrameUrlOptionalParams)
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
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- videoFrameBody
Body for add video frames API
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ReviewsAddVideoFrameUrlOptionalParams, ServiceCallback<void>)
function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], options: ReviewsAddVideoFrameUrlOptionalParams, callback: ServiceCallback<void>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- videoFrameBody
Body for add video frames API
The optional parameters
- callback
-
ServiceCallback<void>
The callback
addVideoFrameUrl(string, string, string, VideoFrameBodyItem[], ServiceCallback<void>)
function addVideoFrameUrl(contentType: string, teamName: string, reviewId: string, videoFrameBody: VideoFrameBodyItem[], callback: ServiceCallback<void>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- videoFrameBody
Body for add video frames API
- callback
-
ServiceCallback<void>
The callback
addVideoTranscript(string, string, HttpRequestBody, RequestOptionsBase)
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
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- vTTfile
- HttpRequestBody
Transcript file of the video.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
addVideoTranscript(string, string, HttpRequestBody, RequestOptionsBase, ServiceCallback<void>)
function addVideoTranscript(teamName: string, reviewId: string, vTTfile: HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- vTTfile
- HttpRequestBody
Transcript file of the video.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
addVideoTranscript(string, string, HttpRequestBody, ServiceCallback<void>)
function addVideoTranscript(teamName: string, reviewId: string, vTTfile: HttpRequestBody, callback: ServiceCallback<void>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- vTTfile
- HttpRequestBody
Transcript file of the video.
- callback
-
ServiceCallback<void>
The callback
addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], RequestOptionsBase)
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
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- transcriptModerationBody
Body for add video transcript moderation result API
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], RequestOptionsBase, ServiceCallback<void>)
function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- transcriptModerationBody
Body for add video transcript moderation result API
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
addVideoTranscriptModerationResult(string, string, string, TranscriptModerationBodyItem[], ServiceCallback<void>)
function addVideoTranscriptModerationResult(contentType: string, teamName: string, reviewId: string, transcriptModerationBody: TranscriptModerationBodyItem[], callback: ServiceCallback<void>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- transcriptModerationBody
Body for add video transcript moderation result API
- callback
-
ServiceCallback<void>
The callback
createJob(string, ContentType, string, string, JobContentType, Content, ReviewsCreateJobOptionalParams)
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
- teamName
-
string
Your team name.
- contentType
- ContentType
Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'
- contentId
-
string
Id/Name to identify the content submitted.
- workflowName
-
string
Workflow Name that you want to invoke.
- jobContentType
- JobContentType
The content type. Possible values include: 'application/json', 'image/jpeg'
- content
- Content
Content to evaluate.
- options
- ReviewsCreateJobOptionalParams
The optional parameters
Returns
Promise<ReviewsCreateJobResponse>
Promise<Models.ReviewsCreateJobResponse>
createJob(string, ContentType, string, string, JobContentType, Content, ReviewsCreateJobOptionalParams, ServiceCallback<JobId>)
function createJob(teamName: string, contentType: ContentType, contentId: string, workflowName: string, jobContentType: JobContentType, content: Content, options: ReviewsCreateJobOptionalParams, callback: ServiceCallback<JobId>)Parameters
- teamName
-
string
Your team name.
- contentType
- ContentType
Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'
- contentId
-
string
Id/Name to identify the content submitted.
- workflowName
-
string
Workflow Name that you want to invoke.
- jobContentType
- JobContentType
The content type. Possible values include: 'application/json', 'image/jpeg'
- content
- Content
Content to evaluate.
- options
- ReviewsCreateJobOptionalParams
The optional parameters
- callback
The callback
createJob(string, ContentType, string, string, JobContentType, Content, ServiceCallback<JobId>)
function createJob(teamName: string, contentType: ContentType, contentId: string, workflowName: string, jobContentType: JobContentType, content: Content, callback: ServiceCallback<JobId>)Parameters
- teamName
-
string
Your team name.
- contentType
- ContentType
Image, Text or Video. Possible values include: 'Image', 'Text', 'Video'
- contentId
-
string
Id/Name to identify the content submitted.
- workflowName
-
string
Workflow Name that you want to invoke.
- jobContentType
- JobContentType
The content type. Possible values include: 'application/json', 'image/jpeg'
- content
- Content
Content to evaluate.
- callback
The callback
createReviews(string, string, CreateReviewBodyItem[], ReviewsCreateReviewsOptionalParams)
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
- urlContentType
-
string
The content type.
- teamName
-
string
Your team name.
- createReviewBody
Body for create reviews API
The optional parameters
Returns
Promise<ReviewsCreateReviewsResponse>
Promise<Models.ReviewsCreateReviewsResponse>
createReviews(string, string, CreateReviewBodyItem[], ReviewsCreateReviewsOptionalParams, ServiceCallback<string[]>)
function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], options: ReviewsCreateReviewsOptionalParams, callback: ServiceCallback<string[]>)Parameters
- urlContentType
-
string
The content type.
- teamName
-
string
Your team name.
- createReviewBody
Body for create reviews API
The optional parameters
- callback
-
ServiceCallback<string[]>
The callback
createReviews(string, string, CreateReviewBodyItem[], ServiceCallback<string[]>)
function createReviews(urlContentType: string, teamName: string, createReviewBody: CreateReviewBodyItem[], callback: ServiceCallback<string[]>)Parameters
- urlContentType
-
string
The content type.
- teamName
-
string
Your team name.
- createReviewBody
Body for create reviews API
- callback
-
ServiceCallback<string[]>
The callback
createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ReviewsCreateVideoReviewsOptionalParams)
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
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- createVideoReviewsBody
Body for create reviews API
The optional parameters
Returns
Promise<ReviewsCreateVideoReviewsResponse>
Promise<Models.ReviewsCreateVideoReviewsResponse>
createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ReviewsCreateVideoReviewsOptionalParams, ServiceCallback<string[]>)
function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], options: ReviewsCreateVideoReviewsOptionalParams, callback: ServiceCallback<string[]>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- createVideoReviewsBody
Body for create reviews API
The optional parameters
- callback
-
ServiceCallback<string[]>
The callback
createVideoReviews(string, string, CreateVideoReviewsBodyItem[], ServiceCallback<string[]>)
function createVideoReviews(contentType: string, teamName: string, createVideoReviewsBody: CreateVideoReviewsBodyItem[], callback: ServiceCallback<string[]>)Parameters
- contentType
-
string
The content type.
- teamName
-
string
Your team name.
- createVideoReviewsBody
Body for create reviews API
- callback
-
ServiceCallback<string[]>
The callback
getJobDetails(string, string, RequestOptionsBase)
Get the Job Details for a Job Id.
function getJobDetails(teamName: string, jobId: string, options?: RequestOptionsBase): Promise<ReviewsGetJobDetailsResponse>Parameters
- teamName
-
string
Your Team Name.
- jobId
-
string
Id of the job.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ReviewsGetJobDetailsResponse>
Promise<Models.ReviewsGetJobDetailsResponse>
getJobDetails(string, string, RequestOptionsBase, ServiceCallback<Job>)
function getJobDetails(teamName: string, jobId: string, options: RequestOptionsBase, callback: ServiceCallback<Job>)Parameters
- teamName
-
string
Your Team Name.
- jobId
-
string
Id of the job.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getJobDetails(string, string, ServiceCallback<Job>)
function getJobDetails(teamName: string, jobId: string, callback: ServiceCallback<Job>)Parameters
- teamName
-
string
Your Team Name.
- jobId
-
string
Id of the job.
- callback
The callback
getReview(string, string, RequestOptionsBase)
Returns review details for the review Id passed.
function getReview(teamName: string, reviewId: string, options?: RequestOptionsBase): Promise<ReviewsGetReviewResponse>Parameters
- teamName
-
string
Your Team Name.
- reviewId
-
string
Id of the review.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ReviewsGetReviewResponse>
Promise<Models.ReviewsGetReviewResponse>
getReview(string, string, RequestOptionsBase, ServiceCallback<Review>)
function getReview(teamName: string, reviewId: string, options: RequestOptionsBase, callback: ServiceCallback<Review>)Parameters
- teamName
-
string
Your Team Name.
- reviewId
-
string
Id of the review.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
getReview(string, string, ServiceCallback<Review>)
function getReview(teamName: string, reviewId: string, callback: ServiceCallback<Review>)Parameters
- teamName
-
string
Your Team Name.
- reviewId
-
string
Id of the review.
- callback
The callback
getVideoFrames(string, string, ReviewsGetVideoFramesOptionalParams)
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
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
The optional parameters
Returns
Promise<ReviewsGetVideoFramesResponse>
Promise<Models.ReviewsGetVideoFramesResponse>
getVideoFrames(string, string, ReviewsGetVideoFramesOptionalParams, ServiceCallback<Frames>)
function getVideoFrames(teamName: string, reviewId: string, options: ReviewsGetVideoFramesOptionalParams, callback: ServiceCallback<Frames>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
The optional parameters
- callback
The callback
getVideoFrames(string, string, ServiceCallback<Frames>)
function getVideoFrames(teamName: string, reviewId: string, callback: ServiceCallback<Frames>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- callback
The callback
publishVideoReview(string, string, RequestOptionsBase)
Publish video review to make it available for review.
function publishVideoReview(teamName: string, reviewId: string, options?: RequestOptionsBase): Promise<RestResponse>Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
publishVideoReview(string, string, RequestOptionsBase, ServiceCallback<void>)
function publishVideoReview(teamName: string, reviewId: string, options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- options
- RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
publishVideoReview(string, string, ServiceCallback<void>)
function publishVideoReview(teamName: string, reviewId: string, callback: ServiceCallback<void>)Parameters
- teamName
-
string
Your team name.
- reviewId
-
string
Id of the review.
- callback
-
ServiceCallback<void>
The callback