Struct google_api_proto::google::cloud::documentai::v1beta3::document::page::FormField

pub struct FormField {
    pub field_name: Option<Layout>,
    pub field_value: Option<Layout>,
    pub name_detected_languages: Vec<DetectedLanguage>,
    pub value_detected_languages: Vec<DetectedLanguage>,
    pub value_type: String,
    pub corrected_key_text: String,
    pub corrected_value_text: String,
    pub provenance: Option<Provenance>,
}

A form field detected on the page.

Fields

field_name: Option<Layout>

[Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] name. e.g. Address, Email, Grand total, Phone number, etc.

field_value: Option<Layout>

[Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField] value.

name_detected_languages: Vec<DetectedLanguage>

A list of detected languages for name together with confidence.

value_detected_languages: Vec<DetectedLanguage>

A list of detected languages for value together with confidence.

value_type: String

If the value is non-textual, this field represents the type. Current valid values are:

• blank (this indicates the field_value is normal text)
• unfilled_checkbox
• filled_checkbox

corrected_key_text: String

Created for Labeling UI to export key text. If corrections were made to the text identified by the field_name.text_anchor, this field will contain the correction.

corrected_value_text: String

Created for Labeling UI to export value text. If corrections were made to the text identified by the field_value.text_anchor, this field will contain the correction.

provenance: Option<Provenance>

The history of this annotation.

Trait Implementations

impl Clone for FormField

fn clone(&self) -> FormField

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FormField

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FormField

fn default() -> Self

Returns the “default value” for a type.

impl Message for FormField

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FormField

fn eq(&self, other: &FormField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FormField