Share via

ImageModerationOCRMethodOptionalParams interface

Package:
@azure/cognitiveservices-contentmoderator

Optional Parameters.

Extends
RequestOptionsBase

Properties

cacheImage

Whether to retain the submitted image for future use; defaults to false if omitted.
enhanced

When set to True, the image goes through additional processing to come with additional candidates.

image/tiff is not supported when enhanced is set to true

Note: This impacts the response time. Default value: false.

Inherited Properties

abortSignal

The signal which can be used to abort requests.
customHeaders

User defined custom request headers that will be applied before the request is sent.
onDownloadProgress

Callback which fires upon download progress.
onUploadProgress

Callback which fires upon upload progress.
timeout

The number of milliseconds a request can take before automatically being terminated.

Property Details

cacheImage

Whether to retain the submitted image for future use; defaults to false if omitted.

cacheImage?: boolean

Property Value

boolean

enhanced

When set to True, the image goes through additional processing to come with additional candidates.

image/tiff is not supported when enhanced is set to true

Note: This impacts the response time. Default value: false.

enhanced?: boolean

Property Value

boolean

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From msRest.RequestOptionsBase.abortSignal

customHeaders

User defined custom request headers that will be applied before the request is sent.

customHeaders?: {[key: string]: string}

Property Value

{[key: string]: string}

Inherited From msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

Inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

The number of milliseconds a request can take before automatically being terminated.

timeout?: number

Property Value

number

Inherited From msRest.RequestOptionsBase.timeout