FaceModels.LargePersonGroupGetOptionalParams.yml

### YamlMime:TSType
name: LargePersonGroupGetOptionalParams
uid: '@azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams'
package: '@azure/cognitiveservices-face'
summary: Optional Parameters.
fullName: LargePersonGroupGetOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: returnRecognitionModel
    uid: >-
      @azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams.returnRecognitionModel
    package: '@azure/cognitiveservices-face'
    summary: >-
      A value indicating whether the operation should return 'recognitionModel'
      in response. Default

      value: false.
    fullName: returnRecognitionModel
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'returnRecognitionModel?: boolean'
      return:
        description: ''
        type: boolean
inheritedProperties:
  - name: abortSignal
    uid: >-
      @azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams.abortSignal
    package: '@azure/cognitiveservices-face'
    summary: The signal which can be used to abort requests.
    fullName: abortSignal
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.AbortSignalLike" />
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.abortSignal
  - name: customHeaders
    uid: >-
      @azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams.customHeaders
    package: '@azure/cognitiveservices-face'
    summary: |-
      User defined custom request headers that
      will be applied before the request is sent.
    fullName: customHeaders
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customHeaders?: {[key: string]: string}'
      return:
        description: ''
        type: '{[key: string]: string}'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.customHeaders
  - name: onDownloadProgress
    uid: >-
      @azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams.onDownloadProgress
    package: '@azure/cognitiveservices-face'
    summary: Callback which fires upon download progress.
    fullName: onDownloadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onDownloadProgress
  - name: onUploadProgress
    uid: >-
      @azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams.onUploadProgress
    package: '@azure/cognitiveservices-face'
    summary: Callback which fires upon upload progress.
    fullName: onUploadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onUploadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onUploadProgress
  - name: timeout
    uid: >-
      @azure/cognitiveservices-face.FaceModels.LargePersonGroupGetOptionalParams.timeout
    package: '@azure/cognitiveservices-face'
    summary: >-
      The number of milliseconds a request can take before automatically being
      terminated.
    fullName: timeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'timeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.timeout
extends: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />