DocumentObjectField.yml

### YamlMime:TSType
name: DocumentObjectField
uid: '@azure/ai-form-recognizer.DocumentObjectField'
package: '@azure/ai-form-recognizer'
summary: >-
  A DocumentField that consists of several named properties that have their own
  DocumentField values.
fullName: DocumentObjectField<Properties>
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: kind
    uid: '@azure/ai-form-recognizer.DocumentObjectField.kind'
    package: '@azure/ai-form-recognizer'
    summary: 'Field kind: "object".'
    fullName: kind
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'kind: "object"'
      return:
        description: ''
        type: '"object"'
  - name: properties
    uid: '@azure/ai-form-recognizer.DocumentObjectField.properties'
    package: '@azure/ai-form-recognizer'
    summary: >-
      The extracted object properties. Each property of this object is, itself,
      a nested DocumentField.
    fullName: properties
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'properties: Properties'
      return:
        description: ''
        type: Properties
inheritedProperties:
  - name: boundingRegions
    uid: '@azure/ai-form-recognizer.DocumentObjectField.boundingRegions'
    package: '@azure/ai-form-recognizer'
    summary: Bounding regions covering the field.
    fullName: boundingRegions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'boundingRegions?: BoundingRegion[]'
      return:
        description: ''
        type: <xref uid="@azure/ai-form-recognizer.BoundingRegion" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.boundingRegions](xref:@azure/ai-form-recognizer.DocumentFieldCommon.boundingRegions)
  - name: confidence
    uid: '@azure/ai-form-recognizer.DocumentObjectField.confidence'
    package: '@azure/ai-form-recognizer'
    summary: Confidence of correctly extracting the field.
    fullName: confidence
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'confidence?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.confidence](xref:@azure/ai-form-recognizer.DocumentFieldCommon.confidence)
  - name: content
    uid: '@azure/ai-form-recognizer.DocumentObjectField.content'
    package: '@azure/ai-form-recognizer'
    summary: The verbatim extracted text content of the field.
    fullName: content
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'content?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.content](xref:@azure/ai-form-recognizer.DocumentFieldCommon.content)
  - name: spans
    uid: '@azure/ai-form-recognizer.DocumentObjectField.spans'
    package: '@azure/ai-form-recognizer'
    summary: Location of the field in the reading order concatenated content.
    fullName: spans
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'spans?: DocumentSpan[]'
      return:
        description: ''
        type: <xref uid="@azure/ai-form-recognizer.DocumentSpan" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DocumentFieldCommon.spans](xref:@azure/ai-form-recognizer.DocumentFieldCommon.spans)
extends: <xref uid="@azure/ai-form-recognizer.DocumentFieldCommon" />