Struct google_api_proto::google::cloud::documentai::v1beta1::FormExtractionParams

pub struct FormExtractionParams {
    pub enabled: bool,
    pub key_value_pair_hints: Vec<KeyValuePairHint>,
    pub model_version: String,
}

Parameters to control form extraction behavior.

Fields

enabled: bool

Whether to enable form extraction.

key_value_pair_hints: Vec<KeyValuePairHint>

User can provide pairs of (key text, value type) to improve the parsing result.

For example, if a document has a field called “Date” that holds a date value and a field called “Amount” that may hold either a currency value (e.g., “$500.00”) or a simple number value (e.g., “20”), you could use the following hints: [ {“key”: “Date”, value_types: [ “DATE”]}, {“key”: “Amount”, “value_types”: [ “PRICE”, “NUMBER” ]} ]

If the value type is unknown, but you want to provide hints for the keys, you can leave the value_types field blank. e.g. {“key”: “Date”, “value_types”: []}

model_version: String

Model version of the form extraction system. Default is “builtin/stable”. Specify “builtin/latest” for the latest model.

Trait Implementations

impl Clone for FormExtractionParams

fn clone(&self) -> FormExtractionParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FormExtractionParams

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

Formats the value using the given formatter.

impl Default for FormExtractionParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for FormExtractionParams

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 FormExtractionParams

fn eq(&self, other: &FormExtractionParams) -> 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 FormExtractionParams