DocumentFieldSchema interface

Package:

@azure-rest/ai-document-intelligence

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

Properties

description	Field description.
example	Example field content.
items	Field type schema of each array element.
properties	Named sub-fields of the object field.
type	Semantic data type of the field value. Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

Property Details

description

Field description.

description?: string

Property Value

string

example

Example field content.

example?: string

Property Value

string

items

Field type schema of each array element.

items?: DocumentFieldSchema

Property Value

DocumentFieldSchema

properties

Named sub-fields of the object field.

properties?: Record<string, DocumentFieldSchema>

Property Value

Record<string, DocumentFieldSchema>

type

Semantic data type of the field value.

Possible values: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

type: string

Property Value

string