Struct gapi_grpc::google::cloud::documentai::v1beta2::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. For custom form models, specify: “custom/{model_name}“. Model name format is “bucket_name/path/to/modeldir” corresponding to “gs://bucket_name/path/to/modeldir” where annotated examples are stored.

Trait Implementations

impl Clone for FormExtractionParams

fn clone(&self) -> FormExtractionParams

Returns a copy of the value.

pub 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() -> FormExtractionParams

Returns the “default value” for a type.

impl Message for FormExtractionParams

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<FormExtractionParams> 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: &FormExtractionParams) -> bool

This method tests for !=.

impl StructuralPartialEq for FormExtractionParams