Share via


ContentFieldDefinition Class

Definition

Definition of the field using a JSON Schema like syntax.

public class ContentFieldDefinition : System.ClientModel.Primitives.IJsonModel<Azure.AI.ContentUnderstanding.ContentFieldDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.ContentUnderstanding.ContentFieldDefinition>
type ContentFieldDefinition = class
    interface IJsonModel<ContentFieldDefinition>
    interface IPersistableModel<ContentFieldDefinition>
Public Class ContentFieldDefinition
Implements IJsonModel(Of ContentFieldDefinition), IPersistableModel(Of ContentFieldDefinition)
Inheritance
ContentFieldDefinition
Implements

Constructors

Name Description
ContentFieldDefinition()

Initializes a new instance of ContentFieldDefinition.

Properties

Name Description
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.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<ContentFieldDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ContentFieldDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ContentFieldDefinition>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ContentFieldDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ContentFieldDefinition>.Write(ModelReaderWriterOptions)

Applies to