Partilhar via

DocumentField Classe

  • Referência

Um objeto que representa o conteúdo e a localização de um valor de campo de documento.

Novidade na versão 2023-07-31: O valor booleano value_type e bool

Herança
builtins.object
DocumentField

Construtor

DocumentField(**kwargs: Any)

Métodos

from_dict

Converte um ditado na forma de um DocumentField para o próprio modelo.
to_dict

Devolve uma representação dict de DocumentField.

from_dict

Converte um ditado na forma de um DocumentField para o próprio modelo.

from_dict(data: Dict) -> DocumentField

Parâmetros

data
dict
Necessário

Um dicionário na forma de DocumentField.

Devoluções

Campo do Documento

Tipo de retorno

DocumentField

to_dict

Devolve uma representação dict de DocumentField.

to_dict() -> Dict

Devoluções

dict

Tipo de retorno

dict

Atributos

bounding_regions

Regiões delimitadoras que cobrem o campo.

bounding_regions: List[BoundingRegion] | None

confidence

A confiança de extrair corretamente o campo.

confidence: float

content

O conteúdo do campo.

content: str | None

spans

Localização do campo no conteúdo concatenado da ordem de leitura.

spans: List[DocumentSpan] | None

value

O valor do campo reconhecido. O tipo de dados semântico é descrito por value_type. Se o valor for extraído do documento, mas não puder ser normalizado para o respetivo tipo, aceda à propriedade de conteúdo para obter uma representação textual do valor.

value: str | int | float | bool | date | time | CurrencyValue | AddressValue | Dict[str, DocumentField] | List[DocumentField] | None

value_type

O tipo de valor encontrado em DocumentField. Os tipos possíveis incluem: "string", "date", "time", "phoneNumber", "float", "integer", "selectionMark", "countryRegion", "signature", "currency", "address", "boolean", "list", "dictionary".

value_type: str