FaceModels.FaceListAddFaceFromStreamOptionalParams.yml

### YamlMime:TSType
name: FaceListAddFaceFromStreamOptionalParams
uid: >-
  @azure/cognitiveservices-face.FaceModels.FaceListAddFaceFromStreamOptionalParams
package: '@azure/cognitiveservices-face'
summary: Optional Parameters.
fullName: FaceListAddFaceFromStreamOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: detectionModel
    uid: >-
      @azure/cognitiveservices-face.FaceModels.FaceListAddFaceFromStreamOptionalParams.detectionModel
    package: '@azure/cognitiveservices-face'
    summary: >-
      Name of detection model. Detection model is used to detect faces in the
      submitted image. A

      detection model name can be provided when performing Face - Detect or
      (Large)FaceList - Add

      Face or (Large)PersonGroup - Add Face. The default value is
      'detection_01', if another model

      is needed, please explicitly specify it. Possible values include:
      'detection_01',

      'detection_02', 'detection_03'. Default value: 'detection_01'.
    fullName: detectionModel
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'detectionModel?: DetectionModel'
      return:
        description: ''
        type: <xref uid="@azure/cognitiveservices-face.FaceModels.DetectionModel" />
  - name: targetFace
    uid: >-
      @azure/cognitiveservices-face.FaceModels.FaceListAddFaceFromStreamOptionalParams.targetFace
    package: '@azure/cognitiveservices-face'
    summary: >-
      A face rectangle to specify the target face to be added to a person in the
      format of

      "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If
      there is more than one

      face in the image, targetFace is required to specify which face to add. No
      targetFace means

      there is only one face detected in the entire image.
    fullName: targetFace
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'targetFace?: number[]'
      return:
        description: ''
        type: number[]
  - name: userData
    uid: >-
      @azure/cognitiveservices-face.FaceModels.FaceListAddFaceFromStreamOptionalParams.userData
    package: '@azure/cognitiveservices-face'
    summary: >-
      User-specified data about the face for any purpose. The maximum length is
      1KB.
    fullName: userData
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userData?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: abortSignal
    uid: >-
      @azure/cognitiveservices-face.FaceModels.FaceListAddFaceFromStreamOptionalParams.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.FaceListAddFaceFromStreamOptionalParams.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.FaceListAddFaceFromStreamOptionalParams.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.FaceListAddFaceFromStreamOptionalParams.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.FaceListAddFaceFromStreamOptionalParams.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" />