DocumentKeyValuePair Class

Definition

Namespace:

Azure.AI.DocumentIntelligence

Assembly:

Azure.AI.DocumentIntelligence.dll

Package:

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

Source:

DocumentKeyValuePair.cs

An object representing a form field with distinct field label (key) and field value (may be empty).

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

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

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

Inheritance

Object

DocumentKeyValuePair

Implements

IJsonModel<DocumentKeyValuePair> IPersistableModel<DocumentKeyValuePair> IPersistableModel<T>

Properties

Confidence	Confidence of correctly extracting the key-value pair.
Key	Field label of the key-value pair.
Value	Field value of the key-value pair.

Explicit Interface Implementations

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