Compartilhar via


DocumentFieldOutput interface

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

Propriedades

boundingRegions

Regiões delimitadas que abrangem o campo.

confidence

Confiança de extrair corretamente o campo.

content

Conteúdo do campo.

spans

Local do campo no conteúdo concatenado da ordem de leitura.

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

$True.

valueCountryRegion

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

valueCurrency

Conversor de Moedas valor.

valueDate

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

valueInteger

Valor inteiro.

valueNumber

Valor de ponto flutuante.

valueObject

Dicionário de valores de campo nomeados.

valuePhoneNumber

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

valueSelectionGroup

Valor do grupo de seleção.

valueSelectionMark

Valor da marca de seleção.

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

valueSignature

Presença de assinatura.

Valores possíveis: "assinado", "sem sinal"

valueString

Valor da cadeia de caracteres.

valueTime

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

Detalhes da propriedade

boundingRegions

Regiões delimitadas que abrangem o campo.

boundingRegions?: BoundingRegionOutput[]

Valor da propriedade

confidence

Confiança de extrair corretamente o campo.

confidence?: number

Valor da propriedade

number

content

Conteúdo do campo.

content?: string

Valor da propriedade

string

spans

Local do campo no conteúdo concatenado da ordem de leitura.

spans?: DocumentSpanOutput[]

Valor da 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 da propriedade

string

valueAddress

Valor do endereço.

valueAddress?: AddressValueOutput

Valor da propriedade

valueArray

Matriz de valores de campo.

valueArray?: DocumentFieldOutput[]

Valor da propriedade

valueBoolean

$True.

valueBoolean?: boolean

Valor da propriedade

boolean

valueCountryRegion

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

valueCountryRegion?: string

Valor da propriedade

string

valueCurrency

Conversor de Moedas valor.

valueCurrency?: CurrencyValueOutput

Valor da propriedade

valueDate

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

valueDate?: string

Valor da propriedade

string

valueInteger

Valor inteiro.

valueInteger?: number

Valor da propriedade

number

valueNumber

Valor de ponto flutuante.

valueNumber?: number

Valor da propriedade

number

valueObject

Dicionário de valores de campo nomeados.

valueObject?: Record<string, DocumentFieldOutput>

Valor da propriedade

Record<string, DocumentFieldOutput>

valuePhoneNumber

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

valuePhoneNumber?: string

Valor da propriedade

string

valueSelectionGroup

Valor do grupo de seleção.

valueSelectionGroup?: string[]

Valor da propriedade

string[]

valueSelectionMark

Valor da marca de seleção.

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

valueSelectionMark?: string

Valor da propriedade

string

valueSignature

Presença de assinatura.

Valores possíveis: "assinado", "sem sinal"

valueSignature?: string

Valor da propriedade

string

valueString

Valor da cadeia de caracteres.

valueString?: string

Valor da propriedade

string

valueTime

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

valueTime?: string

Valor da propriedade

string