ContentFieldDefinition interface

Package:

@azure/ai-content-understanding

Definition of the field using a JSON Schema like syntax.

Properties

description	Field description.
enum	Enumeration of possible field values.
enumDescriptions	Descriptions for each enumeration value.
estimateSourceAndConfidence	Return grounding source and confidence.
examples	Examples of field values.
itemDefinition	Field type schema of each array element, if type is array.
method	Generation method.
properties	Named sub-fields, if type is object.
ref	Reference to another field definition.
type	Semantic data type of the field value.

Property Details

description

Field description.

description?: string

Property Value

string

enum

Enumeration of possible field values.

enum?: string[]

Property Value

string[]

enumDescriptions

Descriptions for each enumeration value.

enumDescriptions?: Record<string, string>

Property Value

Record<string, string>

estimateSourceAndConfidence

Return grounding source and confidence.

estimateSourceAndConfidence?: boolean

Property Value

boolean

examples

Examples of field values.

examples?: string[]

Property Value

string[]

itemDefinition

Field type schema of each array element, if type is array.

itemDefinition?: ContentFieldDefinition

Property Value

ContentFieldDefinition

method

Generation method.

method?: GenerationMethod

Property Value

GenerationMethod

properties

Named sub-fields, if type is object.

properties?: Record<string, ContentFieldDefinition>

Property Value

Record<string, ContentFieldDefinition>

ref

Reference to another field definition.

ref?: string

Property Value

string

type

Semantic data type of the field value.

type?: ContentFieldType

Property Value

ContentFieldType