DocumentIntelligenceModelFactory.DocumentField Method

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

Azure.AI.DocumentIntelligence v1.0.0

Overloads

DocumentField(DocumentFieldType, String, Nullable<DateTimeOffset>, Nullable<TimeSpan>, String, Nullable<Double>, Nullable<Int64>, Nullable<DocumentSelectionMarkState>, Nullable<DocumentSignatureType>, String, IEnumerable<DocumentField>, DocumentFieldDictionary, CurrencyValue, AddressValue, Nullable<Boolean>, IEnumerable<String>, String, IEnumerable<BoundingRegion>, IEnumerable<DocumentSpan>, Nullable<Single>)

Initializes a new instance of DocumentField.

DocumentField(DocumentFieldType, String, Nullable<DateTimeOffset>, Nullable<TimeSpan>, String, Nullable<Double>, Nullable<Int64>, Nullable<DocumentSelectionMarkState>, Nullable<DocumentSignatureType>, String, IEnumerable<DocumentField>, DocumentFieldDictionary, CurrencyValue, AddressValue, Nullable<Boolean>, IEnumerable<String>, String, IEnumerable<BoundingRegion>, IEnumerable<DocumentSpan>, Nullable<Single>)

Source:

DocumentIntelligenceModelFactory.cs

Initializes a new instance of DocumentField.

public static Azure.AI.DocumentIntelligence.DocumentField DocumentField (Azure.AI.DocumentIntelligence.DocumentFieldType fieldType = default, string valueString = default, DateTimeOffset? valueDate = default, TimeSpan? valueTime = default, string valuePhoneNumber = default, double? valueDouble = default, long? valueInt64 = default, Azure.AI.DocumentIntelligence.DocumentSelectionMarkState? valueSelectionMark = default, Azure.AI.DocumentIntelligence.DocumentSignatureType? valueSignature = default, string valueCountryRegion = default, System.Collections.Generic.IEnumerable<Azure.AI.DocumentIntelligence.DocumentField> valueList = default, Azure.AI.DocumentIntelligence.DocumentFieldDictionary valueDictionary = default, Azure.AI.DocumentIntelligence.CurrencyValue valueCurrency = default, Azure.AI.DocumentIntelligence.AddressValue valueAddress = default, bool? valueBoolean = default, System.Collections.Generic.IEnumerable<string> valueSelectionGroup = default, string content = default, System.Collections.Generic.IEnumerable<Azure.AI.DocumentIntelligence.BoundingRegion> boundingRegions = default, System.Collections.Generic.IEnumerable<Azure.AI.DocumentIntelligence.DocumentSpan> spans = default, float? confidence = default);

static member DocumentField : Azure.AI.DocumentIntelligence.DocumentFieldType * string * Nullable<DateTimeOffset> * Nullable<TimeSpan> * string * Nullable<double> * Nullable<int64> * Nullable<Azure.AI.DocumentIntelligence.DocumentSelectionMarkState> * Nullable<Azure.AI.DocumentIntelligence.DocumentSignatureType> * string * seq<Azure.AI.DocumentIntelligence.DocumentField> * Azure.AI.DocumentIntelligence.DocumentFieldDictionary * Azure.AI.DocumentIntelligence.CurrencyValue * Azure.AI.DocumentIntelligence.AddressValue * Nullable<bool> * seq<string> * string * seq<Azure.AI.DocumentIntelligence.BoundingRegion> * seq<Azure.AI.DocumentIntelligence.DocumentSpan> * Nullable<single> -> Azure.AI.DocumentIntelligence.DocumentField

Public Shared Function DocumentField (Optional fieldType As DocumentFieldType = Nothing, Optional valueString As String = Nothing, Optional valueDate As Nullable(Of DateTimeOffset) = Nothing, Optional valueTime As Nullable(Of TimeSpan) = Nothing, Optional valuePhoneNumber As String = Nothing, Optional valueDouble As Nullable(Of Double) = Nothing, Optional valueInt64 As Nullable(Of Long) = Nothing, Optional valueSelectionMark As Nullable(Of DocumentSelectionMarkState) = Nothing, Optional valueSignature As Nullable(Of DocumentSignatureType) = Nothing, Optional valueCountryRegion As String = Nothing, Optional valueList As IEnumerable(Of DocumentField) = Nothing, Optional valueDictionary As DocumentFieldDictionary = Nothing, Optional valueCurrency As CurrencyValue = Nothing, Optional valueAddress As AddressValue = Nothing, Optional valueBoolean As Nullable(Of Boolean) = Nothing, Optional valueSelectionGroup As IEnumerable(Of String) = Nothing, Optional content As String = Nothing, Optional boundingRegions As IEnumerable(Of BoundingRegion) = Nothing, Optional spans As IEnumerable(Of DocumentSpan) = Nothing, Optional confidence As Nullable(Of Single) = Nothing) As DocumentField

Parameters

fieldType

DocumentFieldType

Data type of the field value.

valueString

String

String value.

valueDate

Nullable<DateTimeOffset>

Date value in YYYY-MM-DD format (ISO 8601).

valueTime

Nullable<TimeSpan>

Time value in hh:mm:ss format (ISO 8601).

valuePhoneNumber

String

Phone number value in E.164 format (ex. +19876543210).

valueDouble

Nullable<Double>

Floating point value.

valueInt64

Nullable<Int64>

Integer value.

valueSelectionMark

Nullable<DocumentSelectionMarkState>

Selection mark value.

valueSignature

Nullable<DocumentSignatureType>

Presence of signature.

valueCountryRegion

String

3-letter country code value (ISO 3166-1 alpha-3).

valueList

IEnumerable<DocumentField>

Array of field values.

valueDictionary

DocumentFieldDictionary

Dictionary of named field values.

valueCurrency

CurrencyValue

Currency value.

valueAddress

AddressValue

Address value.

valueBoolean

Nullable<Boolean>

Boolean value.

valueSelectionGroup

IEnumerable<String>

Selection group value.

content

String

Field content.

boundingRegions

IEnumerable<BoundingRegion>

Bounding regions covering the field.

spans

IEnumerable<DocumentSpan>

Location of the field in the reading order concatenated content.

confidence

Nullable<Single>

Confidence of correctly extracting the field.

Returns

DocumentField

A new DocumentField instance for mocking.