Dela via


DocumentFieldOutput interface

Ett objekt som representerar innehållet och platsen för ett fältvärde.

Egenskaper

boundingRegions

Avgränsningsregioner som täcker fältet.

confidence

Konfidens för korrekt extrahering av fältet.

content

Fältinnehåll.

spans

Plats för fältet i det sammanfogade innehållet i läsordningen.

type

Datatyp för fältvärdet.

Möjliga värden: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

valueAddress

Adressvärde.

valueArray

Matris med fältvärden.

valueBoolean

Booleskt värde.

valueCountryRegion

Landskodsvärde på 3 bokstäver (ISO 3166-1 alpha-3).

valueCurrency

Valutavärde.

valueDate

Datumvärde i ÅÅÅÅ-MM-DD-format (ISO 8601).

valueInteger

Heltalsvärde.

valueNumber

Flyttalsvärde.

valueObject

Ordlista med namngivna fältvärden.

valuePhoneNumber

Telefonnummervärde i E.164-format (t.ex. +19876543210).

valueSelectionGroup

Markeringsgruppvärde.

valueSelectionMark

Markeringsmarkeringsvärde.

Möjliga värden: "selected", "unselected"

valueSignature

Förekomst av signatur.

Möjliga värden: "signerad", "osignerad"

valueString

Strängvärde.

valueTime

Tidsvärde i formatet hh:mm:ss (ISO 8601).

Egenskapsinformation

boundingRegions

Avgränsningsregioner som täcker fältet.

boundingRegions?: BoundingRegionOutput[]

Egenskapsvärde

confidence

Konfidens för korrekt extrahering av fältet.

confidence?: number

Egenskapsvärde

number

content

Fältinnehåll.

content?: string

Egenskapsvärde

string

spans

Plats för fältet i det sammanfogade innehållet i läsordningen.

spans?: DocumentSpanOutput[]

Egenskapsvärde

type

Datatyp för fältvärdet.

Möjliga värden: "string", "date", "time", "phoneNumber", "number", "integer", "selectionMark", "countryRegion", "signature", "array", "object", "currency", "address", "boolean", "selectionGroup"

type: string

Egenskapsvärde

string

valueAddress

Adressvärde.

valueAddress?: AddressValueOutput

Egenskapsvärde

valueArray

Matris med fältvärden.

valueArray?: DocumentFieldOutput[]

Egenskapsvärde

valueBoolean

Booleskt värde.

valueBoolean?: boolean

Egenskapsvärde

boolean

valueCountryRegion

Landskodsvärde på 3 bokstäver (ISO 3166-1 alpha-3).

valueCountryRegion?: string

Egenskapsvärde

string

valueCurrency

Valutavärde.

valueCurrency?: CurrencyValueOutput

Egenskapsvärde

valueDate

Datumvärde i ÅÅÅÅ-MM-DD-format (ISO 8601).

valueDate?: string

Egenskapsvärde

string

valueInteger

Heltalsvärde.

valueInteger?: number

Egenskapsvärde

number

valueNumber

Flyttalsvärde.

valueNumber?: number

Egenskapsvärde

number

valueObject

Ordlista med namngivna fältvärden.

valueObject?: Record<string, DocumentFieldOutput>

Egenskapsvärde

Record<string, DocumentFieldOutput>

valuePhoneNumber

Telefonnummervärde i E.164-format (t.ex. +19876543210).

valuePhoneNumber?: string

Egenskapsvärde

string

valueSelectionGroup

Markeringsgruppvärde.

valueSelectionGroup?: string[]

Egenskapsvärde

string[]

valueSelectionMark

Markeringsmarkeringsvärde.

Möjliga värden: "selected", "unselected"

valueSelectionMark?: string

Egenskapsvärde

string

valueSignature

Förekomst av signatur.

Möjliga värden: "signerad", "osignerad"

valueSignature?: string

Egenskapsvärde

string

valueString

Strängvärde.

valueString?: string

Egenskapsvärde

string

valueTime

Tidsvärde i formatet hh:mm:ss (ISO 8601).

valueTime?: string

Egenskapsvärde

string