DocumentModelOperationState.yml

### YamlMime:TSType
name: DocumentModelOperationState
uid: '@azure/ai-form-recognizer.DocumentModelOperationState'
package: '@azure/ai-form-recognizer'
summary: The state of a model creation operation.
fullName: DocumentModelOperationState
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
  - name: apiVersion
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.apiVersion'
    package: '@azure/ai-form-recognizer'
    summary: The API version used to train this model.
    fullName: apiVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'apiVersion?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.apiVersion](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.apiVersion)
  - name: createdOn
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.createdOn'
    package: '@azure/ai-form-recognizer'
    summary: The Date and Time that the operation was created.
    fullName: createdOn
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'createdOn: Date'
      return:
        description: ''
        type: Date
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.createdOn](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.createdOn)
  - name: error
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.error'
    package: '@azure/ai-form-recognizer'
    summary: Will exist if the operation encountered any error.
    fullName: error
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'error?: Error'
      return:
        description: ''
        type: Error
    inheritanceDescription: <b>Inherited From</b> PollOperationState.error
  - name: isCancelled
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.isCancelled'
    package: '@azure/ai-form-recognizer'
    summary: True if the operation has been cancelled.
    fullName: isCancelled
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isCancelled?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: <b>Inherited From</b> PollOperationState.isCancelled
  - name: isCompleted
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.isCompleted'
    package: '@azure/ai-form-recognizer'
    summary: True if the operation has been completed.
    fullName: isCompleted
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isCompleted?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: <b>Inherited From</b> PollOperationState.isCompleted
  - name: isStarted
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.isStarted'
    package: '@azure/ai-form-recognizer'
    summary: True if the operation has started.
    fullName: isStarted
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isStarted?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: <b>Inherited From</b> PollOperationState.isStarted
  - name: lastUpdatedOn
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.lastUpdatedOn'
    package: '@azure/ai-form-recognizer'
    summary: The date & time that the operation state was last modified.
    fullName: lastUpdatedOn
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'lastUpdatedOn: Date'
      return:
        description: ''
        type: Date
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.lastUpdatedOn](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.lastUpdatedOn)
  - name: operationId
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.operationId'
    package: '@azure/ai-form-recognizer'
    summary: The unique ID of this operation.
    fullName: operationId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'operationId: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.operationId](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.operationId)
  - name: percentCompleted
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.percentCompleted'
    package: '@azure/ai-form-recognizer'
    summary: A number between 0 and 100 representing the progress of the operation.
    fullName: percentCompleted
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'percentCompleted: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.percentCompleted](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.percentCompleted)
  - name: result
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.result'
    package: '@azure/ai-form-recognizer'
    summary: Will exist if the operation concluded in a result of an expected type.
    fullName: result
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'result?: DocumentModelDetails'
      return:
        description: ''
        type: <xref uid="@azure/ai-form-recognizer.DocumentModelDetails" />
    inheritanceDescription: <b>Inherited From</b> PollOperationState.result
  - name: status
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.status'
    package: '@azure/ai-form-recognizer'
    summary: |-
      The status of the operation. One of:

      - "notStarted"
      - "running"
      - "succeeded"
      - "failed"
      - "canceled"
    fullName: status
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'status: OperationStatus'
      return:
        description: ''
        type: <xref uid="@azure/ai-form-recognizer.OperationStatus" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.status](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.status)
  - name: tags
    uid: '@azure/ai-form-recognizer.DocumentModelOperationState.tags'
    package: '@azure/ai-form-recognizer'
    summary: >-
      Additional, user-defined key-value pairs associated with the model as
      metadata.
    fullName: tags
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tags?: Record<string, string>'
      return:
        description: ''
        type: Record&lt;string, string&gt;
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ModelAdministrationOperationStateCommon.tags](xref:@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon.tags)
extends: >-
  <xref uid="@azure/core-lro.PollOperationState" />&lt;<xref
  uid="@azure/ai-form-recognizer.DocumentModelDetails" />&gt;,<xref
  uid="@azure/ai-form-recognizer.ModelAdministrationOperationStateCommon" />