TextModeration class

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Package:

@azure/cognitiveservices-contentmoderator

Class representing a TextModeration.

Constructors

TextModeration(ContentModeratorClientContext)

Create a TextModeration.

Methods

detectLanguage(Models.TextContentType1, msRest.HttpRequestBody, msRest.RequestOptionsBase)	This operation will detect the language of given input content. Returns the ISO 639-3 code for the predominant language comprising the submitted text. Over 110 languages supported.
detectLanguage(Models.TextContentType1, msRest.HttpRequestBody, RequestOptionsBase, ServiceCallback<DetectedLanguage>)
detectLanguage(Models.TextContentType1, msRest.HttpRequestBody, ServiceCallback<DetectedLanguage>)
screenText(Models.TextContentType, msRest.HttpRequestBody, Models.TextModerationScreenTextOptionalParams)	Detects profanity in more than 100 languages and match against custom and shared blacklists.
screenText(Models.TextContentType, msRest.HttpRequestBody, ServiceCallback<Screen>)
screenText(Models.TextContentType, msRest.HttpRequestBody, TextModerationScreenTextOptionalParams, ServiceCallback<Screen>)

Constructor Details

TextModeration(ContentModeratorClientContext)

Create a TextModeration.

new TextModeration(client: ContentModeratorClientContext)

Parameters

client

ContentModeratorClientContext

Reference to the service client.

Method Details

detectLanguage(Models.TextContentType1, msRest.HttpRequestBody, msRest.RequestOptionsBase)

This operation will detect the language of given input content. Returns the ISO 639-3 code for the predominant language comprising the submitted text. Over 110 languages supported.

function detectLanguage(textContentType: Models.TextContentType1, textContent: msRest.HttpRequestBody, options?: msRest.RequestOptionsBase): Promise<Models.TextModerationDetectLanguageResponse>

Parameters

textContentType

Models.TextContentType1

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

textContent

msRest.HttpRequestBody

Content to screen.

options

msRest.RequestOptionsBase

Returns

Promise<Models.TextModerationDetectLanguageResponse>

Promise<Models.TextModerationDetectLanguageResponse>

detectLanguage(Models.TextContentType1, msRest.HttpRequestBody, RequestOptionsBase, ServiceCallback<DetectedLanguage>)

function detectLanguage(textContentType: Models.TextContentType1, textContent: msRest.HttpRequestBody, options: RequestOptionsBase, callback: ServiceCallback<DetectedLanguage>)

Parameters

textContentType

Models.TextContentType1

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

textContent

msRest.HttpRequestBody

Content to screen.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<DetectedLanguage>

The callback

detectLanguage(Models.TextContentType1, msRest.HttpRequestBody, ServiceCallback<DetectedLanguage>)

function detectLanguage(textContentType: Models.TextContentType1, textContent: msRest.HttpRequestBody, callback: ServiceCallback<DetectedLanguage>)

Parameters

textContentType

Models.TextContentType1

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

textContent

msRest.HttpRequestBody

Content to screen.

callback

ServiceCallback<DetectedLanguage>

The callback

screenText(Models.TextContentType, msRest.HttpRequestBody, Models.TextModerationScreenTextOptionalParams)

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

function screenText(textContentType: Models.TextContentType, textContent: msRest.HttpRequestBody, options?: Models.TextModerationScreenTextOptionalParams): Promise<Models.TextModerationScreenTextResponse>

Parameters

textContentType

Models.TextContentType

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

textContent

msRest.HttpRequestBody

Content to screen.

options

Models.TextModerationScreenTextOptionalParams

Returns

Promise<Models.TextModerationScreenTextResponse>

Promise<Models.TextModerationScreenTextResponse>

screenText(Models.TextContentType, msRest.HttpRequestBody, ServiceCallback<Screen>)

function screenText(textContentType: Models.TextContentType, textContent: msRest.HttpRequestBody, callback: ServiceCallback<Screen>)

Parameters

textContentType

Models.TextContentType

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

textContent

msRest.HttpRequestBody

Content to screen.

callback

ServiceCallback<Screen>

The callback

screenText(Models.TextContentType, msRest.HttpRequestBody, TextModerationScreenTextOptionalParams, ServiceCallback<Screen>)

function screenText(textContentType: Models.TextContentType, textContent: msRest.HttpRequestBody, options: TextModerationScreenTextOptionalParams, callback: ServiceCallback<Screen>)

Parameters

textContentType

Models.TextContentType

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

textContent

msRest.HttpRequestBody

Content to screen.

options

TextModerationScreenTextOptionalParams

The optional parameters

callback

ServiceCallback<Screen>

The callback