Package com.azure.ai.documentintelligence.models

Class DocumentFieldSchema

java.lang.Object

com.azure.ai.documentintelligence.models.DocumentFieldSchema

public final class DocumentFieldSchema
extends Object

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the description property: Field description.
String	getExample()	Get the example property: Example field content.
DocumentFieldSchema	getItems()	Get the items property: 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 type property: Semantic data type of the field value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getType

public DocumentFieldType getType()

Get the type property: Semantic data type of the field value.

Returns:

the type value.

getDescription

public String getDescription()

Get the description property: Field description.

Returns:

the description value.

getExample

public String getExample()

Get the example property: Example field content.

Returns:

the example value.

getItems

public DocumentFieldSchema getItems()

Get the items property: Field type schema of each array element.

Returns:

the items value.

getProperties

public Map<String,DocumentFieldSchema> getProperties()

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

Returns:

the properties value.