ClassifyDocumentOptions.yml

### YamlMime:TSType
name: ClassifyDocumentOptions
uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions'
package: '@azure/ai-form-recognizer'
summary: Options for the document classification operation.
fullName: ClassifyDocumentOptions
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
  - name: abortSignal
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.abortSignal'
    package: '@azure/ai-form-recognizer'
    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/abort-controller.AbortSignalLike" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.abortSignal](xref:@azure/ai-form-recognizer.PollerOptions.abortSignal)
  - name: onProgress
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.onProgress'
    package: '@azure/ai-form-recognizer'
    summary: >-
      An optional initial progress handler that will be called when the poller
      state updates. This handler will be called

      once immediately after the poller state is initialized.
    fullName: onProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        onProgress?: (state:
        DocumentAnalysisPollOperationState<AnalyzeResult<AnalyzedDocument>>) =>
        void
      return:
        description: ''
        type: >-
          (state:
          DocumentAnalysisPollOperationState&lt;AnalyzeResult&lt;AnalyzedDocument&gt;&gt;)
          =&gt; void
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.onProgress](xref:@azure/ai-form-recognizer.PollerOptions.onProgress)
  - name: onResponse
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.onResponse'
    package: '@azure/ai-form-recognizer'
    summary: |-
      A function to be called each time a response is received from the server
      while performing the requested operation.
      May be called multiple times.
    fullName: onResponse
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onResponse?: RawResponseCallback'
      return:
        description: ''
        type: <xref uid="@azure/core-client.RawResponseCallback" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.onResponse](xref:@azure/ai-form-recognizer.PollerOptions.onResponse)
  - name: requestOptions
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.requestOptions'
    package: '@azure/ai-form-recognizer'
    summary: Options used when creating and sending HTTP requests for this operation.
    fullName: requestOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'requestOptions?: OperationRequestOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-client.OperationRequestOptions" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.requestOptions](xref:@azure/ai-form-recognizer.PollerOptions.requestOptions)
  - name: resumeFrom
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.resumeFrom'
    package: '@azure/ai-form-recognizer'
    summary: >-
      A serialized poller state. If provided, the polling operation will be
      resumed from the given state instead of

      started as if it were a new operation.
    fullName: resumeFrom
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'resumeFrom?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.resumeFrom](xref:@azure/ai-form-recognizer.PollerOptions.resumeFrom)
  - name: serializerOptions
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.serializerOptions'
    package: '@azure/ai-form-recognizer'
    summary: Options to override serialization/de-serialization behavior.
    fullName: serializerOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'serializerOptions?: SerializerOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-client.SerializerOptions" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.serializerOptions](xref:@azure/ai-form-recognizer.PollerOptions.serializerOptions)
  - name: tracingOptions
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.tracingOptions'
    package: '@azure/ai-form-recognizer'
    summary: Options used when tracing is enabled.
    fullName: tracingOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tracingOptions?: OperationTracingOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.tracingOptions](xref:@azure/ai-form-recognizer.PollerOptions.tracingOptions)
  - name: updateIntervalInMs
    uid: '@azure/ai-form-recognizer.ClassifyDocumentOptions.updateIntervalInMs'
    package: '@azure/ai-form-recognizer'
    summary: >-
      The amount of time to wait (in milliseconds) between subsequent requests
      relating to the same operation.
    fullName: updateIntervalInMs
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'updateIntervalInMs?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      [PollerOptions.updateIntervalInMs](xref:@azure/ai-form-recognizer.PollerOptions.updateIntervalInMs)
extends: >-
  <xref uid="@azure/core-client.OperationOptions" />,<xref
  uid="@azure/ai-form-recognizer.PollerOptions" />&lt;<xref
  uid="@azure/ai-form-recognizer.DocumentAnalysisPollOperationState" />&gt;