Partilhar via

DocumentFieldOutput interface

  • Referência
Pacote:
@azure-rest/ai-document-intelligence

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

Propriedades

boundingRegions

Regiões delimitadoras que cobrem o campo.
confidence

Confiança na extração correta do campo.
content

Conteúdo do campo.
spans

Localização 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 de endereço.
valueArray

Matriz de valores de campo.
valueBoolean

Valor booleano.
valueCountryRegion

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

Valor de moeda.
valueDate

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

Valor inteiro.
valueNumber

Valor de vírgula flutuante.
valueObject

Dicionário de valores de campos 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", "não assinado"
valueString

Valor da cadeia.
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

BoundingRegionOutput[]

confidence

Confiança na extração correta do campo.

confidence?: number

Valor de Propriedade

number

content

Conteúdo do campo.

content?: string

Valor de Propriedade

string

spans

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

spans?: DocumentSpanOutput[]

Valor de Propriedade

DocumentSpanOutput[]

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 de endereço.

valueAddress?: AddressValueOutput

Valor de Propriedade

AddressValueOutput

valueArray

Matriz de valores de campo.

valueArray?: DocumentFieldOutput[]

Valor de Propriedade

DocumentFieldOutput[]

valueBoolean

Valor booleano.

valueBoolean?: boolean

Valor de Propriedade

boolean

valueCountryRegion

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

valueCountryRegion?: string

Valor de Propriedade

string

valueCurrency

Valor de moeda.

valueCurrency?: CurrencyValueOutput

Valor de Propriedade

CurrencyValueOutput

valueDate

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

valueDate?: string

Valor de Propriedade

string

valueInteger

Valor inteiro.

valueInteger?: number

Valor de Propriedade

number

valueNumber

Valor de vírgula 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 (por exemplo, +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: "selecionado", "não selecionado"

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.

valueString?: string

Valor de Propriedade

string

valueTime

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

valueTime?: string

Valor de Propriedade

string