Package com.google.cloud.documentai.v1beta1

Interface FormExtractionParamsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FormExtractionParams, FormExtractionParams.Builder
    public interface FormExtractionParamsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getEnabled

        boolean getEnabled()
         Whether to enable form extraction.
        bool enabled = 1;
        Returns:
        The enabled.

      • getKeyValuePairHintsList

        List<KeyValuePairHint> getKeyValuePairHintsList()
         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": []}
        repeated .google.cloud.documentai.v1beta1.KeyValuePairHint key_value_pair_hints = 2;

      • getKeyValuePairHints

        KeyValuePairHint getKeyValuePairHints​(int index)
         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": []}
        repeated .google.cloud.documentai.v1beta1.KeyValuePairHint key_value_pair_hints = 2;

      • getKeyValuePairHintsCount

        int getKeyValuePairHintsCount()
         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": []}
        repeated .google.cloud.documentai.v1beta1.KeyValuePairHint key_value_pair_hints = 2;

      • getKeyValuePairHintsOrBuilderList

        List<? extends KeyValuePairHintOrBuilder> getKeyValuePairHintsOrBuilderList()
         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": []}
        repeated .google.cloud.documentai.v1beta1.KeyValuePairHint key_value_pair_hints = 2;

      • getKeyValuePairHintsOrBuilder

        KeyValuePairHintOrBuilder getKeyValuePairHintsOrBuilder​(int index)
         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": []}
        repeated .google.cloud.documentai.v1beta1.KeyValuePairHint key_value_pair_hints = 2;

      • getModelVersion

        String getModelVersion()
         Model version of the form extraction system. Default is
 "builtin/stable". Specify "builtin/latest" for the latest model.
        string model_version = 3;
        Returns:
        The modelVersion.

      • getModelVersionBytes

        com.google.protobuf.ByteString getModelVersionBytes()
         Model version of the form extraction system. Default is
 "builtin/stable". Specify "builtin/latest" for the latest model.
        string model_version = 3;
        Returns:
        The bytes for modelVersion.