ImageModeration class
Class representing a ImageModeration.
Constructors
| Image |
Create a ImageModeration. |
Methods
Constructor Details
ImageModeration(ContentModeratorClientContext)
Create a ImageModeration.
new ImageModeration(client: ContentModeratorClientContext)Parameters
Reference to the service client.
Method Details
evaluateFileInput(HttpRequestBody, ImageModerationEvaluateFileInputOptionalParams)
Returns probabilities of the image containing racy or adult content.
function evaluateFileInput(imageStream: HttpRequestBody, options?: ImageModerationEvaluateFileInputOptionalParams): Promise<ImageModerationEvaluateFileInputResponse>Parameters
- imageStream
- HttpRequestBody
The image file.
The optional parameters
Returns
Promise<Models.ImageModerationEvaluateFileInputResponse>
evaluateFileInput(HttpRequestBody, ImageModerationEvaluateFileInputOptionalParams, ServiceCallback<Evaluate>)
function evaluateFileInput(imageStream: HttpRequestBody, options: ImageModerationEvaluateFileInputOptionalParams, callback: ServiceCallback<Evaluate>)Parameters
- imageStream
- HttpRequestBody
The image file.
The optional parameters
- callback
The callback
evaluateFileInput(HttpRequestBody, ServiceCallback<Evaluate>)
function evaluateFileInput(imageStream: HttpRequestBody, callback: ServiceCallback<Evaluate>)Parameters
- imageStream
- HttpRequestBody
The image file.
- callback
The callback
evaluateMethod(ImageModerationEvaluateMethodOptionalParams)
Returns probabilities of the image containing racy or adult content.
function evaluateMethod(options?: ImageModerationEvaluateMethodOptionalParams): Promise<ImageModerationEvaluateMethodResponse>Parameters
The optional parameters
Returns
Promise<Models.ImageModerationEvaluateMethodResponse>
evaluateMethod(ImageModerationEvaluateMethodOptionalParams, ServiceCallback<Evaluate>)
function evaluateMethod(options: ImageModerationEvaluateMethodOptionalParams, callback: ServiceCallback<Evaluate>)Parameters
The optional parameters
- callback
The callback
evaluateMethod(ServiceCallback<Evaluate>)
function evaluateMethod(callback: ServiceCallback<Evaluate>)Parameters
- callback
The callback
evaluateUrlInput(string, ImageUrl, ImageModerationEvaluateUrlInputOptionalParams)
Returns probabilities of the image containing racy or adult content.
function evaluateUrlInput(contentType: string, imageUrl: ImageUrl, options?: ImageModerationEvaluateUrlInputOptionalParams): Promise<ImageModerationEvaluateUrlInputResponse>Parameters
- contentType
-
string
The content type.
- imageUrl
- ImageUrl
The image url.
The optional parameters
Returns
Promise<Models.ImageModerationEvaluateUrlInputResponse>
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.
The optional parameters
- callback
The callback
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
The callback
findFaces(ImageModerationFindFacesOptionalParams)
Returns the list of faces found.
function findFaces(options?: ImageModerationFindFacesOptionalParams): Promise<ImageModerationFindFacesResponse>Parameters
The optional parameters
Returns
Promise<ImageModerationFindFacesResponse>
Promise<Models.ImageModerationFindFacesResponse>
findFaces(ImageModerationFindFacesOptionalParams, ServiceCallback<FoundFaces>)
function findFaces(options: ImageModerationFindFacesOptionalParams, callback: ServiceCallback<FoundFaces>)Parameters
The optional parameters
- callback
The callback
findFaces(ServiceCallback<FoundFaces>)
function findFaces(callback: ServiceCallback<FoundFaces>)Parameters
- callback
The callback
findFacesFileInput(HttpRequestBody, ImageModerationFindFacesFileInputOptionalParams)
Returns the list of faces found.
function findFacesFileInput(imageStream: HttpRequestBody, options?: ImageModerationFindFacesFileInputOptionalParams): Promise<ImageModerationFindFacesFileInputResponse>Parameters
- imageStream
- HttpRequestBody
The image file.
The optional parameters
Returns
Promise<Models.ImageModerationFindFacesFileInputResponse>
findFacesFileInput(HttpRequestBody, ImageModerationFindFacesFileInputOptionalParams, ServiceCallback<FoundFaces>)
function findFacesFileInput(imageStream: HttpRequestBody, options: ImageModerationFindFacesFileInputOptionalParams, callback: ServiceCallback<FoundFaces>)Parameters
- imageStream
- HttpRequestBody
The image file.
The optional parameters
- callback
The callback
findFacesFileInput(HttpRequestBody, ServiceCallback<FoundFaces>)
function findFacesFileInput(imageStream: HttpRequestBody, callback: ServiceCallback<FoundFaces>)Parameters
- imageStream
- HttpRequestBody
The image file.
- callback
The callback
findFacesUrlInput(string, ImageUrl, ImageModerationFindFacesUrlInputOptionalParams)
Returns the list of faces found.
function findFacesUrlInput(contentType: string, imageUrl: ImageUrl, options?: ImageModerationFindFacesUrlInputOptionalParams): Promise<ImageModerationFindFacesUrlInputResponse>Parameters
- contentType
-
string
The content type.
- imageUrl
- ImageUrl
The image url.
The optional parameters
Returns
Promise<Models.ImageModerationFindFacesUrlInputResponse>
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.
The optional parameters
- callback
The callback
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
The callback
matchFileInput(HttpRequestBody, 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: HttpRequestBody, options?: ImageModerationMatchFileInputOptionalParams): Promise<ImageModerationMatchFileInputResponse>Parameters
- imageStream
- HttpRequestBody
The image file.
The optional parameters
Returns
Promise<Models.ImageModerationMatchFileInputResponse>
matchFileInput(HttpRequestBody, ImageModerationMatchFileInputOptionalParams, ServiceCallback<MatchResponse>)
function matchFileInput(imageStream: HttpRequestBody, options: ImageModerationMatchFileInputOptionalParams, callback: ServiceCallback<MatchResponse>)Parameters
- imageStream
- HttpRequestBody
The image file.
The optional parameters
- callback
The callback
matchFileInput(HttpRequestBody, ServiceCallback<MatchResponse>)
function matchFileInput(imageStream: HttpRequestBody, callback: ServiceCallback<MatchResponse>)Parameters
- imageStream
- HttpRequestBody
The image file.
- callback
The callback
matchMethod(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?: ImageModerationMatchMethodOptionalParams): Promise<ImageModerationMatchMethodResponse>Parameters
The optional parameters
Returns
Promise<ImageModerationMatchMethodResponse>
Promise<Models.ImageModerationMatchMethodResponse>
matchMethod(ImageModerationMatchMethodOptionalParams, ServiceCallback<MatchResponse>)
function matchMethod(options: ImageModerationMatchMethodOptionalParams, callback: ServiceCallback<MatchResponse>)Parameters
The optional parameters
- callback
The callback
matchMethod(ServiceCallback<MatchResponse>)
function matchMethod(callback: ServiceCallback<MatchResponse>)Parameters
- callback
The callback
matchUrlInput(string, ImageUrl, 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?: ImageModerationMatchUrlInputOptionalParams): Promise<ImageModerationMatchUrlInputResponse>Parameters
- contentType
-
string
The content type.
- imageUrl
- ImageUrl
The image url.
The optional parameters
Returns
Promise<ImageModerationMatchUrlInputResponse>
Promise<Models.ImageModerationMatchUrlInputResponse>
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.
The optional parameters
- callback
The callback
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
The callback
oCRFileInput(string, HttpRequestBody, 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: HttpRequestBody, options?: ImageModerationOCRFileInputOptionalParams): Promise<ImageModerationOCRFileInputResponse>Parameters
- language
-
string
Language of the terms.
- imageStream
- HttpRequestBody
The image file.
The optional parameters
Returns
Promise<ImageModerationOCRFileInputResponse>
Promise<Models.ImageModerationOCRFileInputResponse>
oCRFileInput(string, HttpRequestBody, ImageModerationOCRFileInputOptionalParams, ServiceCallback<OCR>)
function oCRFileInput(language: string, imageStream: HttpRequestBody, options: ImageModerationOCRFileInputOptionalParams, callback: ServiceCallback<OCR>)Parameters
- language
-
string
Language of the terms.
- imageStream
- HttpRequestBody
The image file.
The optional parameters
- callback
The callback
oCRFileInput(string, HttpRequestBody, ServiceCallback<OCR>)
function oCRFileInput(language: string, imageStream: HttpRequestBody, callback: ServiceCallback<OCR>)Parameters
- language
-
string
Language of the terms.
- imageStream
- HttpRequestBody
The image file.
- callback
The callback
oCRMethod(string, 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?: ImageModerationOCRMethodOptionalParams): Promise<ImageModerationOCRMethodResponse>Parameters
- language
-
string
Language of the terms.
The optional parameters
Returns
Promise<ImageModerationOCRMethodResponse>
Promise<Models.ImageModerationOCRMethodResponse>
oCRMethod(string, ImageModerationOCRMethodOptionalParams, ServiceCallback<OCR>)
function oCRMethod(language: string, options: ImageModerationOCRMethodOptionalParams, callback: ServiceCallback<OCR>)Parameters
- language
-
string
Language of the terms.
The optional parameters
- callback
The callback
oCRMethod(string, ServiceCallback<OCR>)
function oCRMethod(language: string, callback: ServiceCallback<OCR>)Parameters
- language
-
string
Language of the terms.
- callback
The callback
oCRUrlInput(string, string, ImageUrl, 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?: ImageModerationOCRUrlInputOptionalParams): Promise<ImageModerationOCRUrlInputResponse>Parameters
- language
-
string
Language of the terms.
- contentType
-
string
The content type.
- imageUrl
- ImageUrl
The image url.
The optional parameters
Returns
Promise<ImageModerationOCRUrlInputResponse>
Promise<Models.ImageModerationOCRUrlInputResponse>
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.
The optional parameters
- callback
The callback
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
The callback