Share via

DocumentAnalysisModelFactory.DocumentFieldSchema Method

  • Reference

Definition

Namespace:
Azure.AI.FormRecognizer.DocumentAnalysis
Assembly:
Azure.AI.FormRecognizer.dll
Package:
Azure.AI.FormRecognizer v4.1.0
Source:
DocumentAnalysisModelFactory.cs

Initializes a new instance of DocumentFieldSchema.

public static Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldSchema DocumentFieldSchema (Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldType type = Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldType.Unknown, string description = default, string example = default, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldSchema items = default, System.Collections.Generic.IReadOnlyDictionary<string,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldSchema> properties = default);
static member DocumentFieldSchema : Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldType * string * string * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldSchema * System.Collections.Generic.IReadOnlyDictionary<string, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldSchema> -> Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldSchema
Public Shared Function DocumentFieldSchema (Optional type As DocumentFieldType = Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldType.Unknown, Optional description As String = Nothing, Optional example As String = Nothing, Optional items As DocumentFieldSchema = Nothing, Optional properties As IReadOnlyDictionary(Of String, DocumentFieldSchema) = Nothing) As DocumentFieldSchema

Parameters

type
DocumentFieldType

Semantic data type of the field value.

description
String

Field description.

example
String

Example field content.

items
DocumentFieldSchema

Field type schema of each array element.

properties
IReadOnlyDictionary<String,DocumentFieldSchema>

Named sub-fields of the object field.

Returns

DocumentFieldSchema

A new DocumentFieldSchema instance for mocking.

Applies to