Partilhar via


DocumentFieldOutput interface

Um objeto que representa o conteúdo e o local de um valor de campo.

Propriedades

boundingRegions

Regiões delimitadoras que cobrem o campo.

confidence

Confiança de extrair corretamente o campo.

content

Conteúdo do campo.

spans

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

type

Tipo de dados do valor do campo.

Valores possíveis: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

valueAddress

Valor do endereço.

valueArray

Matriz de valores de campo.

valueBoolean

Valor booleano.

valueCountryRegion

Valor do código de país de 3 letras (ISO 3166-1 alpha-3).

valueCurrency

Valor da moeda.

valueDate

Valor de data no formato AAAA-MM-DD (ISO 8601).

valueInteger

Valor inteiro.

valueNumber

Valor de ponto flutuante.

valueObject

Dicionário de valores de campos nomeados.

valuePhoneNumber

Valor do número de telefone no formato E.164 (ex. +19876543210).

valueSelectionGroup

Valor do grupo de seleção.

valueSelectionMark

Valor da marca de seleção.

Valores possíveis: "selected", "unselected"

valueSignature

Presença de assinatura.

Valores possíveis: "assinado", "não assinado"

valueString

Valor da cadeia de caracteres.

valueTime

Valor de tempo no formato hh:mm:ss (ISO 8601).

Detalhes de Propriedade

boundingRegions

Regiões delimitadoras que cobrem o campo.

boundingRegions?: BoundingRegionOutput[]

Valor de Propriedade

confidence

Confiança de extrair corretamente o campo.

confidence?: number

Valor de Propriedade

number

content

Conteúdo do campo.

content?: string

Valor de Propriedade

string

spans

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

spans?: DocumentSpanOutput[]

Valor de Propriedade

type

Tipo de dados do valor do campo.

Valores possíveis: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

type: string

Valor de Propriedade

string

valueAddress

Valor do endereço.

valueAddress?: AddressValueOutput

Valor de Propriedade

valueArray

Matriz de valores de campo.

valueArray?: DocumentFieldOutput[]

Valor de Propriedade

valueBoolean

Valor booleano.

valueBoolean?: boolean

Valor de Propriedade

boolean

valueCountryRegion

Valor do código de país de 3 letras (ISO 3166-1 alpha-3).

valueCountryRegion?: string

Valor de Propriedade

string

valueCurrency

Valor da moeda.

valueCurrency?: CurrencyValueOutput

Valor de Propriedade

valueDate

Valor de data no formato AAAA-MM-DD (ISO 8601).

valueDate?: string

Valor de Propriedade

string

valueInteger

Valor inteiro.

valueInteger?: number

Valor de Propriedade

number

valueNumber

Valor de ponto flutuante.

valueNumber?: number

Valor de Propriedade

number

valueObject

Dicionário de valores de campos nomeados.

valueObject?: Record<string, DocumentFieldOutput>

Valor de Propriedade

Record<string, DocumentFieldOutput>

valuePhoneNumber

Valor do número de telefone no formato E.164 (ex. +19876543210).

valuePhoneNumber?: string

Valor de Propriedade

string

valueSelectionGroup

Valor do grupo de seleção.

valueSelectionGroup?: string[]

Valor de Propriedade

string[]

valueSelectionMark

Valor da marca de seleção.

Valores possíveis: "selected", "unselected"

valueSelectionMark?: string

Valor de Propriedade

string

valueSignature

Presença de assinatura.

Valores possíveis: "assinado", "não assinado"

valueSignature?: string

Valor de Propriedade

string

valueString

Valor da cadeia de caracteres.

valueString?: string

Valor de Propriedade

string

valueTime

Valor de tempo no formato hh:mm:ss (ISO 8601).

valueTime?: string

Valor de Propriedade

string