Udostępnij za pośrednictwem


Document Classifiers - Get Classify Result

Pobiera wynik klasyfikatora dokumentów.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
classifierId
path True

string

Unikatowa nazwa klasyfikatora dokumentu.

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

endpoint
path True

string

Punkt końcowy usługi Analizy dokumentów.

resultId
path True

string

uuid

Analizowanie identyfikatora wyniku operacji.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

AnalyzeResultOperation

Żądanie zakończyło się pomyślnie.

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Classify Document Result

Przykładowe żądanie

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

Przykładowa odpowiedź

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-02-29-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": []
      }
    ]
  }
}

Definicje

Nazwa Opis
AddressValue

Wartość pola adresu.

AnalyzeResult

Wynik analizy dokumentu.

AnalyzeResultOperation

Stan i wynik operacji analizy.

BoundingRegion

Powiązanie wielokąta na określonej stronie danych wejściowych.

ContentFormat

Format zawartości w analizowanym wyniku.

CurrencyValue

Wartość pola waluty.

Document

Obiekt opisujący lokalizację i semantyczną zawartość dokumentu.

DocumentBarcode

Obiekt kodu kreskowego.

DocumentBarcodeKind

Rodzaj kodu kreskowego.

DocumentCaption

Obiekt podpis opisujący tabelę lub rysunek.

DocumentField

Obiekt reprezentujący zawartość i lokalizację wartości pola.

DocumentFieldType

Semantyczny typ danych wartości pola.

DocumentFigure

Obiekt reprezentujący rysunek w dokumencie.

DocumentFootnote

Obiekt przypisu dolnego opisujący tabelę lub rysunek.

DocumentFormula

Obiekt formuły.

DocumentFormulaKind

Rodzaj formuły.

DocumentKeyValueElement

Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość.

DocumentKeyValuePair

Obiekt reprezentujący pole formularza z unikatową etykietą pola (klucz) i wartością pola (może być pusta).

DocumentLanguage

Obiekt reprezentujący wykryty język dla danego zakresu tekstu.

DocumentLine

Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.

DocumentList

Obiekt reprezentujący listę w dokumencie.

DocumentListItem

Obiekt reprezentujący element listy w dokumencie.

DocumentPage

Zawartość i elementy układu wyodrębnione ze strony z danych wejściowych.

DocumentParagraph

Obiekt akapitu składający się z ciągłych linii zwykle ze wspólnym wyrównaniem i odstępami.

DocumentSection

Obiekt reprezentujący sekcję w dokumencie.

DocumentSelectionMark

Obiekt znacznika zaznaczenia reprezentujący pola wyboru, przyciski radiowe i inne elementy wskazujące zaznaczenie.

DocumentSelectionMarkState

Stan znacznika wyboru.

DocumentSignatureType

Obecność podpisu.

DocumentSpan

Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.

DocumentStyle

Obiekt reprezentujący obserwowane style tekstu.

DocumentTable

Obiekt tabeli składający się z komórek tabeli rozmieszczonych w układzie prostokątnym.

DocumentTableCell

Obiekt reprezentujący lokalizację i zawartość komórki tabeli.

DocumentTableCellKind

Rodzaj komórki tabeli.

DocumentWord

Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielonych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.

Error

Obiekt błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

FontStyle

Styl czcionki.

FontWeight

Waga czcionki.

InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

LengthUnit

Jednostka używana przez właściwości szerokości, wysokości i wielokąta. W przypadku obrazów jednostka jest "piksel". W przypadku formatu PDF jednostka jest "cal".

OperationStatus

Stan operacji.

ParagraphRole

Semantyczna rola akapitu.

StringIndexType

Metoda używana do obliczania przesunięcia i długości ciągu.

AddressValue

Wartość pola adresu.

Nazwa Typ Opis
city

string

Nazwa miasta, miasta, wioski itp.

cityDistrict

string

Dzielnice lub dzielnice w mieście, takie jak Brooklyn w Nowym Jorku lub City of Westminster w Londynie.

countryRegion

string

Kraj/region.

house

string

Nazwa kompilacji, taka jak World Trade Center.

houseNumber

string

Dom lub numer budynku.

level

string

Numer podłogi, taki jak 3F.

poBox

string

Numer skrzynki pocztowej.

postalCode

string

Kod pocztowy używany do sortowania poczty.

road

string

Nazwa ulicy.

state

string

Pierwszy poziom podziału administracyjnego.

stateDistrict

string

Drugi poziom podziału administracyjnego używany w niektórych ustawieniach regionalnych.

streetAddress

string

Adres na poziomie ulicy, z wyłączeniem miasta, stanu, krajuRegion i kod pocztowy.

suburb

string

Nieoficjalna nazwa dzielnicy, na przykład Chinatown.

unit

string

Numer mieszkania lub biura

AnalyzeResult

Wynik analizy dokumentu.

Nazwa Typ Opis
apiVersion

string

Wersja interfejsu API używana do wygenerowania tego wyniku.

content

string

Połącz reprezentację ciągu ze wszystkimi elementami tekstowymi i wizualnymi w kolejności odczytu.

contentFormat

ContentFormat

Format zawartości najwyższego poziomu wyników analizy.

documents

Document[]

Wyodrębnione dokumenty.

figures

DocumentFigure[]

Wyodrębnione dane.

keyValuePairs

DocumentKeyValuePair[]

Wyodrębnione pary klucz-wartość.

languages

DocumentLanguage[]

Wykryte języki.

lists

DocumentList[]

Wyodrębnione listy.

modelId

string

Identyfikator modelu dokumentu używany do wygenerowania tego wyniku.

pages

DocumentPage[]

Przeanalizowane strony.

paragraphs

DocumentParagraph[]

Wyodrębnione akapity.

sections

DocumentSection[]

Wyodrębnione sekcje.

stringIndexType

StringIndexType

Metoda używana do obliczania przesunięcia i długości ciągu.

styles

DocumentStyle[]

Wyodrębnione style czcionek.

tables

DocumentTable[]

Wyodrębnione tabele.

AnalyzeResultOperation

Stan i wynik operacji analizy.

Nazwa Typ Opis
analyzeResult

AnalyzeResult

Wynik analizy dokumentu.

createdDateTime

string

Data i godzina (UTC) podczas przesyłania operacji analizy.

error

Error

Napotkano błąd podczas analizy dokumentów.

lastUpdatedDateTime

string

Data i godzina (UTC), kiedy stan został ostatnio zaktualizowany.

status

OperationStatus

Stan operacji. notStarted, running, succeeded, or failed

BoundingRegion

Powiązanie wielokąta na określonej stronie danych wejściowych.

Nazwa Typ Opis
pageNumber

integer

1-oparta na stronie numer strony zawierającej region ograniczenia.

polygon

number[]

Powiązanie wielokąta na stronie lub całej strony, jeśli nie zostanie określona. Współrzędne określone względem lewego górnego rogu strony. Liczby reprezentują wartości x, y wierzchołków wielokątów, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.

ContentFormat

Format zawartości w analizowanym wyniku.

Nazwa Typ Opis
markdown

string

Reprezentacja języka Markdown zawartości dokumentu z nagłówkami sekcji, tabelami itp.

text

string

Reprezentacja zwykłego tekstu zawartości dokumentu bez formatowania.

CurrencyValue

Wartość pola waluty.

Nazwa Typ Opis
amount

number

Kwota waluty.

currencyCode

string

Rozwiązano kod waluty (ISO 4217), jeśli istnieje.

currencySymbol

string

Etykieta symbolu waluty, jeśli istnieje.

Document

Obiekt opisujący lokalizację i semantyczną zawartość dokumentu.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące dokument.

confidence

number

Pewność prawidłowego wyodrębnienia dokumentu.

docType

string

Typ dokumentu.

fields

<string,  DocumentField>

Słownik nazwanych wartości pól.

spans

DocumentSpan[]

Lokalizacja dokumentu w kolejności odczytu łączy zawartość.

DocumentBarcode

Obiekt kodu kreskowego.

Nazwa Typ Opis
confidence

number

Pewność prawidłowego wyodrębnienia kodu kreskowego.

kind

DocumentBarcodeKind

Rodzaj kodu kreskowego.

polygon

number[]

Powiązanie wielokąta kodu kreskowego ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątów, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.

span

DocumentSpan

Lokalizacja kodu kreskowego w kolejności odczytu łączy zawartość.

value

string

Wartość kodu kreskowego.

DocumentBarcodeKind

Rodzaj kodu kreskowego.

Nazwa Typ Opis
Aztec

string

Kod Aztec, zgodnie z definicją w normie ISO/IEC 24778:2008.

Codabar

string

Kod kreskowy Codabar, zgodnie z definicją w ANSI/AIM BC3-1995.

Code128

string

Kod kreskowy 128, zgodnie z definicją w normie ISO/IEC 15417:2007.

Code39

string

Kod kreskowy 39, zgodnie z definicją w normie ISO/IEC 16388:2007.

Code93

string

Kod kreskowy 93, zgodnie z definicją w ANSI/AIM BC5-1995.

DataBar

string

Kod kreskowy GS1 DataBar.

DataBarExpanded

string

Rozszerzony kod kreskowy paska danych GS1.

DataMatrix

string

Kod macierzy danych, zgodnie z definicją w normie ISO/IEC 16022:2006.

EAN13

string

GS1 13-cyfrowy numer międzynarodowego artykułu (europejski numer artykułu).

EAN8

string

GS1 8-cyfrowy numer artykułu międzynarodowego (numer artykułu europejskiego).

ITF

string

Przeplatane 2 z 5 kodów kreskowych zgodnie z definicją w ANSI/AIM BC2-1995.

MaxiCode

string

MaxiCode, zgodnie z definicją w normie ISO/IEC 16023:2000.

MicroQRCode

string

Mikro kod QR, zgodnie z definicją w normie ISO/IEC 23941:2022.

PDF417

string

PDF417, zgodnie z definicją w formacie ISO 15438.

QRCode

string

Kod QR, zgodnie z definicją w normie ISO/IEC 18004:2015.

UPCA

string

GS1 12-cyfrowy kod produktu uniwersalnego.

UPCE

string

GS1 6-cyfrowy kod produktu uniwersalnego.

DocumentCaption

Obiekt podpis opisujący tabelę lub rysunek.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące podpis.

content

string

Zawartość podpis.

elements

string[]

Elementy podrzędne podpis.

spans

DocumentSpan[]

Lokalizacja podpis w kolejności odczytu połączona zawartość.

DocumentField

Obiekt reprezentujący zawartość i lokalizację wartości pola.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące pole.

confidence

number

Pewność prawidłowego wyodrębnienia pola.

content

string

Zawartość pola.

spans

DocumentSpan[]

Lokalizacja pola w kolejności odczytu połączona zawartość.

type

DocumentFieldType

Typ danych wartości pola.

valueAddress

AddressValue

Wartość adresu.

valueArray

DocumentField[]

Tablica wartości pól.

valueBoolean

boolean

Wartość logiczna.

valueCountryRegion

string

3-literowa wartość kodu kraju (ISO 3166-1 alfa-3).

valueCurrency

CurrencyValue

Wartość waluty.

valueDate

string

Wartość daty w formacie RRRR-MM-DD (ISO 8601).

valueInteger

integer

Wartość całkowita.

valueNumber

number

Wartość zmiennoprzecinkowa.

valueObject

<string,  DocumentField>

Słownik nazwanych wartości pól.

valuePhoneNumber

string

Wartość numeru telefonu w formacie E.164 (np. +19876543210).

valueSelectionGroup

string[]

Wartość grupy wyboru.

valueSelectionMark

DocumentSelectionMarkState

Wartość znacznika zaznaczenia.

valueSignature

DocumentSignatureType

Obecność podpisu.

valueString

string

Wartość ciągu.

valueTime

string

Wartość czasu w formacie hh:mm:ss (ISO 8601).

DocumentFieldType

Semantyczny typ danych wartości pola.

Nazwa Typ Opis
address

string

Przeanalizowany adres.

array

string

Lista pól podrzędnych tego samego typu.

boolean

string

Wartość logiczna, znormalizowana do wartości true lub false.

countryRegion

string

Kraj/region, znormalizowany do formatu ISO 3166-1 alfa-3 (np. USA).

currency

string

Kwota waluty z opcjonalnym symbolem waluty i jednostką.

date

string

Data znormalizowana do formatu ISO 8601 (RRRR-MM-DD).

integer

string

Liczba całkowita, znormalizowana do 64-bitowej liczby całkowitej z podpisem.

number

string

Liczba zmiennoprzecinkowa, znormalizowana do podwójnej precyzji zmiennoprzecinkowa.

object

string

Nazwana lista pól podrzędnych potencjalnie różnych typów.

phoneNumber

string

Numer telefonu, znormalizowany do formatu E.164 (+{CountryCode}{SubscriberNumber}).

selectionGroup

string

Tablica wybranych wartości ciągów.

selectionMark

string

Czy pole jest zaznaczone?

signature

string

Czy podpis jest obecny?

string

string

Zwykły tekst.

time

string

Czas, znormalizowany do formatu ISO 8601 (hh:mm:ss).

DocumentFigure

Obiekt reprezentujący rysunek w dokumencie.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące rysunek.

caption

DocumentCaption

Podpis skojarzony z rysunkiem.

elements

string[]

Podrzędne elementy rysunku, z wyłączeniem wszelkich podpis lub przypisów dolnych.

footnotes

DocumentFootnote[]

Lista przypisów dolnych skojarzonych z rysunkiem.

spans

DocumentSpan[]

Lokalizacja rysunku w kolejności odczytu połączona zawartość.

DocumentFootnote

Obiekt przypisu dolnego opisujący tabelę lub rysunek.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Regiony ograniczenia obejmujące przypis dolny.

content

string

Zawartość przypisu dolnego.

elements

string[]

Elementy podrzędne przypisu dolnego.

spans

DocumentSpan[]

Lokalizacja przypisu dolnego w kolejności odczytu połączona zawartość.

DocumentFormula

Obiekt formuły.

Nazwa Typ Opis
confidence

number

Pewność prawidłowego wyodrębnienia formuły.

kind

DocumentFormulaKind

Rodzaj formuły.

polygon

number[]

Powiązanie wielokąta formuły ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątów, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.

span

DocumentSpan

Lokalizacja formuły w kolejności odczytu łączy zawartość.

value

string

Wyrażenie LaTex opisujące formułę.

DocumentFormulaKind

Rodzaj formuły.

Nazwa Typ Opis
display

string

Formuła w trybie wyświetlania, która zajmuje całą linię.

inline

string

Formuła osadzona w treści akapitu.

DocumentKeyValueElement

Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące element klucz-wartość.

content

string

Połączona zawartość elementu key-value w kolejności odczytu.

spans

DocumentSpan[]

Lokalizacja elementu key-value w kolejności odczytu połączona zawartość.

DocumentKeyValuePair

Obiekt reprezentujący pole formularza z unikatową etykietą pola (klucz) i wartością pola (może być pusta).

Nazwa Typ Opis
confidence

number

Pewność prawidłowego wyodrębnienia pary klucz-wartość.

key

DocumentKeyValueElement

Etykieta pola pary klucz-wartość.

value

DocumentKeyValueElement

Wartość pola pary klucz-wartość.

DocumentLanguage

Obiekt reprezentujący wykryty język dla danego zakresu tekstu.

Nazwa Typ Opis
confidence

number

Pewność prawidłowego identyfikowania języka.

locale

string

Wykryty język. Wartość może mieć kod języka ISO 639-1 (np. "en", "fr") lub tag języka BCP 47 (np. "zh-Hans").

spans

DocumentSpan[]

Lokalizacja elementów tekstowych w powiązanej zawartości, do których ma zastosowanie język.

DocumentLine

Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.

Nazwa Typ Opis
content

string

Połączona zawartość zawartych elementów w kolejności odczytu.

polygon

number[]

Powiązanie wielokąta wiersza ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątów, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.

spans

DocumentSpan[]

Lokalizacja wiersza w kolejności odczytu łączy zawartość.

DocumentList

Obiekt reprezentujący listę w dokumencie.

Nazwa Typ Opis
items

DocumentListItem[]

Elementy na liście.

spans

DocumentSpan[]

Lokalizacja listy w kolejności odczytu łączy zawartość.

DocumentListItem

Obiekt reprezentujący element listy w dokumencie.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące element listy.

content

string

Zawartość elementu listy.

elements

string[]

Podrzędne elementy elementu listy.

level

integer

Poziom elementu listy (indeksowany 1).

spans

DocumentSpan[]

Lokalizacja elementu listy w kolejności odczytu połączonej zawartości.

DocumentPage

Zawartość i elementy układu wyodrębnione ze strony z danych wejściowych.

Nazwa Typ Opis
angle

number

Ogólna orientacja zawartości w kierunku zegara mierzona w stopniach między (-180, 180).

barcodes

DocumentBarcode[]

Wyodrębnione kody kreskowe ze strony.

formulas

DocumentFormula[]

Wyodrębnione formuły ze strony.

height

number

Wysokość obrazu/pliku PDF w pikselach/calach, odpowiednio.

lines

DocumentLine[]

Wyodrębnione wiersze ze strony, potencjalnie zawierające zarówno elementy tekstowe, jak i wizualne.

pageNumber

integer

Numer strony 1 w dokumencie wejściowym.

selectionMarks

DocumentSelectionMark[]

Wyodrębnione znaczniki zaznaczenia ze strony.

spans

DocumentSpan[]

Lokalizacja strony w kolejności odczytu łączy zawartość.

unit

LengthUnit

Jednostka używana przez właściwości szerokości, wysokości i wielokąta. W przypadku obrazów jednostka jest "piksel". W przypadku formatu PDF jednostka jest "cal".

width

number

Szerokość obrazu/formatu PDF w pikselach/calach, odpowiednio.

words

DocumentWord[]

Wyodrębnione wyrazy ze strony.

DocumentParagraph

Obiekt akapitu składający się z ciągłych linii zwykle ze wspólnym wyrównaniem i odstępami.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Regiony ograniczenia obejmujące akapit.

content

string

Połączona zawartość akapitu w kolejności odczytu.

role

ParagraphRole

Semantyczna rola akapitu.

spans

DocumentSpan[]

Lokalizacja akapitu w kolejności odczytu łączy zawartość.

DocumentSection

Obiekt reprezentujący sekcję w dokumencie.

Nazwa Typ Opis
elements

string[]

Elementy podrzędne sekcji.

spans

DocumentSpan[]

Lokalizacja sekcji w kolejności odczytu łączy zawartość.

DocumentSelectionMark

Obiekt znacznika zaznaczenia reprezentujący pola wyboru, przyciski radiowe i inne elementy wskazujące zaznaczenie.

Nazwa Typ Opis
confidence

number

Pewność prawidłowego wyodrębnienia znacznika wyboru.

polygon

number[]

Powiązanie wielokąta znacznika wyboru ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątów, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.

span

DocumentSpan

Lokalizacja znacznika wyboru w kolejności odczytu łączy zawartość.

state

DocumentSelectionMarkState

Stan znacznika wyboru.

DocumentSelectionMarkState

Stan znacznika wyboru.

Nazwa Typ Opis
selected

string

Zaznaczony jest znacznik wyboru, często wskazywany przez znacznik wyboru = lub krzyż X wewnątrz znacznika zaznaczenia.

unselected

string

Znacznik wyboru nie jest zaznaczony.

DocumentSignatureType

Obecność podpisu.

Nazwa Typ Opis
signed

string

Wykryto podpis.

unsigned

string

Nie wykryto podpisów.

DocumentSpan

Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.

Nazwa Typ Opis
length

integer

Liczba znaków w zawartości reprezentowanej przez zakres.

offset

integer

Zero oparty na indeksie zawartości reprezentowanej przez zakres.

DocumentStyle

Obiekt reprezentujący obserwowane style tekstu.

Nazwa Typ Opis
backgroundColor

string

Kolor tła w formacie szesnastkowym #rrggbb..

color

string

Kolor pierwszego planu w formacie szesnastkowym #rrggbb.

confidence

number

Pewność prawidłowego identyfikowania stylu.

fontStyle

FontStyle

Styl czcionki.

fontWeight

FontWeight

Waga czcionki.

isHandwritten

boolean

Czy zawartość jest odręczna?

similarFontFamily

string

Wizualnie najbardziej podobna czcionka z zestawu obsługiwanych rodzin czcionek z czcionkami rezerwowymi zgodnie z konwencją CSS (np. "Arial, sans-serif").

spans

DocumentSpan[]

Lokalizacja elementów tekstowych w powiązanej zawartości, do których ma zastosowanie styl.

DocumentTable

Obiekt tabeli składający się z komórek tabeli rozmieszczonych w układzie prostokątnym.

Nazwa Typ Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące tabelę.

caption

DocumentCaption

Podpis skojarzony z tabelą.

cells

DocumentTableCell[]

Komórki zawarte w tabeli.

columnCount

integer

Liczba kolumn w tabeli.

footnotes

DocumentFootnote[]

Lista przypisów dolnych skojarzonych z tabelą.

rowCount

integer

Liczba wierszy w tabeli.

spans

DocumentSpan[]

Lokalizacja tabeli w kolejności odczytu łączy zawartość.

DocumentTableCell

Obiekt reprezentujący lokalizację i zawartość komórki tabeli.

Nazwa Typ Domyślna wartość Opis
boundingRegions

BoundingRegion[]

Powiązane regiony obejmujące komórkę tabeli.

columnIndex

integer

Indeks kolumn komórki.

columnSpan

integer

1

Liczba kolumn obejmujących tę komórkę.

content

string

Połączona zawartość komórki tabeli w kolejności odczytu.

elements

string[]

Podrzędne elementy komórki tabeli.

kind

DocumentTableCellKind

content

Rodzaj komórki tabeli.

rowIndex

integer

Indeks wiersza komórki.

rowSpan

integer

1

Liczba wierszy obejmujących tę komórkę.

spans

DocumentSpan[]

Lokalizacja komórki tabeli w kolejności odczytu łączy zawartość.

DocumentTableCellKind

Rodzaj komórki tabeli.

Nazwa Typ Opis
columnHeader

string

Opisuje zawartość kolumny.

content

string

Zawiera główną zawartość/dane.

description

string

Opisuje zawartość w (częściach) tabeli.

rowHeader

string

Opisuje zawartość wiersza.

stubHead

string

Opisuje nagłówki wierszy, zwykle znajdujące się w lewym górnym rogu tabeli.

DocumentWord

Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielonych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.

Nazwa Typ Opis
confidence

number

Pewność prawidłowego wyodrębnienia wyrazu.

content

string

Zawartość tekstowa wyrazu.

polygon

number[]

Powiązanie wielokąta wyrazu ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątów, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.

span

DocumentSpan

Lokalizacja wyrazu w kolejności odczytu połączona zawartość.

Error

Obiekt błędu.

Nazwa Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

Error[]

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.

innererror

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

message

string

Czytelna dla człowieka reprezentacja błędu.

target

string

Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

Nazwa Typ Opis
error

Error

Informacje o błędzie.

FontStyle

Styl czcionki.

Nazwa Typ Opis
italic

string

Znaki są wizualnie skośne po prawej stronie.

normal

string

Znaki są zwykle reprezentowane.

FontWeight

Waga czcionki.

Nazwa Typ Opis
bold

string

Znaki są reprezentowane za pomocą grubszych pociągnięć.

normal

string

Znaki są zwykle reprezentowane.

InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

innererror

InnerError

Błąd wewnętrzny.

message

string

Czytelna dla człowieka reprezentacja błędu.

LengthUnit

Jednostka używana przez właściwości szerokości, wysokości i wielokąta. W przypadku obrazów jednostka jest "piksel". W przypadku formatu PDF jednostka jest "cal".

Nazwa Typ Opis
inch

string

Jednostka długości plików PDF.

pixel

string

Jednostka długości dla plików obrazów.

OperationStatus

Stan operacji.

Nazwa Typ Opis
canceled

string

Operacja została anulowana.

completed

string

Operacja została ukończona.

failed

string

Operacja nie powiodła się.

notStarted

string

Operacja nie została jeszcze uruchomiona.

running

string

Operacja jest w toku.

succeeded

string

Operacja zakończyła się pomyślnie.

ParagraphRole

Semantyczna rola akapitu.

Nazwa Typ Opis
footnote

string

Notatka zwykle umieszczana po głównej zawartości na stronie.

formulaBlock

string

Blok formuł, często ze współdzieloną wyrównaniem.

pageFooter

string

Tekst w dolnej krawędzi strony.

pageHeader

string

Tekst w górnej części strony.

pageNumber

string

Numer strony.

sectionHeading

string

Pod nagłówkiem opisującym sekcję dokumentu.

title

string

Tytuł najwyższego poziomu opisujący cały dokument.

StringIndexType

Metoda używana do obliczania przesunięcia i długości ciągu.

Nazwa Typ Opis
textElements

string

Znak wyświetlany postrzegany przez użytkownika lub klaster grafu zdefiniowany przez unicode 8.0.0.

unicodeCodePoint

string

Jednostka znaków reprezentowana przez pojedynczy punkt kodu Unicode. Używany przez język Python 3.

utf16CodeUnit

string

Jednostka znaków reprezentowana przez 16-bitową jednostkę kodu Unicode. Używane przez języki JavaScript, Java i .NET.