FormField クラス

  • リファレンス

入力フォームで認識されるフィールドを表します。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

継承
builtins.object
FormField

コンストラクター

FormField(**kwargs: Any)

メソッド

from_dict

FormField の図形のディクテーションをモデル自体に変換します。
to_dict

FormField の dict 表現を返します。

from_dict

FormField の図形のディクテーションをモデル自体に変換します。

from_dict(data: Dict) -> FormField

パラメーター

data
dict
必須

FormField の図形のディクショナリ。

戻り値

FormField

の戻り値の型 :

FormField

to_dict

FormField の dict 表現を返します。

to_dict() -> Dict

戻り値

dict

の戻り値の型 :

dict

属性

confidence

認識結果の確実度を測定します。 値は [0.0, 1.0] の間です。

confidence: float

label_data

フィールド ラベルのテキスト、境界ボックス、およびフィールド要素を格納します。 これは、ラベルでトレーニングされたモデルによって分析されたフォームでは返されないことに注意してください。

label_data: FieldData

name

ラベルを使用してトレーニングされたカスタム モデルから分析された場合は、フィールドの一意の名前またはトレーニング時間ラベル。

name: str

value

認識されたフィールドの値。 セマンティック データ型は 、value_typeによって記述されます。 値がフォームから抽出され、その型に正規化できない場合は、 value_data.text プロパティにアクセスして、値をテキスト形式で表現します。

value: str | int | float | date | time | Dict[str, FormField] | List[FormField]

value_data

フィールド値のテキスト、境界ボックス、およびフィールド要素を格納します。

value_data: FieldData

value_type

FormField で見つかった 値 の型。 で説明されている FieldValueType型は、'string'、'date'、'time'、'phoneNumber'、'float'、'integer'、'dictionary'、'list'、'selectionMark'、または 'countryRegion' です。

value_type: str