DocumentFieldSchema Class

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

Azure.AI.DocumentIntelligence v1.0.0-beta.3

Source:

DocumentFieldSchema.cs

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

public class DocumentFieldSchema : System.ClientModel.Primitives.IJsonModel<Azure.AI.DocumentIntelligence.DocumentFieldSchema>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.DocumentIntelligence.DocumentFieldSchema>

type DocumentFieldSchema = class
    interface IJsonModel<DocumentFieldSchema>
    interface IPersistableModel<DocumentFieldSchema>

Public Class DocumentFieldSchema
Implements IJsonModel(Of DocumentFieldSchema), IPersistableModel(Of DocumentFieldSchema)

Inheritance

Object

DocumentFieldSchema

Implements

IJsonModel<DocumentFieldSchema> IPersistableModel<DocumentFieldSchema> IPersistableModel<T>

Constructors

DocumentFieldSchema(DocumentFieldType)

Initializes a new instance of DocumentFieldSchema.

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.

Explicit Interface Implementations

IJsonModel<DocumentFieldSchema>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DocumentFieldSchema>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<DocumentFieldSchema>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<DocumentFieldSchema>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DocumentFieldSchema>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.