DocumentFieldSchema Class

Package:

com.azure.ai.formrecognizer.documentanalysis.administration.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.9

• java.lang.Object
• • com.azure.ai.formrecognizer.documentanalysis.administration.models.DocumentFieldSchema

public final class DocumentFieldSchema

Description of the field semantic schema using a JSON Schema style syntax.

Constructor Summary

Constructor	Description
DocumentFieldSchema()	Constructs a DocumentFieldSchema object.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Get the Field description.
String	getExample() Get the example field content.
DocumentFieldSchema	getItems() Get the Field type schema of each array element.
Map<String,DocumentFieldSchema>	getProperties() Get the properties property: Named sub-fields of the object field.
DocumentFieldType	getType() Get the Semantic data type of the field value.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentFieldSchema

public DocumentFieldSchema()

Constructs a DocumentFieldSchema object.

Method Details

getDescription

public String getDescription()

Get the Field description.

Returns:

the description value.

getExample

public String getExample()

Get the example field content.

Returns:

the example value.

getItems

public DocumentFieldSchema getItems()

Get the Field type schema of each array element.

Returns:

the items value.

getProperties

public Map getProperties()

Get the properties property: Named sub-fields of the object field.

Returns:

the properties value.

getType

public DocumentFieldType getType()

Get the Semantic data type of the field value.

Returns:

the type value.