Delen via


Document Classifiers - Get Classify Result

Hiermee haalt u het resultaat van de documentclassificatie op.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview

URI-parameters

Name In Vereist Type Description
classifierId
path True

string

Unieke naam van documentclassificatie.

Regex-patroon: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

endpoint
path True

string

uri

Het Eindpunt van de Document Intelligence-service.

resultId
path True

string

uuid

Resultaat-id van bewerking analyseren.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

AnalyzeResultOperation

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

Name Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Get Classify Document Result

Voorbeeldaanvraag

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

Voorbeeldrespons

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-07-31-preview",
    "modelId": "myClassifier",
    "stringIndexType": "textElements",
    "contentFormat": "text",
    "content": "",
    "pages": [
      {
        "pageNumber": 1,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 2,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 3,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      }
    ],
    "documents": [
      {
        "docType": "formA",
        "boundingRegions": [
          {
            "pageNumber": 1,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          },
          {
            "pageNumber": 2,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      },
      {
        "docType": "formB",
        "boundingRegions": [
          {
            "pageNumber": 3,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      }
    ]
  }
}

Definities

Name Description
AddressValue

Adresveldwaarde.

AnalyzeResult

Resultaat van documentanalyse.

AnalyzeResultOperation

Status en resultaat van de analysebewerking.

BoundingRegion

Begrenzing veelhoek op een specifieke pagina van de invoer.

ContentFormat

Indeling van de inhoud in het geanalyseerde resultaat.

CurrencyValue

Valutaveldwaarde.

Document

Een object dat de locatie en semantische inhoud van een document beschrijft.

DocumentBarcode

Een streepjescodeobject.

DocumentBarcodeKind

Soort streepjescode.

DocumentCaption

Een bijschriftobject met een beschrijving van een tabel of afbeelding.

DocumentField

Een object dat de inhoud en locatie van een veldwaarde vertegenwoordigt.

DocumentFieldType

Semantisch gegevenstype van de veldwaarde.

DocumentFigure

Een object dat een afbeelding in het document vertegenwoordigt.

DocumentFootnote

Een voetnootobject met een beschrijving van een tabel of afbeelding.

DocumentFormula

Een formuleobject.

DocumentFormulaKind

Soort formule.

DocumentKeyValueElement

Een object dat de veldsleutel of waarde in een sleutel-waardepaar vertegenwoordigt.

DocumentKeyValuePair

Een object dat een formulierveld vertegenwoordigt met een uniek veldlabel (sleutel) en veldwaarde (mogelijk leeg).

DocumentLanguage

Een object dat de gedetecteerde taal vertegenwoordigt voor een bepaalde tekstspanne.

DocumentLine

Een inhoudsregelobject dat bestaat uit een aangrenzende reeks inhoudselementen, zoals woorden en selectiemarkeringen.

DocumentPage

Inhouds- en indelingselementen die zijn geëxtraheerd uit een pagina uit de invoer.

DocumentParagraph

Een alineaobject dat bestaat uit aaneengesloten lijnen, meestal met gemeenschappelijke uitlijning en afstand.

DocumentSection

Een object dat een sectie in het document vertegenwoordigt.

DocumentSelectionMark

Een selectiemarkeringsobject met selectievakjes, keuzerondjes en andere elementen die een selectie aangeven.

DocumentSelectionMarkState

Status van de selectiemarkering.

DocumentSignatureType

Aanwezigheid van handtekening.

DocumentSpan

Aaneengesloten regio van de eigenschap samengevoegde inhoud, opgegeven als offset en lengte.

DocumentStyle

Een object dat geobserveerde tekststijlen vertegenwoordigt.

DocumentTable

Een tabelobject dat bestaat uit tabelcellen die zijn gerangschikt in een rechthoekige indeling.

DocumentTableCell

Een object dat de locatie en inhoud van een tabelcel vertegenwoordigt.

DocumentTableCellKind

Tabelceltype.

DocumentWord

Een woordobject dat bestaat uit een aaneengesloten reeks tekens. Voor niet-spaties gescheiden talen, zoals Chinees, Japans en Koreaans, wordt elk teken weergegeven als een eigen woord.

Error

Het foutobject.

ErrorResponse

Foutantwoordobject.

FontStyle

Tekenstijl.

FontWeight

Tekengewicht.

InnerError

Een object met meer specifieke informatie over de fout.

LengthUnit

De eenheid die wordt gebruikt door de eigenschappen breedte, hoogte en veelhoek. Voor afbeeldingen is de eenheid 'pixel'. Voor PDF is de eenheid "inch".

OperationStatus

Bewerkingsstatus.

ParagraphRole

Semantische rol van de alinea.

StringIndexType

Methode die wordt gebruikt voor het berekenen van tekenreeksverschil en lengte.

Warning

Het foutobject.

AddressValue

Adresveldwaarde.

Name Type Description
city

string

Naam van stad, stad, dorp, enz.

cityDistrict

string

Districten of stadsdelen binnen een stad, zoals Brooklyn in New York City of City of Westminster in Londen.

countryRegion

string

Land/regio.

house

string

Buildnaam, zoals World Trade Center.

houseNumber

string

Huis- of gebouwnummer.

level

string

Vloernummer, zoals 3F.

poBox

string

Postkantoorvaknummer.

postalCode

string

Postcode die wordt gebruikt voor het sorteren van e-mail.

road

string

Straatnaam.

state

string

Administratieve afdeling op het eerste niveau.

stateDistrict

string

Administratieve afdeling op het tweede niveau die in bepaalde landinstellingen wordt gebruikt.

streetAddress

string

Adres op straatniveau, met uitzondering van plaats, staat, landregio en postcode.

suburb

string

Naam van onofficiële buurt, zoals Chinatown.

unit

string

Appartement of kantoornummer

AnalyzeResult

Resultaat van documentanalyse.

Name Type Description
apiVersion

string

API-versie die wordt gebruikt om dit resultaat te produceren.

content

string

Voeg de tekenreeksweergave samen van alle tekst- en visuele elementen in leesrichting.

contentFormat

ContentFormat

Indeling van de inhoud op het hoogste niveau van het analyseresultaat.

documents

Document[]

Geëxtraheerde documenten.

figures

DocumentFigure[]

Geëxtraheerde cijfers.

keyValuePairs

DocumentKeyValuePair[]

Geëxtraheerde sleutel-waardeparen.

languages

DocumentLanguage[]

Gedetecteerde talen.

modelId

string

Documentmodel-id die wordt gebruikt om dit resultaat te produceren.

pages

DocumentPage[]

Geanalyseerde pagina's.

paragraphs

DocumentParagraph[]

Geëxtraheerde alinea's.

sections

DocumentSection[]

Geëxtraheerde secties.

stringIndexType

StringIndexType

Methode die wordt gebruikt voor het berekenen van tekenreeksverschil en lengte.

styles

DocumentStyle[]

Uitgepakte lettertypestijlen.

tables

DocumentTable[]

Geëxtraheerde tabellen.

warnings

Warning[]

Er is een lijst met waarschuwingen aangetroffen.

AnalyzeResultOperation

Status en resultaat van de analysebewerking.

Name Type Description
analyzeResult

AnalyzeResult

Resultaat van documentanalyse.

createdDateTime

string

De datum en tijd (UTC) waarop de analysebewerking is verzonden.

error

Error

Er is een fout opgetreden tijdens documentanalyse.

lastUpdatedDateTime

string

Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.

status

OperationStatus

Bewerkingsstatus. notStarted, running, succeeded of failed

BoundingRegion

Begrenzing veelhoek op een specifieke pagina van de invoer.

Name Type Description
pageNumber

integer

Op 1 gebaseerde paginanummers met het begrenzingsgebied.

polygon

number[]

Afhankelijke veelhoek op de pagina of de hele pagina als deze niet is opgegeven. Coördinaten die zijn opgegeven ten opzichte van de linkerbovenhoek van de pagina. De getallen vertegenwoordigen de x-, y-waarden van de hoekpunten in de veelhoek, linksom (-180 graden inclusief) ten opzichte van de richting van het element.

ContentFormat

Indeling van de inhoud in het geanalyseerde resultaat.

Name Type Description
markdown

string

Markdown-weergave van de documentinhoud met sectiekoppen, tabellen, enzovoort.

text

string

Weergave van tekst zonder opmaak van de documentinhoud.

CurrencyValue

Valutaveldwaarde.

Name Type Description
amount

number

Valutabedrag.

currencyCode

string

Opgeloste valutacode (ISO 4217), indien van toepassing.

currencySymbol

string

Valutasymboollabel, indien van toepassing.

Document

Een object dat de locatie en semantische inhoud van een document beschrijft.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op het document.

confidence

number

Het vertrouwen dat het document correct wordt geëxtraheerd.

docType

string

Documenttype.

fields

<string,  DocumentField>

Woordenlijst met benoemde veldwaarden.

spans

DocumentSpan[]

Locatie van het document in de samengevoegde inhoud van de leesvolgorde.

DocumentBarcode

Een streepjescodeobject.

Name Type Description
confidence

number

Het vertrouwen dat de streepjescode correct wordt geëxtraheerd.

kind

DocumentBarcodeKind

Soort streepjescode.

polygon

number[]

Begrenzing veelhoek van de streepjescode, met coördinaten die zijn opgegeven ten opzichte van de linkerbovenhoek van de pagina. De getallen vertegenwoordigen de x-, y-waarden van de hoekpunten in de veelhoek, linksom (-180 graden inclusief) ten opzichte van de richting van het element.

span

DocumentSpan

Locatie van de streepjescode in de samengevoegde inhoud van de leesvolgorde.

value

string

Streepjescodewaarde.

DocumentBarcodeKind

Soort streepjescode.

Name Type Description
Aztec

string

Aztec-code, zoals gedefinieerd in ISO/IEC 24778:2008.

Codabar

string

Codabar streepjescode, zoals gedefinieerd in ANSI/AIM BC3-1995.

Code128

string

Code 128 streepjescode, zoals gedefinieerd in ISO/IEC 15417:2007.

Code39

string

Code 39 streepjescode, zoals gedefinieerd in ISO/IEC 16388:2007.

Code93

string

Code 93 streepjescode, zoals gedefinieerd in ANSI/AIM BC5-1995.

DataBar

string

GS1 DataBar-streepjescode.

DataBarExpanded

string

Uitgevouwen streepjescode GS1-gegevensbalk.

DataMatrix

string

Gegevensmatrixcode, zoals gedefinieerd in ISO/IEC 16022:2006.

EAN13

string

GS1 13-cijferig internationaal artikelnummer (Europees artikelnummer).

EAN8

string

GS1 8-cijferig Internationaal artikelnummer (Europees artikelnummer).

ITF

string

Interleaved 2 van 5 streepjescode, zoals gedefinieerd in ANSI/AIM BC2-1995.

MaxiCode

string

MaxiCode, zoals gedefinieerd in ISO/IEC 16023:2000.

MicroQRCode

string

Micro QR-code, zoals gedefinieerd in ISO/IEC 23941:2022.

PDF417

string

PDF417, zoals gedefinieerd in ISO 15438.

QRCode

string

QR-code, zoals gedefinieerd in ISO/IEC 18004:2015.

UPCA

string

GS1 12-cijferige Universele productcode.

UPCE

string

GS1 Universele productcode met 6 cijfers.

DocumentCaption

Een bijschriftobject met een beschrijving van een tabel of afbeelding.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die het bijschrift behandelen.

content

string

Inhoud van het bijschrift.

elements

string[]

Onderliggende elementen van het bijschrift.

spans

DocumentSpan[]

Locatie van het bijschrift in de samengevoegde inhoud van de leesvolgorde.

DocumentField

Een object dat de inhoud en locatie van een veldwaarde vertegenwoordigt.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op het veld.

confidence

number

Het vertrouwen dat het veld correct wordt geëxtraheerd.

content

string

Veldinhoud.

spans

DocumentSpan[]

Locatie van het veld in de samengevoegde inhoud van de leesvolgorde.

type

DocumentFieldType

Gegevenstype van de veldwaarde.

valueAddress

AddressValue

Adreswaarde.

valueArray

DocumentField[]

Matrix met veldwaarden.

valueBoolean

boolean

Booleaanse waarde.

valueCountryRegion

string

Landcodewaarde van 3 letters (ISO 3166-1 alfa-3).

valueCurrency

CurrencyValue

Valutawaarde.

valueDate

string

Datumwaarde in JJJJ-MM-DD indeling (ISO 8601).

valueInteger

integer

Integerwaarde.

valueNumber

number

Drijvende-kommawaarde.

valueObject

<string,  DocumentField>

Woordenlijst met benoemde veldwaarden.

valuePhoneNumber

string

Telefoonnummerwaarde in E.164-indeling (bijvoorbeeld +19876543210).

valueSelectionGroup

string[]

Waarde van selectiegroep.

valueSelectionMark

DocumentSelectionMarkState

Selectiemarkeringswaarde.

valueSignature

DocumentSignatureType

Aanwezigheid van handtekening.

valueString

string

Tekenreekswaarde.

valueTime

string

Tijdwaarde in uu:mm:ss-indeling (ISO 8601).

DocumentFieldType

Semantisch gegevenstype van de veldwaarde.

Name Type Description
address

string

Geparseerd adres.

array

string

Lijst met subvelden van hetzelfde type.

boolean

string

Booleaanse waarde, genormaliseerd tot waar of onwaar.

countryRegion

string

Land/regio, genormaliseerd naar ISO 3166-1 alfa-3-indeling (bijvoorbeeld VS).

currency

string

Valutabedrag met optioneel valutasymbool en -eenheid.

date

string

Datum, genormaliseerd naar ISO 8601-indeling (JJJJ-MM-DD).

integer

string

Geheel getal, genormaliseerd tot 64-bits ondertekend geheel getal.

number

string

Drijvendekommagetal, genormaliseerd tot drijvende komma met dubbele precisie.

object

string

Benoemde lijst met subvelden van mogelijk verschillende typen.

phoneNumber

string

Telefoonnummer, genormaliseerd naar E.164-indeling (+{CountryCode}{SubscriberNumber}).

selectionGroup

string

Matrix van geselecteerde tekenreekswaarden.

selectionMark

string

Is het veld geselecteerd?

signature

string

Is de handtekening aanwezig?

string

string

Tekst zonder opmaak.

time

string

Tijd, genormaliseerd naar ISO 8601-indeling (uu:mm:ss).

DocumentFigure

Een object dat een afbeelding in het document vertegenwoordigt.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op de afbeelding.

caption

DocumentCaption

Bijschrift dat is gekoppeld aan de afbeelding.

elements

string[]

Onderliggende elementen van de afbeelding, met uitzondering van bijschriften of voetnoten.

footnotes

DocumentFootnote[]

Lijst met voetnoten die aan de afbeelding zijn gekoppeld.

id

string

Afbeeldings-id.

spans

DocumentSpan[]

Locatie van de afbeelding in de samengevoegde inhoud van de leesvolgorde.

DocumentFootnote

Een voetnootobject met een beschrijving van een tabel of afbeelding.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's met betrekking tot de voetnoot.

content

string

De inhoud van de voetnoot.

elements

string[]

Onderliggende elementen van de voetnoot.

spans

DocumentSpan[]

Locatie van de voetnoot in de samengevoegde inhoud van de leesvolgorde.

DocumentFormula

Een formuleobject.

Name Type Description
confidence

number

Het vertrouwen dat de formule correct wordt geëxtraheerd.

kind

DocumentFormulaKind

Soort formule.

polygon

number[]

Afhankelijke veelhoek van de formule, met coördinaten die zijn opgegeven ten opzichte van de linkerbovenhoek van de pagina. De getallen vertegenwoordigen de x-, y-waarden van de hoekpunten in de veelhoek, linksom (-180 graden inclusief) ten opzichte van de richting van het element.

span

DocumentSpan

Locatie van de formule in de samengevoegde inhoud van de leesvolgorde.

value

string

LaTex-expressie die de formule beschrijft.

DocumentFormulaKind

Soort formule.

Name Type Description
display

string

Een formule in de weergavemodus die een hele regel in beslag neemt.

inline

string

Een formule die is ingesloten in de inhoud van een alinea.

DocumentKeyValueElement

Een object dat de veldsleutel of waarde in een sleutel-waardepaar vertegenwoordigt.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op het sleutelwaarde-element.

content

string

Samengevoegde inhoud van het sleutel-waardeelement in leesrichting.

spans

DocumentSpan[]

Locatie van het sleutelwaarde-element in de samengevoegde inhoud van de leesvolgorde.

DocumentKeyValuePair

Een object dat een formulierveld vertegenwoordigt met een uniek veldlabel (sleutel) en veldwaarde (mogelijk leeg).

Name Type Description
confidence

number

Het vertrouwen dat het sleutel-waardepaar correct wordt geëxtraheerd.

key

DocumentKeyValueElement

Veldlabel van het sleutel-waardepaar.

value

DocumentKeyValueElement

Veldwaarde van het sleutel-waardepaar.

DocumentLanguage

Een object dat de gedetecteerde taal vertegenwoordigt voor een bepaalde tekstspanne.

Name Type Description
confidence

number

Het vertrouwen dat de taal correct wordt geïdentificeerd.

locale

string

Gedetecteerde taal. Waarde kan een ISO 639-1-taalcode (bijvoorbeeld "en", "fr") of BCP 47-taaltag (bijvoorbeeld "zh-Hans").

spans

DocumentSpan[]

Locatie van de tekstelementen in de samengevoegde inhoud waarop de taal van toepassing is.

DocumentLine

Een inhoudsregelobject dat bestaat uit een aangrenzende reeks inhoudselementen, zoals woorden en selectiemarkeringen.

Name Type Description
content

string

Samengevoegde inhoud van de ingesloten elementen in leesrichting.

polygon

number[]

Begrenzingsveelhoek van de lijn, met coördinaten die zijn opgegeven ten opzichte van de linkerbovenhoek van de pagina. De getallen vertegenwoordigen de x-, y-waarden van de hoekpunten in de veelhoek, linksom (-180 graden inclusief) ten opzichte van de richting van het element.

spans

DocumentSpan[]

Locatie van de regel in de samengevoegde inhoud van de leesvolgorde.

DocumentPage

Inhouds- en indelingselementen die zijn geëxtraheerd uit een pagina uit de invoer.

Name Type Description
angle

number

De algemene richting van de inhoud in rechtsom, gemeten in graden tussen (-180, 180].

barcodes

DocumentBarcode[]

Uitgepakte streepjescodes van de pagina.

formulas

DocumentFormula[]

Geëxtraheerde formules van de pagina.

height

number

De hoogte van de afbeelding/PDF in respectievelijk pixels/inch.

lines

DocumentLine[]

Geëxtraheerde lijnen van de pagina, mogelijk met tekst- en visuele elementen.

pageNumber

integer

Een paginanummer op basis van 1 in het invoerdocument.

selectionMarks

DocumentSelectionMark[]

Uitgepakte selectiemarkeringen van de pagina.

spans

DocumentSpan[]

Locatie van de pagina in de samengevoegde inhoud van de leesvolgorde.

unit

LengthUnit

De eenheid die wordt gebruikt door de eigenschappen breedte, hoogte en veelhoek. Voor afbeeldingen is de eenheid 'pixel'. Voor PDF is de eenheid "inch".

width

number

De breedte van de afbeelding/PDF in respectievelijk pixels/inch.

words

DocumentWord[]

Geëxtraheerde woorden van de pagina.

DocumentParagraph

Een alineaobject dat bestaat uit aaneengesloten lijnen, meestal met gemeenschappelijke uitlijning en afstand.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op de alinea.

content

string

Samengevoegde inhoud van de alinea in leesrichting.

role

ParagraphRole

Semantische rol van de alinea.

spans

DocumentSpan[]

Locatie van de alinea in de samengevoegde inhoud van de leesvolgorde.

DocumentSection

Een object dat een sectie in het document vertegenwoordigt.

Name Type Description
elements

string[]

Onderliggende elementen van de sectie.

spans

DocumentSpan[]

Locatie van de sectie in de samengevoegde inhoud van de leesvolgorde.

DocumentSelectionMark

Een selectiemarkeringsobject met selectievakjes, keuzerondjes en andere elementen die een selectie aangeven.

Name Type Description
confidence

number

Het vertrouwen dat de selectiemarkering correct wordt geëxtraheerd.

polygon

number[]

Afhankelijke veelhoek van de selectiemarkering, met coördinaten die zijn opgegeven ten opzichte van de linkerbovenhoek van de pagina. De getallen vertegenwoordigen de x-, y-waarden van de hoekpunten in de veelhoek, linksom (-180 graden inclusief) ten opzichte van de richting van het element.

span

DocumentSpan

Locatie van de selectiemarkering in de samengevoegde inhoud van de leesvolgorde.

state

DocumentSelectionMarkState

Status van de selectiemarkering.

DocumentSelectionMarkState

Status van de selectiemarkering.

Name Type Description
selected

string

Het selectieteken is geselecteerd, vaak aangegeven door een vinkje ✓ of kruis X binnen het selectieteken.

unselected

string

De selectiemarkering is niet geselecteerd.

DocumentSignatureType

Aanwezigheid van handtekening.

Name Type Description
signed

string

Er wordt een handtekening gedetecteerd.

unsigned

string

Er worden geen handtekeningen gedetecteerd.

DocumentSpan

Aaneengesloten regio van de eigenschap samengevoegde inhoud, opgegeven als offset en lengte.

Name Type Description
length

integer

Het aantal tekens in de inhoud dat wordt vertegenwoordigd door het bereik.

offset

integer

Op nul gebaseerde index van de inhoud die wordt vertegenwoordigd door het bereik.

DocumentStyle

Een object dat geobserveerde tekststijlen vertegenwoordigt.

Name Type Description
backgroundColor

string

Achtergrondkleur in #rrggbb hexadecimale indeling..

color

string

Voorgrondkleur in #rrggbb hexadecimale notatie.

confidence

number

Betrouwbaarheid van het correct identificeren van de stijl.

fontStyle

FontStyle

Tekenstijl.

fontWeight

FontWeight

Tekengewicht.

isHandwritten

boolean

Is inhoud handgeschreven?

similarFontFamily

string

Visueel vergelijkbaar lettertype uit de set ondersteunde lettertypefamilies, met terugvallettertypen volgens CSS-conventie (bijvoorbeeld 'Arial, sans-serif').

spans

DocumentSpan[]

Locatie van de tekstelementen in de samengevoegde inhoud waarop de stijl van toepassing is.

DocumentTable

Een tabelobject dat bestaat uit tabelcellen die zijn gerangschikt in een rechthoekige indeling.

Name Type Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op de tabel.

caption

DocumentCaption

Bijschrift dat aan de tabel is gekoppeld.

cells

DocumentTableCell[]

Cellen in de tabel.

columnCount

integer

Aantal kolommen in de tabel.

footnotes

DocumentFootnote[]

Lijst met voetnoten die aan de tabel zijn gekoppeld.

rowCount

integer

Aantal rijen in de tabel.

spans

DocumentSpan[]

Locatie van de tabel in de samengevoegde inhoud van de leesvolgorde.

DocumentTableCell

Een object dat de locatie en inhoud van een tabelcel vertegenwoordigt.

Name Type Default value Description
boundingRegions

BoundingRegion[]

Begrenzingsregio's die betrekking hebben op de tabelcel.

columnIndex

integer

Kolomindex van de cel.

columnSpan

integer

1

Het aantal kolommen dat door deze cel wordt overspannen.

content

string

Samengevoegde inhoud van de tabelcel in leesrichting.

elements

string[]

Onderliggende elementen van de tabelcel.

kind

DocumentTableCellKind

content

Tabelceltype.

rowIndex

integer

Rijindex van de cel.

rowSpan

integer

1

Het aantal rijen dat door deze cel is verdeeld.

spans

DocumentSpan[]

Locatie van de tabelcel in de samengevoegde inhoud van de leesvolgorde.

DocumentTableCellKind

Tabelceltype.

Name Type Description
columnHeader

string

Beschrijft de inhoud van de kolom.

content

string

Bevat de hoofdinhoud/gegevens.

description

string

Beschrijft de inhoud in (delen van) de tabel.

rowHeader

string

Beschrijft de inhoud van de rij.

stubHead

string

Beschrijft de rijkoppen, meestal in de linkerbovenhoek van een tabel.

DocumentWord

Een woordobject dat bestaat uit een aaneengesloten reeks tekens. Voor niet-spaties gescheiden talen, zoals Chinees, Japans en Koreaans, wordt elk teken weergegeven als een eigen woord.

Name Type Description
confidence

number

Het vertrouwen dat het woord correct wordt geëxtraheerd.

content

string

Tekstinhoud van het woord.

polygon

number[]

Begrenzing veelhoek van het woord, met coördinaten die zijn opgegeven ten opzichte van de linkerbovenhoek van de pagina. De getallen vertegenwoordigen de x-, y-waarden van de hoekpunten in de veelhoek, linksom (-180 graden inclusief) ten opzichte van de richting van het element.

span

DocumentSpan

Locatie van het woord in de samengevoegde inhoud van de leesvolgorde.

Error

Het foutobject.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

Error[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.

innererror

InnerError

Een object met meer specifieke informatie dan het huidige object over de fout.

message

string

Een leesbare weergave van de fout.

target

string

Het doel van de fout.

ErrorResponse

Foutantwoordobject.

Name Type Description
error

Error

Foutinformatie.

FontStyle

Tekenstijl.

Name Type Description
italic

string

Tekens worden visueel schuin naar rechts weergegeven.

normal

string

Tekens worden normaal weergegeven.

FontWeight

Tekengewicht.

Name Type Description
bold

string

Tekens worden weergegeven met dikkere pennenstreken.

normal

string

Tekens worden normaal weergegeven.

InnerError

Een object met meer specifieke informatie over de fout.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

innererror

InnerError

Interne fout.

message

string

Een leesbare weergave van de fout.

LengthUnit

De eenheid die wordt gebruikt door de eigenschappen breedte, hoogte en veelhoek. Voor afbeeldingen is de eenheid 'pixel'. Voor PDF is de eenheid "inch".

Name Type Description
inch

string

Lengteeenheid voor PDF-bestanden.

pixel

string

Lengteeenheid voor afbeeldingsbestanden.

OperationStatus

Bewerkingsstatus.

Name Type Description
canceled

string

De bewerking is geannuleerd.

completed

string

De bewerking is voltooid.

failed

string

De bewerking is mislukt.

notStarted

string

De bewerking is nog niet gestart.

running

string

De bewerking wordt uitgevoerd.

succeeded

string

De bewerking is voltooid.

ParagraphRole

Semantische rol van de alinea.

Name Type Description
footnote

string

Een notitie wordt meestal na de hoofdinhoud op een pagina geplaatst.

formulaBlock

string

Een blok formules, vaak met gedeelde uitlijning.

pageFooter

string

Tekst aan de onderkant van de pagina.

pageHeader

string

Tekst aan de bovenrand van de pagina.

pageNumber

string

Paginanummer.

sectionHeading

string

Subkop met een beschrijving van een sectie van het document.

title

string

Titel op het hoogste niveau waarin het hele document wordt beschreven.

StringIndexType

Methode die wordt gebruikt voor het berekenen van tekenreeksverschil en lengte.

Name Type Description
textElements

string

Door de gebruiker waargenomen weergaveteken of grapheme-cluster, zoals gedefinieerd door Unicode 8.0.0.

unicodeCodePoint

string

Tekeneenheid die wordt vertegenwoordigd door één Unicode-codepunt. Wordt gebruikt door Python 3.

utf16CodeUnit

string

Tekeneenheid vertegenwoordigd door een 16-bits Unicode-code-eenheid. Wordt gebruikt door JavaScript, Java en .NET.

Warning

Het foutobject.

Name Type Description
code

string

Een van een door de server gedefinieerde set waarschuwingscodes.

message

string

Een leesbare weergave van de waarschuwing.

target

string

Het doel van de fout.