次の方法で共有

DocumentField Class

An object representing the content and location of a field value.

Constructor

DocumentField(*args: Any, **kwargs: Any)

Variables

Name Description
type
str or DocumentFieldType

Data type of the field value. Required. Known values are: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup".
value_string
str

String value.
value_date
date

Date value in YYYY-MM-DD format (ISO 8601).
value_time
time

Time value in hh:mm:ss format (ISO 8601).
value_phone_number
str

Phone number value in E.164 format (ex. +19876543210).
value_number
float

Floating point value.
value_integer
int

Integer value.
value_selection_mark
str or DocumentSelectionMarkState

Selection mark value. Known values are: "selected" and "unselected".
value_signature
str or DocumentSignatureType

Presence of signature. Known values are: "signed" and "unsigned".
value_country_region
str

3-letter country code value (ISO 3166-1 alpha-3).
value_array
list[DocumentField]

Array of field values.
value_object
dict[str, DocumentField]

Dictionary of named field values.
value_currency
CurrencyValue

Currency value.
value_address
AddressValue

Address value.
value_boolean
bool

Boolean value.
value_selection_group
list[str]

Selection group value.
content
str

Field content.
bounding_regions
list[BoundingRegion]

Bounding regions covering the field.
spans
list[DocumentSpan]

Location of the field in the reading order concatenated content.
confidence
float

Confidence of correctly extracting the field.

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

bounding_regions

Bounding regions covering the field.

bounding_regions: List[_models.BoundingRegion] | None

confidence

Confidence of correctly extracting the field.

confidence: float | None

content

Field content.

content: str | None

spans

Location of the field in the reading order concatenated content.

spans: List[_models.DocumentSpan] | None

type

"string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", and "selectionGroup".

type: str | _models.DocumentFieldType

value_address

Address value.

value_address: _models.AddressValue | None

value_array

Array of field values.

value_array: List[_models.DocumentField] | None

value_boolean

Boolean value.

value_boolean: bool | None

value_country_region

3-letter country code value (ISO 3166-1 alpha-3).

value_country_region: str | None

value_currency

Currency value.

value_currency: _models.CurrencyValue | None

value_date

Date value in YYYY-MM-DD format (ISO 8601).

value_date: date | None

value_integer

Integer value.

value_integer: int | None

value_number

Floating point value.

value_number: float | None

value_object

Dictionary of named field values.

value_object: Dict[str, _models.DocumentField] | None

value_phone_number

Phone number value in E.164 format (ex. +19876543210).

value_phone_number: str | None

value_selection_group

Selection group value.

value_selection_group: List[str] | None

value_selection_mark

"selected" and "unselected".

value_selection_mark: str | _models.DocumentSelectionMarkState | None

value_signature

"signed" and "unsigned".

value_signature: str | _models.DocumentSignatureType | None

value_string

String value.

value_string: str | None

value_time

ss format (ISO 8601).

value_time: time | None