ImageModeration 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 ImageModeration.

Constructors

ImageModeration(ContentModeratorClientContext)

Create a ImageModeration.

Methods

evaluateFileInput(msRest.HttpRequestBody, ImageModerationEvaluateFileInputOptionalParams, ServiceCallback<Evaluate>)
evaluateFileInput(msRest.HttpRequestBody, Models.ImageModerationEvaluateFileInputOptionalParams)	Returns probabilities of the image containing racy or adult content.
evaluateFileInput(msRest.HttpRequestBody, ServiceCallback<Evaluate>)
evaluateMethod(ImageModerationEvaluateMethodOptionalParams, ServiceCallback<Evaluate>)
evaluateMethod(Models.ImageModerationEvaluateMethodOptionalParams)	Returns probabilities of the image containing racy or adult content.
evaluateMethod(ServiceCallback<Evaluate>)
evaluateUrlInput(string, ImageUrl, ImageModerationEvaluateUrlInputOptionalParams, ServiceCallback<Evaluate>)
evaluateUrlInput(string, ImageUrl, Models.ImageModerationEvaluateUrlInputOptionalParams)	Returns probabilities of the image containing racy or adult content.
evaluateUrlInput(string, ImageUrl, ServiceCallback<Evaluate>)
findFaces(ImageModerationFindFacesOptionalParams, ServiceCallback<FoundFaces>)
findFaces(Models.ImageModerationFindFacesOptionalParams)	Returns the list of faces found.
findFaces(ServiceCallback<FoundFaces>)
findFacesFileInput(msRest.HttpRequestBody, ImageModerationFindFacesFileInputOptionalParams, ServiceCallback<FoundFaces>)
findFacesFileInput(msRest.HttpRequestBody, Models.ImageModerationFindFacesFileInputOptionalParams)	Returns the list of faces found.
findFacesFileInput(msRest.HttpRequestBody, ServiceCallback<FoundFaces>)
findFacesUrlInput(string, ImageUrl, ImageModerationFindFacesUrlInputOptionalParams, ServiceCallback<FoundFaces>)
findFacesUrlInput(string, ImageUrl, Models.ImageModerationFindFacesUrlInputOptionalParams)	Returns the list of faces found.
findFacesUrlInput(string, ImageUrl, ServiceCallback<FoundFaces>)
matchFileInput(msRest.HttpRequestBody, ImageModerationMatchFileInputOptionalParams, ServiceCallback<MatchResponse>)
matchFileInput(msRest.HttpRequestBody, Models.ImageModerationMatchFileInputOptionalParams)	Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using this API. Returns ID and tags of matching image. Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.
matchFileInput(msRest.HttpRequestBody, ServiceCallback<MatchResponse>)
matchMethod(ImageModerationMatchMethodOptionalParams, ServiceCallback<MatchResponse>)
matchMethod(Models.ImageModerationMatchMethodOptionalParams)	Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using this API. Returns ID and tags of matching image. Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.
matchMethod(ServiceCallback<MatchResponse>)
matchUrlInput(string, ImageUrl, ImageModerationMatchUrlInputOptionalParams, ServiceCallback<MatchResponse>)
matchUrlInput(string, ImageUrl, Models.ImageModerationMatchUrlInputOptionalParams)	Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using this API. Returns ID and tags of matching image. Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.
matchUrlInput(string, ImageUrl, ServiceCallback<MatchResponse>)
oCRFileInput(string, msRest.HttpRequestBody, ImageModerationOCRFileInputOptionalParams, ServiceCallback<OCR>)
oCRFileInput(string, msRest.HttpRequestBody, Models.ImageModerationOCRFileInputOptionalParams)	Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
oCRFileInput(string, msRest.HttpRequestBody, ServiceCallback<OCR>)
oCRMethod(string, ImageModerationOCRMethodOptionalParams, ServiceCallback<OCR>)
oCRMethod(string, Models.ImageModerationOCRMethodOptionalParams)	Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
oCRMethod(string, ServiceCallback<OCR>)
oCRUrlInput(string, string, ImageUrl, ImageModerationOCRUrlInputOptionalParams, ServiceCallback<OCR>)
oCRUrlInput(string, string, ImageUrl, Models.ImageModerationOCRUrlInputOptionalParams)	Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.
oCRUrlInput(string, string, ImageUrl, ServiceCallback<OCR>)

Constructor Details

ImageModeration(ContentModeratorClientContext)

Create a ImageModeration.

new ImageModeration(client: ContentModeratorClientContext)

Parameters

client

ContentModeratorClientContext

Reference to the service client.

Method Details

evaluateFileInput(msRest.HttpRequestBody, ImageModerationEvaluateFileInputOptionalParams, ServiceCallback<Evaluate>)

function evaluateFileInput(imageStream: msRest.HttpRequestBody, options: ImageModerationEvaluateFileInputOptionalParams, callback: ServiceCallback<Evaluate>)

Parameters

imageStream

msRest.HttpRequestBody

The image file.

options

ImageModerationEvaluateFileInputOptionalParams

The optional parameters

callback

ServiceCallback<Evaluate>

The callback

evaluateFileInput(msRest.HttpRequestBody, Models.ImageModerationEvaluateFileInputOptionalParams)

Returns probabilities of the image containing racy or adult content.

function evaluateFileInput(imageStream: msRest.HttpRequestBody, options?: Models.ImageModerationEvaluateFileInputOptionalParams): Promise<Models.ImageModerationEvaluateFileInputResponse>

Parameters

imageStream

msRest.HttpRequestBody

The image file.

options

Models.ImageModerationEvaluateFileInputOptionalParams

Returns

Promise<Models.ImageModerationEvaluateFileInputResponse>

Promise<Models.ImageModerationEvaluateFileInputResponse>

evaluateFileInput(msRest.HttpRequestBody, ServiceCallback<Evaluate>)

function evaluateFileInput(imageStream: msRest.HttpRequestBody, callback: ServiceCallback<Evaluate>)

Parameters

imageStream

msRest.HttpRequestBody

The image file.

callback

ServiceCallback<Evaluate>

The callback

evaluateMethod(ImageModerationEvaluateMethodOptionalParams, ServiceCallback<Evaluate>)

function evaluateMethod(options: ImageModerationEvaluateMethodOptionalParams, callback: ServiceCallback<Evaluate>)

Parameters

options

ImageModerationEvaluateMethodOptionalParams

The optional parameters

callback

ServiceCallback<Evaluate>

The callback

evaluateMethod(Models.ImageModerationEvaluateMethodOptionalParams)

Returns probabilities of the image containing racy or adult content.

function evaluateMethod(options?: Models.ImageModerationEvaluateMethodOptionalParams): Promise<Models.ImageModerationEvaluateMethodResponse>

Parameters

options

Models.ImageModerationEvaluateMethodOptionalParams

Returns

Promise<Models.ImageModerationEvaluateMethodResponse>

Promise<Models.ImageModerationEvaluateMethodResponse>

evaluateMethod(ServiceCallback<Evaluate>)

function evaluateMethod(callback: ServiceCallback<Evaluate>)

Parameters

callback

ServiceCallback<Evaluate>

The callback

evaluateUrlInput(string, ImageUrl, ImageModerationEvaluateUrlInputOptionalParams, ServiceCallback<Evaluate>)

function evaluateUrlInput(contentType: string, imageUrl: ImageUrl, options: ImageModerationEvaluateUrlInputOptionalParams, callback: ServiceCallback<Evaluate>)

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

ImageModerationEvaluateUrlInputOptionalParams

The optional parameters

callback

ServiceCallback<Evaluate>

The callback

evaluateUrlInput(string, ImageUrl, Models.ImageModerationEvaluateUrlInputOptionalParams)

Returns probabilities of the image containing racy or adult content.

function evaluateUrlInput(contentType: string, imageUrl: ImageUrl, options?: Models.ImageModerationEvaluateUrlInputOptionalParams): Promise<Models.ImageModerationEvaluateUrlInputResponse>

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

Models.ImageModerationEvaluateUrlInputOptionalParams

Returns

Promise<Models.ImageModerationEvaluateUrlInputResponse>

Promise<Models.ImageModerationEvaluateUrlInputResponse>

evaluateUrlInput(string, ImageUrl, ServiceCallback<Evaluate>)

function evaluateUrlInput(contentType: string, imageUrl: ImageUrl, callback: ServiceCallback<Evaluate>)

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

callback

ServiceCallback<Evaluate>

The callback

findFaces(ImageModerationFindFacesOptionalParams, ServiceCallback<FoundFaces>)

function findFaces(options: ImageModerationFindFacesOptionalParams, callback: ServiceCallback<FoundFaces>)

Parameters

options

ImageModerationFindFacesOptionalParams

The optional parameters

callback

ServiceCallback<FoundFaces>

The callback

findFaces(Models.ImageModerationFindFacesOptionalParams)

Returns the list of faces found.

function findFaces(options?: Models.ImageModerationFindFacesOptionalParams): Promise<Models.ImageModerationFindFacesResponse>

Parameters

options

Models.ImageModerationFindFacesOptionalParams

Returns

Promise<Models.ImageModerationFindFacesResponse>

Promise<Models.ImageModerationFindFacesResponse>

findFaces(ServiceCallback<FoundFaces>)

function findFaces(callback: ServiceCallback<FoundFaces>)

Parameters

callback

ServiceCallback<FoundFaces>

The callback

findFacesFileInput(msRest.HttpRequestBody, ImageModerationFindFacesFileInputOptionalParams, ServiceCallback<FoundFaces>)

function findFacesFileInput(imageStream: msRest.HttpRequestBody, options: ImageModerationFindFacesFileInputOptionalParams, callback: ServiceCallback<FoundFaces>)

Parameters

imageStream

msRest.HttpRequestBody

The image file.

options

ImageModerationFindFacesFileInputOptionalParams

The optional parameters

callback

ServiceCallback<FoundFaces>

The callback

findFacesFileInput(msRest.HttpRequestBody, Models.ImageModerationFindFacesFileInputOptionalParams)

Returns the list of faces found.

function findFacesFileInput(imageStream: msRest.HttpRequestBody, options?: Models.ImageModerationFindFacesFileInputOptionalParams): Promise<Models.ImageModerationFindFacesFileInputResponse>

Parameters

imageStream

msRest.HttpRequestBody

The image file.

options

Models.ImageModerationFindFacesFileInputOptionalParams

Returns

Promise<Models.ImageModerationFindFacesFileInputResponse>

Promise<Models.ImageModerationFindFacesFileInputResponse>

findFacesFileInput(msRest.HttpRequestBody, ServiceCallback<FoundFaces>)

function findFacesFileInput(imageStream: msRest.HttpRequestBody, callback: ServiceCallback<FoundFaces>)

Parameters

imageStream

msRest.HttpRequestBody

The image file.

callback

ServiceCallback<FoundFaces>

The callback

findFacesUrlInput(string, ImageUrl, ImageModerationFindFacesUrlInputOptionalParams, ServiceCallback<FoundFaces>)

function findFacesUrlInput(contentType: string, imageUrl: ImageUrl, options: ImageModerationFindFacesUrlInputOptionalParams, callback: ServiceCallback<FoundFaces>)

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

ImageModerationFindFacesUrlInputOptionalParams

The optional parameters

callback

ServiceCallback<FoundFaces>

The callback

findFacesUrlInput(string, ImageUrl, Models.ImageModerationFindFacesUrlInputOptionalParams)

Returns the list of faces found.

function findFacesUrlInput(contentType: string, imageUrl: ImageUrl, options?: Models.ImageModerationFindFacesUrlInputOptionalParams): Promise<Models.ImageModerationFindFacesUrlInputResponse>

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

Models.ImageModerationFindFacesUrlInputOptionalParams

Returns

Promise<Models.ImageModerationFindFacesUrlInputResponse>

Promise<Models.ImageModerationFindFacesUrlInputResponse>

findFacesUrlInput(string, ImageUrl, ServiceCallback<FoundFaces>)

function findFacesUrlInput(contentType: string, imageUrl: ImageUrl, callback: ServiceCallback<FoundFaces>)

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

callback

ServiceCallback<FoundFaces>

The callback

matchFileInput(msRest.HttpRequestBody, ImageModerationMatchFileInputOptionalParams, ServiceCallback<MatchResponse>)

function matchFileInput(imageStream: msRest.HttpRequestBody, options: ImageModerationMatchFileInputOptionalParams, callback: ServiceCallback<MatchResponse>)

Parameters

imageStream

msRest.HttpRequestBody

The image file.

options

ImageModerationMatchFileInputOptionalParams

The optional parameters

callback

ServiceCallback<MatchResponse>

The callback

matchFileInput(msRest.HttpRequestBody, Models.ImageModerationMatchFileInputOptionalParams)

Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using this API. Returns ID and tags of matching image.

Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.

function matchFileInput(imageStream: msRest.HttpRequestBody, options?: Models.ImageModerationMatchFileInputOptionalParams): Promise<Models.ImageModerationMatchFileInputResponse>

Parameters

imageStream

msRest.HttpRequestBody

The image file.

options

Models.ImageModerationMatchFileInputOptionalParams

Returns

Promise<Models.ImageModerationMatchFileInputResponse>

Promise<Models.ImageModerationMatchFileInputResponse>

matchFileInput(msRest.HttpRequestBody, ServiceCallback<MatchResponse>)

function matchFileInput(imageStream: msRest.HttpRequestBody, callback: ServiceCallback<MatchResponse>)

Parameters

imageStream

msRest.HttpRequestBody

The image file.

callback

ServiceCallback<MatchResponse>

The callback

matchMethod(ImageModerationMatchMethodOptionalParams, ServiceCallback<MatchResponse>)

function matchMethod(options: ImageModerationMatchMethodOptionalParams, callback: ServiceCallback<MatchResponse>)

Parameters

options

ImageModerationMatchMethodOptionalParams

The optional parameters

callback

ServiceCallback<MatchResponse>

The callback

matchMethod(Models.ImageModerationMatchMethodOptionalParams)

Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using this API. Returns ID and tags of matching image.

Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.

function matchMethod(options?: Models.ImageModerationMatchMethodOptionalParams): Promise<Models.ImageModerationMatchMethodResponse>

Parameters

options

Models.ImageModerationMatchMethodOptionalParams

Returns

Promise<Models.ImageModerationMatchMethodResponse>

Promise<Models.ImageModerationMatchMethodResponse>

matchMethod(ServiceCallback<MatchResponse>)

function matchMethod(callback: ServiceCallback<MatchResponse>)

Parameters

callback

ServiceCallback<MatchResponse>

The callback

matchUrlInput(string, ImageUrl, ImageModerationMatchUrlInputOptionalParams, ServiceCallback<MatchResponse>)

function matchUrlInput(contentType: string, imageUrl: ImageUrl, options: ImageModerationMatchUrlInputOptionalParams, callback: ServiceCallback<MatchResponse>)

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

ImageModerationMatchUrlInputOptionalParams

The optional parameters

callback

ServiceCallback<MatchResponse>

The callback

matchUrlInput(string, ImageUrl, Models.ImageModerationMatchUrlInputOptionalParams)

Fuzzily match an image against one of your custom Image Lists. You can create and manage your custom image lists using this API. Returns ID and tags of matching image.

Note: Refresh Index must be run on the corresponding Image List before additions and removals are reflected in the response.

function matchUrlInput(contentType: string, imageUrl: ImageUrl, options?: Models.ImageModerationMatchUrlInputOptionalParams): Promise<Models.ImageModerationMatchUrlInputResponse>

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

Models.ImageModerationMatchUrlInputOptionalParams

Returns

Promise<Models.ImageModerationMatchUrlInputResponse>

Promise<Models.ImageModerationMatchUrlInputResponse>

matchUrlInput(string, ImageUrl, ServiceCallback<MatchResponse>)

function matchUrlInput(contentType: string, imageUrl: ImageUrl, callback: ServiceCallback<MatchResponse>)

Parameters

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

callback

ServiceCallback<MatchResponse>

The callback

oCRFileInput(string, msRest.HttpRequestBody, ImageModerationOCRFileInputOptionalParams, ServiceCallback<OCR>)

function oCRFileInput(language: string, imageStream: msRest.HttpRequestBody, options: ImageModerationOCRFileInputOptionalParams, callback: ServiceCallback<OCR>)

Parameters

language

string

Language of the terms.

imageStream

msRest.HttpRequestBody

The image file.

options

ImageModerationOCRFileInputOptionalParams

The optional parameters

callback

ServiceCallback<OCR>

The callback

oCRFileInput(string, msRest.HttpRequestBody, Models.ImageModerationOCRFileInputOptionalParams)

Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.

function oCRFileInput(language: string, imageStream: msRest.HttpRequestBody, options?: Models.ImageModerationOCRFileInputOptionalParams): Promise<Models.ImageModerationOCRFileInputResponse>

Parameters

language

string

Language of the terms.

imageStream

msRest.HttpRequestBody

The image file.

options

Models.ImageModerationOCRFileInputOptionalParams

Returns

Promise<Models.ImageModerationOCRFileInputResponse>

Promise<Models.ImageModerationOCRFileInputResponse>

oCRFileInput(string, msRest.HttpRequestBody, ServiceCallback<OCR>)

function oCRFileInput(language: string, imageStream: msRest.HttpRequestBody, callback: ServiceCallback<OCR>)

Parameters

language

string

Language of the terms.

imageStream

msRest.HttpRequestBody

The image file.

callback

ServiceCallback<OCR>

The callback

oCRMethod(string, ImageModerationOCRMethodOptionalParams, ServiceCallback<OCR>)

function oCRMethod(language: string, options: ImageModerationOCRMethodOptionalParams, callback: ServiceCallback<OCR>)

Parameters

language

string

Language of the terms.

options

ImageModerationOCRMethodOptionalParams

The optional parameters

callback

ServiceCallback<OCR>

The callback

oCRMethod(string, Models.ImageModerationOCRMethodOptionalParams)

Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.

function oCRMethod(language: string, options?: Models.ImageModerationOCRMethodOptionalParams): Promise<Models.ImageModerationOCRMethodResponse>

Parameters

language

string

Language of the terms.

options

Models.ImageModerationOCRMethodOptionalParams

Returns

Promise<Models.ImageModerationOCRMethodResponse>

Promise<Models.ImageModerationOCRMethodResponse>

oCRMethod(string, ServiceCallback<OCR>)

function oCRMethod(language: string, callback: ServiceCallback<OCR>)

Parameters

language

string

Language of the terms.

callback

ServiceCallback<OCR>

The callback

oCRUrlInput(string, string, ImageUrl, ImageModerationOCRUrlInputOptionalParams, ServiceCallback<OCR>)

function oCRUrlInput(language: string, contentType: string, imageUrl: ImageUrl, options: ImageModerationOCRUrlInputOptionalParams, callback: ServiceCallback<OCR>)

Parameters

language

string

Language of the terms.

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

ImageModerationOCRUrlInputOptionalParams

The optional parameters

callback

ServiceCallback<OCR>

The callback

oCRUrlInput(string, string, ImageUrl, Models.ImageModerationOCRUrlInputOptionalParams)

Returns any text found in the image for the language specified. If no language is specified in input then the detection defaults to English.

function oCRUrlInput(language: string, contentType: string, imageUrl: ImageUrl, options?: Models.ImageModerationOCRUrlInputOptionalParams): Promise<Models.ImageModerationOCRUrlInputResponse>

Parameters

language

string

Language of the terms.

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

options

Models.ImageModerationOCRUrlInputOptionalParams

Returns

Promise<Models.ImageModerationOCRUrlInputResponse>

Promise<Models.ImageModerationOCRUrlInputResponse>

oCRUrlInput(string, string, ImageUrl, ServiceCallback<OCR>)

function oCRUrlInput(language: string, contentType: string, imageUrl: ImageUrl, callback: ServiceCallback<OCR>)

Parameters

language

string

Language of the terms.

contentType

string

The content type.

imageUrl

ImageUrl

The image url.

callback

ServiceCallback<OCR>

The callback