TextModeration.ScreenTextWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.CognitiveServices.ContentModerator

Assembly:

Microsoft.Azure.CognitiveServices.ContentModerator.dll

Package:

Microsoft.Azure.CognitiveServices.ContentModerator v2.0.0

Detect profanity and match against custom and shared blacklists

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>> ScreenTextWithHttpMessagesAsync (string textContentType, System.IO.Stream textContent, string language = default, bool? autocorrect = False, bool? pII = False, string listId = default, bool? classify = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ScreenTextWithHttpMessagesAsync : string * System.IO.Stream * string * Nullable<bool> * Nullable<bool> * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>>
override this.ScreenTextWithHttpMessagesAsync : string * System.IO.Stream * string * Nullable<bool> * Nullable<bool> * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.ContentModerator.Models.Screen>>

Public Function ScreenTextWithHttpMessagesAsync (textContentType As String, textContent As Stream, Optional language As String = Nothing, Optional autocorrect As Nullable(Of Boolean) = False, Optional pII As Nullable(Of Boolean) = False, Optional listId As String = Nothing, Optional classify As Nullable(Of Boolean) = False, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of Screen))

Parameters

textContentType

String

The content type. Possible values include: 'text/plain', 'text/html', 'text/xml', 'text/markdown'

textContent

Stream

Content to screen.

language

String

Language of the text.

autocorrect

Nullable<Boolean>

Autocorrect text.

pII

Nullable<Boolean>

Detect personal identifiable information.

listId

String

The list Id.

classify

Nullable<Boolean>

Classify input.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<HttpOperationResponse<Screen>>

Implements

ScreenTextWithHttpMessagesAsync(String, Stream, String, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Dictionary<String,List<String>>, CancellationToken)

Exceptions

APIErrorException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

ArgumentNullException

Thrown when a required parameter is null

Remarks

Detects profanity in more than 100 languages and match against custom and shared blacklists.