DocumentField Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
An object representing the content and location of a field value.
public class DocumentField : System.ClientModel.Primitives.IJsonModel<Azure.AI.DocumentIntelligence.DocumentField>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.DocumentIntelligence.DocumentField>type DocumentField = class
interface IJsonModel<DocumentField>
interface IPersistableModel<DocumentField>Public Class DocumentField
Implements IJsonModel(Of DocumentField), IPersistableModel(Of DocumentField)- Inheritance
-
DocumentField
- Implements
Properties
| BoundingRegions |
Bounding regions covering the field. |
| Confidence |
Confidence of correctly extracting the field. |
| Content |
Field content. |
| Spans |
Location of the field in the reading order concatenated content. |
| Type |
Data type of the field value. |
| ValueAddress |
Address value. |
| ValueBoolean |
Boolean value. |
| ValueCountryRegion |
3-letter country code value (ISO 3166-1 alpha-3). |
| ValueCurrency |
Currency value. |
| ValueDate |
Date value in YYYY-MM-DD format (ISO 8601). |
| ValueDictionary |
Dictionary of named field values. |
| ValueDouble |
Floating point value. |
| ValueList |
Array of field values. |
| ValueLong |
Integer value. |
| ValuePhoneNumber |
Phone number value in E.164 format (ex. +19876543210). |
| ValueSelectionGroup |
Selection group value. |
| ValueSelectionMark |
Selection mark value. |
| ValueSignature |
Presence of signature. |
| ValueString |
String value. |
| ValueTime |
Time value in hh:mm:ss format (ISO 8601). |
Explicit Interface Implementations
| IJsonModel<DocumentField>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<DocumentField>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<DocumentField>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<DocumentField>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<DocumentField>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
