تحرير

ImageModerationOCRFileInputOptionalParams interface

  • Reference
Package:
@azure/cognitiveservices-contentmoderator

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal

The signal which can be used to abort requests.
cacheImage

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

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.
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.
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

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

cacheImage

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

cacheImage?: undefined | false | true

Property Value

undefined | false | true

customHeaders

{object} [customHeaders] User defined custom request headers that will be applied before the request is sent.

customHeaders?: undefined | [key: string]: string

Property Value

undefined | [key: string]: string

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?: undefined | false | true

Property Value

undefined | false | true

onDownloadProgress

Callback which fires upon download progress.

onDownloadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

onUploadProgress

Callback which fires upon upload progress.

onUploadProgress?: undefined | (progress: TransferProgressEvent) => void

Property Value

undefined | (progress: TransferProgressEvent) => void

timeout

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

timeout?: undefined | number

Property Value

undefined | number