TextModerationScreenTextOptionalParams interface

Optional Parameters.

Extends

RequestOptionsBase

Properties

abortSignal

The signal which can be used to abort requests.

autocorrect

Autocorrect text. Default value: false.

classify

Classify input. Default value: false.

customHeaders

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

language

Language of the text.

listId

The list Id.

onDownloadProgress

Callback which fires upon download progress.

onUploadProgress

Callback which fires upon upload progress.

pII

Detect personal identifiable information. Default value: false.

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

autocorrect

Autocorrect text. Default value: false.

autocorrect?: undefined | false | true

Property Value

undefined | false | true

classify

Classify input. Default value: false.

classify?: 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

language

Language of the text.

language?: undefined | string

Property Value

undefined | string

listId

The list Id.

listId?: undefined | string

Property Value

undefined | string

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

pII

Detect personal identifiable information. Default value: false.

pII?: undefined | false | true

Property Value

undefined | false | true

timeout

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

timeout?: undefined | number

Property Value

undefined | number