C# Class BuildIt.CognitiveServices.ContentModeratorReviewExtensions

Extension methods for ContentModeratorReview.

Datei anzeigen Open project: builttoroam/BuildIt

Public Methods

Method	Description
JobCreate ( this operations, string teamName, string contentId, string workflowName, string callBackEndpoint = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	A job Id will be returned for the Image 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. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "<Job Id>,<br/> "ReviewId": "<Review Id, if the Job resulted in a Review to be created>",<br/> "WorkFlowId": "default",<br/> "Status": "<This will be one of Complete, InProgress, Error>",<br/> "ContentType": "Image",<br/> "ContentId": "<This is the ContentId that was specified on input>",<br/> "CallBackType": "Job",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "<Review Id>",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "<Name of the Reviewer>",<br/> "CallBackType": "Review",<br/> "ContentId": "<The ContentId that was specified input>",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>
JobCreateAsync ( this operations, string teamName, string contentId, string workflowName, string callBackEndpoint = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	A job Id will be returned for the Image 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. <h3>CallBack Schemas </h3> <p> <h4>Job Completion CallBack Sample</h4><br/> {<br/> "JobId": "<Job Id>,<br/> "ReviewId": "<Review Id, if the Job resulted in a Review to be created>",<br/> "WorkFlowId": "default",<br/> "Status": "<This will be one of Complete, InProgress, Error>",<br/> "ContentType": "Image",<br/> "ContentId": "<This is the ContentId that was specified on input>",<br/> "CallBackType": "Job",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> }<br/> }<br/> </p> <p> <h4>Review Completion CallBack Sample</h4><br/> { "ReviewId": "<Review Id>",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "<Name of the Reviewer>",<br/> "CallBackType": "Review",<br/> "ContentId": "<The ContentId that was specified input>",<br/> "Metadata": {<br/> "adultscore": "0.xxx", "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>
JobGet ( this operations, string teamName, string jobId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Get the Job Details for a Job Id.
JobGetAsync ( this operations, string teamName, string jobId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Get the Job Details for a Job Id.
ReviewCreate ( this operations, string teamName, string subTeam = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	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. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "<Review Id>",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "<Name of the Reviewer>",<br/> "CallBackType": "Review",<br/> "ContentId": "<The ContentId that was specified input>",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>
ReviewCreateAsync ( this operations, string teamName, string subTeam = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	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. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> <p> {<br/> "ReviewId": "<Review Id>",<br/> "ModifiedOn": "2016-10-11T22:36:32.9934851Z",<br/> "ModifiedBy": "<Name of the Reviewer>",<br/> "CallBackType": "Review",<br/> "ContentId": "<The ContentId that was specified input>",<br/> "Metadata": {<br/> "adultscore": "0.xxx",<br/> "a": "False",<br/> "racyscore": "0.xxx",<br/> "r": "True"<br/> },<br/> "ReviewerResultTags": {<br/> "a": "False",<br/> "r": "True"<br/> }<br/> }<br/> </p>
ReviewGet ( this operations, string teamName, string reviewId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Returns review details for the review Id passed.
ReviewGetAsync ( this operations, string teamName, string reviewId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Returns review details for the review Id passed.
WorkflowCreateOrUpdate ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Create a new workflow or update an existing one.
WorkflowCreateOrUpdateAsync ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Create a new workflow or update an existing one.
WorkflowGet ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Get the details of a specific Workflow on your Team
WorkflowGetAll ( this operations, string team, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void	Get all the Workflows available for you Team
WorkflowGetAllAsync ( this operations, string team, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Get all the Workflows available for you Team
WorkflowGetAsync ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task	Get the details of a specific Workflow on your Team

Method Details

JobCreate() public static method

A job Id will be returned for the Image 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. <h3>CallBack Schemas </h3> <h4>Job Completion CallBack Sample</h4> { "JobId": "<Job Id>, "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": "<This is the ContentId that was specified on input>", "CallBackType": "Job", "Metadata": { "adultscore": "0.xxx", "a": "False", "racyscore": "0.xxx", "r": "True" } } <h4>Review Completion CallBack Sample</h4> { "ReviewId": "<Review Id>", "ModifiedOn": "2016-10-11T22:36:32.9934851Z", "ModifiedBy": "<Name of the Reviewer>", "CallBackType": "Review", "ContentId": "<The ContentId that was specified input>", "Metadata": { "adultscore": "0.xxx", "a": "False", "racyscore": "0.xxx", "r": "True" }, "ReviewerResultTags": { "a": "False", "r": "True" } }

public static JobCreate ( this operations, string teamName, string contentId, string workflowName, string callBackEndpoint = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
teamName	string	/// Your team name ///
contentId	string	/// Content Id/Name ///
workflowName	string	/// Workflow Name, if left empty your teams default workflow would be used ///
callBackEndpoint	string	/// Callback endpoint for posting the reviews result. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

JobCreateAsync() public static method

public static JobCreateAsync ( this operations, string teamName, string contentId, string workflowName, string callBackEndpoint = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
teamName	string	/// Your team name ///
contentId	string	/// Content Id/Name ///
workflowName	string	/// Workflow Name, if left empty your teams default workflow would be used ///
callBackEndpoint	string	/// Callback endpoint for posting the reviews result. ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

JobGet() public static method

Get the Job Details for a Job Id.

public static JobGet ( this operations, string teamName, string jobId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
teamName	string	///
jobId	string	///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

JobGetAsync() public static method

Get the Job Details for a Job Id.

public static JobGetAsync ( this operations, string teamName, string jobId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
teamName	string	///
jobId	string	///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

ReviewCreate() public static method

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. <h3>CallBack Schemas </h3> <h4>Review Completion CallBack Sample</h4> { "ReviewId": "<Review Id>", "ModifiedOn": "2016-10-11T22:36:32.9934851Z", "ModifiedBy": "<Name of the Reviewer>", "CallBackType": "Review", "ContentId": "<The ContentId that was specified input>", "Metadata": { "adultscore": "0.xxx", "a": "False", "racyscore": "0.xxx", "r": "True" }, "ReviewerResultTags": { "a": "False", "r": "True" } }

public static ReviewCreate ( this operations, string teamName, string subTeam = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
teamName	string	/// Your Team Name ///
subTeam	string	/// Optional paramter used to specify the Sub Team for this review ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

ReviewCreateAsync() public static method

public static ReviewCreateAsync ( this operations, string teamName, string subTeam = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
teamName	string	/// Your Team Name ///
subTeam	string	/// Optional paramter used to specify the Sub Team for this review ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

ReviewGet() public static method

Returns review details for the review Id passed.

public static ReviewGet ( this operations, string teamName, string reviewId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
teamName	string	///
reviewId	string	///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

ReviewGetAsync() public static method

Returns review details for the review Id passed.

public static ReviewGetAsync ( this operations, string teamName, string reviewId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
teamName	string	///
reviewId	string	///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

WorkflowCreateOrUpdate() public static method

Create a new workflow or update an existing one.

public static WorkflowCreateOrUpdate ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
team	string	/// Your Team name ///
workflowname	string	/// Provide a name for this workflow ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

WorkflowCreateOrUpdateAsync() public static method

Create a new workflow or update an existing one.

public static WorkflowCreateOrUpdateAsync ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
team	string	/// Your Team name ///
workflowname	string	/// Provide a name for this workflow ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

WorkflowGet() public static method

Get the details of a specific Workflow on your Team

public static WorkflowGet ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
team	string	/// Your Team name ///
workflowname	string	/// Provide a name for this workflow ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

WorkflowGetAll() public static method

Get all the Workflows available for you Team

public static WorkflowGetAll ( this operations, string team, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void
operations	this	/// The operations group for this extension method. ///
team	string	/// Your Team name ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
return	void

WorkflowGetAllAsync() public static method

Get all the Workflows available for you Team

public static WorkflowGetAllAsync ( this operations, string team, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
team	string	/// Your Team name ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task

WorkflowGetAsync() public static method

Get the details of a specific Workflow on your Team

public static WorkflowGetAsync ( this operations, string team, string workflowname, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task
operations	this	/// The operations group for this extension method. ///
team	string	/// Your Team name ///
workflowname	string	/// Provide a name for this workflow ///
subscriptionKey	string	/// subscription key in url ///
ocpApimSubscriptionKey	string	/// subscription key in header ///
cancellationToken	System	/// The cancellation token. ///
return	System.Threading.Tasks.Task