LargeFaceListListOptionalParams interface

Package:

@azure/cognitiveservices-face

Optional Parameters.

Extends

RequestOptionsBase

Properties

returnRecognitionModel	A value indicating whether the operation should return 'recognitionModel' in response. Default value: false.
start	Starting large face list id to return (used to list a range of large face lists).
top	Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.

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

returnRecognitionModel

A value indicating whether the operation should return 'recognitionModel' in response. Default value: false.

returnRecognitionModel?: boolean

Property Value

boolean

start

Starting large face list id to return (used to list a range of large face lists).

start?: string

Property Value

string

top

Number of large face lists to return starting with the large face list id indicated by the 'start' parameter.

top?: number

Property Value

number

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