Azure AI Document Intelligence (rozpoznawanie formularzy)
Wyodrębnia tekst (drukowany i odręczny OCR) oraz dodatkowe informacje (tabele, pola, pary wartości klucza) z plików PDF, obrazów lub dokumentów pakietu Microsoft Office oraz formularzy w dane ustrukturyzowane na podstawie wstępnie wytrenowanych modeli (układ, faktura, potwierdzenie, identyfikator, wizytówka) lub niestandardowy model utworzony przez zestaw reprezentatywnych formularzy szkoleniowych przy użyciu rozumienia dokumentów obsługiwanych przez sztuczną inteligencję.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Departament Obrony USA (DoD) |
| Power Apps | - | Niedostępne |
| Power Automate - narzędzie do automatyzacji procesów | Standard | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft |
| adres URL | https://aka.ms/formrecognizer |
| formrecog_contact@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
| Witryna internetowa | https://aka.ms/formrecognizer |
| Zasady ochrony prywatności | https://aka.ms/form-recognizer/privacy |
| Kategorie | AI; Analiza biznesowa |
Łącznik azure AI Document Intelligence (dawniej Rozpoznawanie formularzy) zapewnia integrację z analizą dokumentów usługi Azure AI. Umożliwia analizowanie i wyodrębnianie informacji z formularzy, faktur, paragonów, wizytówek, dokumentów identyfikatorów i wielu innych typów dokumentów.
Wymagania wstępne
Do korzystania z tej integracji potrzebny będzie zasób analizy dokumentów usługi Azure AI w witrynie Azure Portal. Utwórz link do zasobu. Otrzymasz punkt końcowy i klucz do uwierzytelniania aplikacji. Aby nawiązać połączenie, podaj klucz konta, adres URL witryny i wybierz pozycję Utwórz połączenie. Aby uzyskać informacje na temat kosztów operacji w połączeniu, dowiedz się więcej tutaj.
Jak uzyskać poświadczenia
- Otwórz zasób analizy dokumentów w witrynie Azure Portal (zobacz Wymagania wstępne).
- Wybierz pozycję Klucze i punkt końcowy w obszarze Zarządzanie zasobami
- Skopiuj punkt końcowy i klucz i użyj ich do utworzenia nowego połączenia.
Wprowadzenie do łącznika
Najprostszym sposobem wypróbowania łącznika analizy dokumentów jest użycie wstępnie utworzonych modeli (wstępnie utworzone faktury, wstępnie utworzony układ itp.). Podaj plik PDF lub obraz dokumentu. Analizuj przy użyciu operacji łącznika na podstawie typu dokumentu i sprawdź wykryte pola. Pełna lista modeli i obsługiwanych funkcji w tym miejscu.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Klucz API | Podaj nazwę zasobu Document Intellignce i klucz interfejsu API. | Wszystkie regiony | Udostępnialne |
| Tożsamość zarządzana usługi Logic Apps | Tworzenie połączenia przy użyciu tożsamości zarządzanej usługi LogicApps | Tylko USŁUGA LOGICAPPS | Udostępnialne |
| Microsoft Entra ID Integrated | Uzyskiwanie dostępu za pomocą identyfikatora Entra firmy Microsoft | Wszystkie regiony | Nie można udostępniać |
| Domyślne [PRZESTARZAŁE] | Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. | Wszystkie regiony | Nie można udostępniać |
Klucz interfejsu API
Identyfikator uwierzytelniania: keyBasedAuth
Dotyczy: wszystkie regiony
Podaj nazwę zasobu Document Intellignce i klucz interfejsu API.
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz konta | securestring | Klucz konta analizy dokumentów | Prawda |
| Adres URL punktu końcowego | ciąg | Adres URL punktu końcowego analizy dokumentów (przykład: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Prawda |
Tożsamość zarządzana usługi Logic Apps
Identyfikator uwierzytelniania: managedIdentityAuth
Dotyczy: tylko USŁUGA LOGICAPPS
Tworzenie połączenia przy użyciu tożsamości zarządzanej usługi LogicApps
Jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power jest udostępniana innemu użytkownikowi, połączenie jest również udostępniane. Aby uzyskać więcej informacji, zobacz Omówienie łączników dla aplikacji kanwy — Power Apps | Microsoft Docs
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Tożsamość zarządzana usługi LogicApps | managedIdentity | Logowanie się przy użyciu tożsamości zarządzanej usługi Logic Apps | Prawda |
| Adres URL punktu końcowego | ciąg | Adres URL punktu końcowego analizy dokumentów (przykład: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Prawda |
Microsoft Entra ID Zintegrowany
Identyfikator uwierzytelniania: oauth
Dotyczy: wszystkie regiony
Uzyskiwanie dostępu za pomocą identyfikatora Entra firmy Microsoft
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Adres URL punktu końcowego | ciąg | Adres URL punktu końcowego analizy dokumentów (przykład: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Prawda |
Domyślne [PRZESTARZAŁE]
Dotyczy: wszystkie regiony
Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz konta | securestring | Klucz konta analizy dokumentów | Prawda |
| Adres URL punktu końcowego | ciąg | Adres URL punktu końcowego analizy dokumentów (przykład: https://your-documentintelligence-resource.cognitiveservices.azure.com/) |
Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 1200 | 60 sekund |
Akcje
| Analizowanie dokumentu dla wstępnie utworzonych lub niestandardowych modeli (interfejs API w wersji 3.x) |
Wyodrębnij pary klucz-wartość, tabele i semantyczne wartości z danego dokumentu (interfejs API w wersji 3.x). |
| Analizowanie dokumentu dla wstępnie utworzonych lub niestandardowych modeli (interfejs API w wersji 4.x) |
Wyodrębnij pary klucz-wartość, tabele i wartości semantyczne z danego dokumentu (interfejs API w wersji 4.x). |
| Analizowanie dokumentu identyfikatora (przestarzałe) [PRZESTARZAŁE] |
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu identyfikatora (przestarzałe). |
| Analizowanie faktury (przestarzałe) [PRZESTARZAŁE] |
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu faktury (przestarzałe). |
| Analizowanie formularza niestandardowego (przestarzałe) [PRZESTARZAŁE] |
Wyodrębnij pary klucz-wartość, tabele i wartości semantyczne z danego dokumentu (przestarzałe). |
| Analizowanie potwierdzenia (przestarzałe) [PRZESTARZAŁE] |
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu potwierdzenia (przestarzałe). |
| Analizowanie wizytówki (przestarzałe) [PRZESTARZAŁE] |
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu wizytówki (przestarzałe). |
| Analizuj układ (przestarzałe) [PRZESTARZAŁE] |
Wyodrębnianie informacji o tekście i układzie z danego dokumentu (przestarzałe). |
| Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 3.1) |
Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 3.1). |
| Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 4.x) |
Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 4.x). |
Analizowanie dokumentu dla wstępnie utworzonych lub niestandardowych modeli (interfejs API w wersji 3.x)
Wyodrębnij pary klucz-wartość, tabele i semantyczne wartości z danego dokumentu (interfejs API w wersji 3.x).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wersja interfejsu API analizy dokumentów
|
api-version | True | string |
Wersja interfejsu API analizy dokumentów. |
|
Identyfikator modelu
|
modelId | True | string |
Wstępnie utworzone identyfikatory modelu: wstępnie utworzony-odczyt, wstępnie utworzony układ, wstępnie utworzony dokument, prebuilt-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us. Niestandardowy format modelId — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unikatowa nazwa modelu. |
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Wskazówka ustawień regionalnych na potrzeby rozpoznawania tekstu i analizy dokumentów. Wartość może zawierać tylko kod języka (np. "en", "fr") lub tag języka BCP 47 (np. "en-US"). |
|
|
Typ indeksu ciągu
|
stringIndexType | string |
Metoda używana do obliczania przesunięcia i długości ciągu. Obsługiwane opcje: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Funkcje opcjonalne i Premium
|
features | array |
Lista opcjonalnych funkcji analizy (takich jak ocrHighResolution, języki, kody kreskowe, formuły, keyValuePairs i styleFont). |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG, PNG, BMP, TIFF) do analizy. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy.
Analizowanie dokumentu dla wstępnie utworzonych lub niestandardowych modeli (interfejs API w wersji 4.x)
Wyodrębnij pary klucz-wartość, tabele i wartości semantyczne z danego dokumentu (interfejs API w wersji 4.x).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wersja interfejsu API analizy dokumentów
|
api-version | True | string |
Wersja interfejsu API analizy dokumentów. |
|
Identyfikator modelu
|
modelId | True | string |
Wstępnie utworzone identyfikatory modelu: wstępnie skompilowany odczyt, wstępnie utworzony układ, wstępnie skompilowany-businessCard, prebuilt-idDocument, prebuilt-invoice, prebuilt-receipt, prebuilt-tax.us.w2, prebuilt-vaccinationCard, prebuilt-healthInsuranceCard.us, prebuilt-tax.us.1098, prebuilt-tax.us.1098E, prebuilt-tax.us.1098T, prebuilt-contract itp. Niestandardowy format modelId — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unikatowa nazwa modelu. |
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG, PNG, BMP, TIFF) do analizy. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Wskazówka ustawień regionalnych na potrzeby rozpoznawania tekstu i analizy dokumentów. Wartość może zawierać tylko kod języka (np. "en", "fr") lub tag języka BCP 47 (np. "en-US"). |
|
|
Typ indeksu ciągu
|
stringIndexType | string |
Metoda używana do obliczania przesunięcia i długości ciągu. Obsługiwane opcje: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Funkcje opcjonalne i Premium
|
features | array |
Lista opcjonalnych funkcji analizy (takich jak ocrHighResolution, języki, kody kreskowe, formuły, keyValuePairs, styleFont i queryFields). |
|
|
Pola zapytania
|
queryFields | array |
Lista dodatkowych pól do wyodrębnienia. Np. "NumberOfGuests,StoreNumber" |
|
|
Format zawartości wyjściowej
|
outputContentFormat | string |
Format zawartości najwyższego poziomu wyników analizy. |
Zwraca
Stan i wynik operacji analizy.
Analizowanie dokumentu identyfikatora (przestarzałe) [PRZESTARZAŁE]
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu identyfikatora (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Dołącz szczegóły tekstu
|
includeTextDetails | boolean |
Dołącz wiersze tekstu i odwołania do elementów w wyniku. Wartość domyślna: Prawda (tylko dla łącznika FR). |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG lub PNG) do przeanalizowania. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy w kolejce.
Analizowanie faktury (przestarzałe) [PRZESTARZAŁE]
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu faktury (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Dołącz szczegóły tekstu
|
includeTextDetails | boolean |
Dołącz wiersze tekstu i odwołania do elementów w wyniku. Wartość domyślna: Prawda (tylko dla łącznika FR). |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Ustawienia regionalne faktury. Obsługiwane ustawienia regionalne obejmują: en-US. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG lub PNG) do przeanalizowania. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy w kolejce.
Analizowanie formularza niestandardowego (przestarzałe) [PRZESTARZAŁE]
Wyodrębnij pary klucz-wartość, tabele i wartości semantyczne z danego dokumentu (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator modelu
|
modelId | True | string |
Format — uuid. Identyfikator modelu. |
|
Dołącz szczegóły tekstu
|
includeTextDetails | boolean |
Dołącz wiersze tekstu i odwołania do elementów w wyniku. Wartość domyślna: Prawda (tylko dla łącznika FR). |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG lub PNG) do przeanalizowania. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy w kolejce.
Analizowanie potwierdzenia (przestarzałe) [PRZESTARZAŁE]
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu potwierdzenia (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Dołącz szczegóły tekstu
|
includeTextDetails | boolean |
Dołącz wiersze tekstu i odwołania do elementów w wyniku. Wartość domyślna: Prawda (tylko dla łącznika FR). |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Ustawienia regionalne faktury. Obsługiwane ustawienia regionalne obejmują: en-US. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG lub PNG) do przeanalizowania. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy w kolejce.
Analizowanie wizytówki (przestarzałe) [PRZESTARZAŁE]
Wyodrębnij tekst pola i wartości semantyczne z danego dokumentu wizytówki (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Dołącz szczegóły tekstu
|
includeTextDetails | boolean |
Dołącz wiersze tekstu i odwołania do elementów w wyniku. Wartość domyślna: Prawda (tylko dla łącznika FR). |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Ustawienia regionalne faktury. Obsługiwane ustawienia regionalne obejmują: en-US. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG lub PNG) do przeanalizowania. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy w kolejce.
Analizuj układ (przestarzałe) [PRZESTARZAŁE]
Wyodrębnianie informacji o tekście i układzie z danego dokumentu (przestarzałe).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji o fakturze z poszczególnych stron i zakresu stron (takich jak strona 2 i stron 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Język
|
language | string |
Kod języka BCP-47 tekstu w dokumencie. |
|
|
Kolejność czytania
|
readingOrder | string |
Opcjonalny parametr określający algorytm kolejności odczytu, który ma być stosowany podczas porządkowania wyodrębniania elementów tekstowych. Może to być wartość "podstawowa" lub "naturalna". Wartość domyślna to podstawowa, jeśli nie zostanie określona. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG lub PNG) do przeanalizowania. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy w kolejce.
Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 3.1)
Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 3.1).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator klasyfikatora
|
classifierId | True | string |
Format — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unikatowa nazwa klasyfikatora. |
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji z poszczególnych stron i zakresu stron (takich jak strona 2 i strony 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Wskazówka ustawień regionalnych na potrzeby rozpoznawania tekstu i analizy dokumentów. Wartość może zawierać tylko kod języka (np. "en", "fr") lub tag języka BCP 47 (np. "en-US"). |
|
|
Typ indeksu ciągu
|
stringIndexType | string |
Metoda używana do obliczania przesunięcia i długości ciągu. Obsługiwane opcje: textElements, unicodeCodePoint, utf16CodeUnit. |
|
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG, PNG, BMP, TIFF) do analizy. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
Zwraca
Stan i wynik operacji analizy.
Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 4.x)
Klasyfikowanie dokumentu za pomocą klasyfikatora dokumentów (interfejs API w wersji 4.x).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wersja interfejsu API analizy dokumentów
|
api-version | True | string |
Wersja interfejsu API analizy dokumentów. |
|
Identyfikator klasyfikatora
|
classifierId | True | string |
Format — [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}. Unikatowa nazwa klasyfikatora. |
|
Zawartość pliku dokumentu/obrazu
|
inputFileContent | binary |
Plik PDF lub obraz (JPG, PNG, BMP, TIFF) do analizy. |
|
|
Adres URL dokumentu/obrazu
|
inputFileUrl | string |
Ścieżka adresu URL dla pliku wejściowego. Alternatywa dla zawartości pliku dokumentu/obrazu. |
|
|
Tryb podziału
|
split | string |
Zachowanie dzielenia plików. |
|
|
Strony
|
pages | string |
Wybór strony dla wielostronicowych dokumentów PDF i TIFF w celu wyodrębnienia informacji z poszczególnych stron i zakresu stron (takich jak strona 2 i strony 5–7) przez wprowadzenie numerów stron i zakresów rozdzielonych przecinkami (np. "2, 5–7"). Jeśli nie zostanie ustawiona, wszystkie strony zostaną przetworzone. |
|
|
Lokalizacja
|
locale | string |
Wskazówka ustawień regionalnych na potrzeby rozpoznawania tekstu i analizy dokumentów. Wartość może zawierać tylko kod języka (np. "en", "fr") lub tag języka BCP 47 (np. "en-US"). |
|
|
Typ indeksu ciągu
|
stringIndexType | string |
Metoda używana do obliczania przesunięcia i długości ciągu. Obsługiwane opcje: textElements, unicodeCodePoint, utf16CodeUnit. |
Zwraca
Stan i wynik operacji analizy.
Definicje
OperationStatus
LayoutAnalyzeOperationResult
Stan i wynik operacji analizy w kolejce.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | OperationStatus |
Stan operacji w kolejce. |
|
createdDateTime
|
createdDateTime | string |
Data i godzina (UTC) przesłana operacja analizy. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data i godzina (UTC), kiedy stan jest ostatnio aktualizowany. |
|
analyzeResult
|
analyzeResult | LayoutAnalyzeResult |
Analizowanie wyniku operacji. |
InvoiceAnalyzeOperationResult
Stan i wynik operacji analizy w kolejce.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | OperationStatus |
Stan operacji w kolejce. |
|
createdDateTime
|
createdDateTime | string |
Data i godzina (UTC) przesłana operacja analizy. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data i godzina (UTC), kiedy stan jest ostatnio aktualizowany. |
|
analyzeResult
|
analyzeResult | InvoiceAnalyzeResult |
Analizowanie wyniku operacji. |
BusinessCardAnalyzeOperationResult
Stan i wynik operacji analizy w kolejce.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | OperationStatus |
Stan operacji w kolejce. |
|
createdDateTime
|
createdDateTime | string |
Data i godzina (UTC) przesłana operacja analizy. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data i godzina (UTC), kiedy stan jest ostatnio aktualizowany. |
|
analyzeResult
|
analyzeResult | BusinessCardAnalyzeResult |
Analizowanie wyniku operacji. |
ReceiptAnalyzeOperationResult
Stan i wynik operacji analizy w kolejce.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | OperationStatus |
Stan operacji w kolejce. |
|
createdDateTime
|
createdDateTime | string |
Data i godzina (UTC) przesłana operacja analizy. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data i godzina (UTC), kiedy stan jest ostatnio aktualizowany. |
|
analyzeResult
|
analyzeResult | ReceiptAnalyzeResult |
Analizowanie wyniku operacji. |
IdAnalyzeOperationResult
Stan i wynik operacji analizy w kolejce.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | OperationStatus |
Stan operacji w kolejce. |
|
createdDateTime
|
createdDateTime | string |
Data i godzina (UTC) przesłana operacja analizy. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data i godzina (UTC), kiedy stan jest ostatnio aktualizowany. |
|
analyzeResult
|
analyzeResult | IdAnalyzeResult |
Analizowanie wyniku operacji. |
CustomFormsAnalyzeOperationResult
Stan i wynik operacji analizy w kolejce.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | OperationStatus |
Stan operacji w kolejce. |
|
createdDateTime
|
createdDateTime | string |
Data i godzina (UTC) przesłana operacja analizy. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | string |
Data i godzina (UTC), kiedy stan jest ostatnio aktualizowany. |
|
analyzeResult
|
analyzeResult | CustomFormsAnalyzeResult |
Analizowanie wyniku operacji. |
FormOperationError
Błąd zgłoszony podczas operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
komunikat
|
message | string |
Komunikat o błędzie. |
LayoutAnalyzeResult
Analizowanie wyniku operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
Wersja schematu używana dla tego wyniku. |
|
readResults
|
readResults | array of ReadResult |
Tekst wyodrębniony z danych wejściowych. |
|
pageResults
|
pageResults | array of PageResult |
Informacje na poziomie strony wyodrębnione z danych wejściowych. |
|
Błędy
|
errors | array of FormOperationError |
Lista błędów zgłoszonych podczas operacji analizy. |
InvoiceAnalyzeResult
Analizowanie wyniku operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
Wersja schematu używana dla tego wyniku. |
|
readResults
|
readResults | array of ReadResult |
Tekst wyodrębniony z danych wejściowych. |
|
pageResults
|
pageResults | array of PageResult |
Informacje na poziomie strony wyodrębnione z danych wejściowych. |
|
documentResults
|
documentResults | array of InvoiceDocumentResult |
Informacje na poziomie dokumentu wyodrębnione z danych wejściowych. |
|
Błędy
|
errors | array of FormOperationError |
Lista błędów zgłoszonych podczas operacji analizy. |
BusinessCardAnalyzeResult
Analizowanie wyniku operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
Wersja schematu używana dla tego wyniku. |
|
readResults
|
readResults | array of ReadResult |
Tekst wyodrębniony z danych wejściowych. |
|
pageResults
|
pageResults | array of PageResult |
Informacje na poziomie strony wyodrębnione z danych wejściowych. |
|
documentResults
|
documentResults | array of BusinessCardDocumentResult |
Informacje na poziomie dokumentu wyodrębnione z danych wejściowych. |
|
Błędy
|
errors | array of FormOperationError |
Lista błędów zgłoszonych podczas operacji analizy. |
ReceiptAnalyzeResult
Analizowanie wyniku operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
Wersja schematu używana dla tego wyniku. |
|
readResults
|
readResults | array of ReadResult |
Tekst wyodrębniony z danych wejściowych. |
|
pageResults
|
pageResults | array of PageResult |
Informacje na poziomie strony wyodrębnione z danych wejściowych. |
|
documentResults
|
documentResults | array of ReceiptDocumentResult |
Informacje na poziomie dokumentu wyodrębnione z danych wejściowych. |
|
Błędy
|
errors | array of FormOperationError |
Lista błędów zgłoszonych podczas operacji analizy. |
IdAnalyzeResult
Analizowanie wyniku operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
Wersja schematu używana dla tego wyniku. |
|
readResults
|
readResults | array of ReadResult |
Tekst wyodrębniony z danych wejściowych. |
|
pageResults
|
pageResults | array of PageResult |
Informacje na poziomie strony wyodrębnione z danych wejściowych. |
|
documentResults
|
documentResults | array of IdDocumentResult |
Informacje na poziomie dokumentu wyodrębnione z danych wejściowych. |
|
Błędy
|
errors | array of FormOperationError |
Lista błędów zgłoszonych podczas operacji analizy. |
CustomFormsAnalyzeResult
Analizowanie wyniku operacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja
|
version | string |
Wersja schematu używana dla tego wyniku. |
|
readResults
|
readResults | array of ReadResult |
Tekst wyodrębniony z danych wejściowych. |
|
pageResults
|
pageResults | array of PageResult |
Informacje na poziomie strony wyodrębnione z danych wejściowych. |
|
documentResults
|
documentResults | array of CustomFormsDocumentResult |
Informacje na poziomie dokumentu wyodrębnione z danych wejściowych. |
|
Błędy
|
errors | array of FormOperationError |
Lista błędów zgłoszonych podczas operacji analizy. |
ReadResult
Tekst wyodrębniony ze strony w dokumencie wejściowym.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Numer strony opartej na 1 w dokumencie wejściowym. |
|
kąt
|
angle | float |
Ogólna orientacja tekstu w kierunku wskazówek zegara mierzona w stopniach między (-180, 180). |
|
width
|
width | float |
Szerokość obrazu/pliku PDF odpowiednio w pikselach/calach. |
|
height
|
height | float |
Wysokość obrazu/PLIKU PDF w pikselach/calach, odpowiednio. |
|
jednostka
|
unit | string |
Jednostka używana przez właściwości width, height i boundingBox. W przypadku obrazów jednostka jest "piksel". W przypadku formatu PDF jednostka jest "cal". |
|
Linie
|
lines | array of TextLine |
Jeśli właściwość includeTextDetails jest ustawiona na true, lista rozpoznanych wierszy tekstu. Maksymalna liczba zwracanych wierszy wynosi 300 na stronę. Linie są sortowane od góry do dołu, od lewej do prawej, chociaż w niektórych przypadkach bliskość jest traktowana z wyższym priorytetem. Ponieważ kolejność sortowania zależy od wykrytego tekstu, może ona ulec zmianie między obrazami i aktualizacjami wersji OCR. W związku z tym logika biznesowa powinna być oparta na rzeczywistej lokalizacji wiersza zamiast kolejności. |
Wiersz tekstu
Obiekt reprezentujący wyodrębniony wiersz tekstu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SMS
|
text | string |
Zawartość tekstowa wiersza. |
|
boundingBox
|
boundingBox | BoundingBox |
Pole ograniczenia ćwiartki z współrzędnymi określonymi względem lewej górnej części oryginalnego obrazu. Osiem liczb reprezentuje cztery punkty, zgodnie z ruchem wskazówek zegara z lewego górnego rogu względem orientacji tekstu. Dla obrazu współrzędne (x, y) są mierzone w pikselach. W przypadku formatu PDF współrzędne (x, y) są mierzone w calach. |
|
words
|
words | array of TextWord |
Lista wyrazów w wierszu tekstu. |
TekstWord
Obiekt reprezentujący wyraz.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SMS
|
text | string |
Zawartość tekstowa wyrazu. |
|
boundingBox
|
boundingBox | BoundingBox |
Pole ograniczenia ćwiartki z współrzędnymi określonymi względem lewej górnej części oryginalnego obrazu. Osiem liczb reprezentuje cztery punkty, zgodnie z ruchem wskazówek zegara z lewego górnego rogu względem orientacji tekstu. Dla obrazu współrzędne (x, y) są mierzone w pikselach. W przypadku formatu PDF współrzędne (x, y) są mierzone w calach. |
|
pewność
|
confidence | Confidence |
Wartość ufności. |
Pole ograniczenia
Pole ograniczenia ćwiartki z współrzędnymi określonymi względem lewej górnej części oryginalnego obrazu. Osiem liczb reprezentuje cztery punkty, zgodnie z ruchem wskazówek zegara z lewego górnego rogu względem orientacji tekstu. Dla obrazu współrzędne (x, y) są mierzone w pikselach. W przypadku formatu PDF współrzędne (x, y) są mierzone w calach.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
float |
PageResult
Wyodrębnione informacje z jednej strony.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Numer strony. |
|
clusterId
|
clusterId | integer |
Identyfikator klastra. |
|
Pary kluczy-wartość
|
keyValuePairs | array of KeyValuePair |
Lista par klucz-wartość wyodrębnionych ze strony. |
|
tables
|
tables | array of DataTable |
Lista tabel danych wyodrębnionych ze strony. |
KeyValuePair
Informacje o wyodrębnionej parze klucz-wartość.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
etykieta
|
label | string |
Etykieta zdefiniowana przez użytkownika dla wpisu pary klucz/wartość. |
|
klucz
|
key | KeyValueElement |
Informacje o wyodrębnionym kluczu lub wartości w parze klucz-wartość. |
|
value
|
value | KeyValueElement |
Informacje o wyodrębnionym kluczu lub wartości w parze klucz-wartość. |
|
pewność
|
confidence | Confidence |
Wartość ufności. |
KeyValueElement
Informacje o wyodrębnionym kluczu lub wartości w parze klucz-wartość.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
SMS
|
text | string |
Zawartość tekstowa klucza lub wartości. |
|
boundingBox
|
boundingBox | BoundingBox |
Pole ograniczenia ćwiartki z współrzędnymi określonymi względem lewej górnej części oryginalnego obrazu. Osiem liczb reprezentuje cztery punkty, zgodnie z ruchem wskazówek zegara z lewego górnego rogu względem orientacji tekstu. Dla obrazu współrzędne (x, y) są mierzone w pikselach. W przypadku formatu PDF współrzędne (x, y) są mierzone w calach. |
|
pierwiastki
|
elements | array of ElementReference |
Jeśli parametr includeTextDetails ma wartość true, lista odwołań do elementów tekstowych stanowi ten klucz lub wartość. |
ElementReference
DataTable
Informacje o wyodrębnionej tabeli zawartej na stronie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wiersze
|
rows | integer |
Liczba wierszy. |
|
columns
|
columns | integer |
Liczba kolumn. |
|
Komórek
|
cells | array of DataTableCell |
Lista komórek zawartych w tabeli. |
DataTableCell
Informacje o wyodrębnionej komórce w tabeli.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rowIndex
|
rowIndex | integer |
Indeks wiersza komórki. |
|
columnIndex
|
columnIndex | integer |
Indeks kolumn komórki. |
|
rowSpan (rozpiętość)
|
rowSpan | integer |
Liczba wierszy obejmujących tę komórkę. |
|
columnSpan
|
columnSpan | integer |
Liczba kolumn obejmujących tę komórkę. |
|
SMS
|
text | string |
Zawartość tekstowa komórki. |
|
boundingBox
|
boundingBox | BoundingBox |
Pole ograniczenia ćwiartki z współrzędnymi określonymi względem lewej górnej części oryginalnego obrazu. Osiem liczb reprezentuje cztery punkty, zgodnie z ruchem wskazówek zegara z lewego górnego rogu względem orientacji tekstu. Dla obrazu współrzędne (x, y) są mierzone w pikselach. W przypadku formatu PDF współrzędne (x, y) są mierzone w calach. |
|
pierwiastki
|
elements | array of ElementReference |
Jeśli właściwość includeTextDetails jest ustawiona na true, lista odwołań do elementów tekstowych stanowi tę komórkę tabeli. |
|
isHeader
|
isHeader | boolean |
Zwróć, jeśli bieżąca komórka jest komórką nagłówka. |
|
isFooter
|
isFooter | boolean |
Zwróć, jeśli bieżąca komórka jest komórką stopki. |
InvoiceDocumentResult
Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
docType
|
docType | string |
Typ dokumentu. |
|
pageRange
|
pageRange | array of integer |
Numer pierwszej i ostatniej strony, w której znajduje się dokument. |
|
pola
|
fields | InvoiceFields |
Pola faktury dla wersji 2.1. |
BusinessCardDocumentResult
Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
docType
|
docType | string |
Typ dokumentu. |
|
pageRange
|
pageRange | array of integer |
Numer pierwszej i ostatniej strony, w której znajduje się dokument. |
|
pola
|
fields | BusinessCardFields |
Pola wizytówki dla wersji 2.1. |
CustomFormsDocumentResult
Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
docType
|
docType | string |
Typ dokumentu. |
|
pageRange
|
pageRange | array of integer |
Numer pierwszej i ostatniej strony, w której znajduje się dokument. |
|
Pola formularza
|
_fields | array of CustomFormsFields |
Tablica pól z właściwościami fieldName i fieldValue. |
ReceiptDocumentResult
Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
docType
|
docType | string |
Typ dokumentu. |
|
pageRange
|
pageRange | array of integer |
Numer pierwszej i ostatniej strony, w której znajduje się dokument. |
|
pola
|
fields | ReceiptFields |
Receiptfields dla 2.1. |
IdDocumentResult
Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
docType
|
docType | string |
Typ dokumentu. |
|
pageRange
|
pageRange | array of integer |
Numer pierwszej i ostatniej strony, w której znajduje się dokument. |
|
pola
|
fields | IdFields |
Pola identyfikatora dokumentu dla wersji 2.1. |
CustomFormsFields
Pola formularza niestandardowego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa pola
|
fieldName | string | |
|
Wartość pola
|
fieldValue | FieldValue |
Przewidywany obiekt wartości pola. |
Pola faktur
Pola faktury dla wersji 2.1.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kwota należna (tekst)
|
AmountDue.text | string |
Zwraca kwotę należną zgodnie z zapisem na fakturze. |
|
Kwota należna (liczba)
|
AmountDue.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Pewność, że kwota jest należna
|
AmountDue.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres rozliczeniowy
|
BillingAddress.text | string | |
|
Pewność adresu rozliczeniowego
|
BillingAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Odbiorca adresu rozliczeniowego
|
BillingAddressRecipient.text | string | |
|
Pewność adresata adresu rozliczeniowego
|
BillingAddressRecipient.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres klienta
|
CustomerAddress.text | string | |
|
Zaufanie do adresu klienta
|
CustomerAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adresat adresu klienta
|
CustomerAddressRecipient.text | string | |
|
Zaufanie adresata adresu klienta
|
CustomerAddressRecipient.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Identyfikator klienta
|
CustomerId.text | string | |
|
Pewność identyfikatora klienta
|
CustomerId.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nazwa klienta
|
CustomerName.text | string | |
|
Zaufanie do nazwy klienta
|
CustomerName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data ukończenia (tekst)
|
DueDate.text | string |
Zwraca datę ukończenia zapisaną na fakturze. |
|
Data ukończenia (data)
|
DueDate.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Zaufanie do daty ukończenia
|
DueDate.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data faktury (tekst)
|
InvoiceDate.text | string |
Zwraca datę faktury zapisaną na fakturze. |
|
Data faktury (data)
|
InvoiceDate.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Ufność daty faktury
|
InvoiceDate.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Identyfikator faktury
|
InvoiceId.text | string | |
|
Pewność identyfikatora faktury
|
InvoiceId.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Suma faktury (tekst)
|
InvoiceTotal.text | string |
Zwraca sumę faktury zapisaną na fakturze. |
|
Suma faktury (liczba)
|
InvoiceTotal.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Pewność sumy faktury
|
InvoiceTotal.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Poprzednie niezapłacone saldo (tekst)
|
PreviousUnpaidBalance.text | string |
Zwraca poprzednie niezapłacone saldo zgodnie z zapisem na fakturze. |
|
Poprzednie niezapłacone saldo (liczba)
|
PreviousUnpaidBalance.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Zaufanie do poprzedniego niezapłaconego salda
|
PreviousUnpaidBalance.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Zamówienie zakupu
|
PurchaseOrder.text | string | |
|
Zaufanie do zamówienia zakupu
|
PurchaseOrder.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres przelewu
|
RemittanceAddress.text | string | |
|
Zaufanie do adresu przelewu
|
RemittanceAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Odbiorca adresu przelewu
|
RemittanceAddressRecipient.text | string | |
|
Zaufanie adresata adresu przelewu
|
RemittanceAddressRecipient.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres usługi
|
ServiceAddress.text | string | |
|
Pewność adresu usługi
|
ServiceAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adresat adresu usługi
|
ServiceAddressRecipient.text | string | |
|
Pewność adresata adresu usługi
|
ServiceAddressRecipient.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data zakończenia usługi (tekst)
|
ServiceEndDate.text | string |
Zwraca datę zakończenia usługi zapisaną na fakturze. |
|
Data zakończenia usługi (data)
|
ServiceEndDate.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Pewność daty zakończenia usługi
|
ServiceEndDate.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data rozpoczęcia usługi (tekst)
|
ServiceStartDate.text | string |
Zwraca datę rozpoczęcia usługi zapisaną na fakturze. |
|
Data rozpoczęcia usługi (data)
|
ServiceStartDate.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Ufność daty rozpoczęcia usługi
|
ServiceStartDate.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres wysyłki
|
ShippingAddress.text | string | |
|
Pewność adresu wysyłkowego
|
ShippingAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adresat adresu wysyłkowego
|
ShippingAddressRecipient.text | string | |
|
Pewność adresata adresu wysyłkowego
|
ShippingAddressRecipient.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Sumy częściowe (tekst)
|
SubTotal.text | string |
Zwraca sumę częściową zapisaną na fakturze. |
|
Sumy częściowe (liczba)
|
SubTotal.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Pewność sumy częściowej
|
SubTotal.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Całkowity podatek (tekst)
|
TotalTax.text | string |
Zwraca całkowity podatek zapisany na fakturze. |
|
Całkowity podatek (liczba)
|
TotalTax.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Zaufanie do całkowitego podatku
|
TotalTax.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres dostawcy
|
VendorAddress.text | string | |
|
Pewność adresu dostawcy
|
VendorAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Odbiorca adresu dostawcy
|
VendorAddressRecipient.text | string | |
|
Zaufanie adresata adresu dostawcy
|
VendorAddressRecipient.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nazwa dostawcy
|
VendorName.text | string | |
|
Pewność, że nazwa dostawcy
|
VendorName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Przedmioty
|
Items.valueArray | array of object |
Tablica elementów liniowych |
|
Ilość (tekst)
|
Items.valueArray.valueObject.Amount.text | string |
Zwraca kwotę zapisaną na fakturze. |
|
Ilość (liczba)
|
Items.valueArray.valueObject.Amount.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Pewność ilości
|
Items.valueArray.valueObject.Amount.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Description
|
Items.valueArray.valueObject.Description.text | string | |
|
Pewność opisu
|
Items.valueArray.valueObject.Description.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Ilość (tekst)
|
Items.valueArray.valueObject.Quantity.text | string |
Zwraca ilość zapisaną na fakturze. |
|
Ilość (liczba)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Pewność ilości
|
Items.valueArray.valueObject.Quantity.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Cena jednostkowa (tekst)
|
Items.valueArray.valueObject.UnitPrice.text | string |
Zwraca cenę jednostkową zapisaną na fakturze. |
|
Cena jednostkowa (liczba)
|
Items.valueArray.valueObject.UnitPrice.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Pewność ceny jednostkowej
|
Items.valueArray.valueObject.UnitPrice.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Kod produktu
|
Items.valueArray.valueObject.ProductCode.text | string | |
|
Pewność kodu produktu
|
Items.valueArray.valueObject.ProductCode.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Unit
|
Items.valueArray.valueObject.Unit.text | string | |
|
Pewność jednostki
|
Items.valueArray.valueObject.Unit.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data (tekst)
|
Items.valueArray.valueObject.Date.text | string |
Zwraca datę zapisaną na fakturze. |
|
Data (data)
|
Items.valueArray.valueObject.Date.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Pewność daty
|
Items.valueArray.valueObject.Date.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Podatek (tekst)
|
Items.valueArray.valueObject.Tax.text | string |
Zwraca podatek zgodnie z zapisem na fakturze. |
|
Podatek (numer)
|
Items.valueArray.valueObject.Tax.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Zaufanie do podatku
|
Items.valueArray.valueObject.Tax.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
BusinessCardFields
Pola wizytówki dla wersji 2.1.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwy kontaktów
|
ContactNames.valueArray | array of object |
Tablica nazw kontaktów |
|
Imię
|
ContactNames.valueArray.valueObject.FirstName.text | string | |
|
Pewność, że imię
|
ContactNames.valueArray.valueObject.FirstName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nazwisko
|
ContactNames.valueArray.valueObject.LastName.text | string | |
|
Pewność nazwiska
|
ContactNames.valueArray.valueObject.LastName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nazwy firm
|
CompanyNames.valueArray | array of object |
Tablica nazw firm |
|
Nazwa firmy
|
CompanyNames.valueArray.text | string | |
|
Zaufanie do nazwy firmy
|
CompanyNames.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Oddziały
|
Departments.valueArray | array of object |
Tablica działów |
|
Dział
|
Departments.valueArray.text | string | |
|
Zaufanie działu
|
Departments.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Stanowiska
|
JobTitles.valueArray | array of object |
Tablica tytułów zadań |
|
Stanowisko
|
JobTitles.valueArray.text | string | |
|
Pewność stanowiska
|
JobTitles.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Wiadomości e-mail
|
Emails.valueArray | array of object |
Tablica wiadomości e-mail |
|
Email
|
Emails.valueArray.text | string | |
|
Pewność wiadomości e-mail
|
Emails.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Witryny internetowe
|
Websites.valueArray | array of object |
Tablica witryn internetowych |
|
Witryna internetowa
|
Websites.valueArray.text | string | |
|
Zaufanie do witryny internetowej
|
Websites.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adresy
|
Addresses.valueArray | array of object |
Tablica adresów |
|
Address
|
Addresses.valueArray.text | string | |
|
Pewność adresu
|
Addresses.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Telefony komórkowe
|
MobilePhones.valueArray | array of object |
Tablica telefonów komórkowych |
|
Telefon komórkowy
|
MobilePhones.valueArray.text | string | |
|
Pewność, że telefon komórkowy
|
MobilePhones.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Faksy
|
Faxes.valueArray | array of object |
Tablica faksów |
|
Faks
|
Faxes.valueArray.text | string | |
|
Pewność faksu
|
Faxes.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Telefony służbowe
|
WorkPhones.valueArray | array of object |
Tablica telefonów służbowych |
|
Telefon służbowy
|
WorkPhones.valueArray.text | string | |
|
Pewność, że telefon służbowy
|
WorkPhones.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Inne telefony
|
OtherPhones.valueArray | array of object |
Tablica innych telefonów |
|
Inny telefon
|
OtherPhones.valueArray.text | string | |
|
Zaufanie do innego telefonu
|
OtherPhones.valueArray.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
Pola paragonów
Receiptfields dla 2.1.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typ potwierdzenia
|
ReceiptType.text | string | |
|
Pewność, że typ paragonu
|
ReceiptType.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nazwa sprzedawcy
|
MerchantName.text | string | |
|
Zaufanie do nazwy sprzedawcy
|
MerchantName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Numer telefonu sprzedawcy
|
MerchantPhoneNumber.text | string | |
|
Zaufanie do numeru telefonu sprzedawcy
|
MerchantPhoneNumber.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Adres sprzedawcy
|
MerchantAddress.text | string | |
|
Zaufanie do adresu sprzedawcy
|
MerchantAddress.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data transakcji (tekst)
|
TransactionDate.text | string |
Zwraca datę transakcji zapisaną na fakturze. |
|
Data transakcji (data)
|
TransactionDate.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Pewność daty transakcji
|
TransactionDate.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Czas transakcji (tekst)
|
TransactionTime.text | string |
Zwraca czas transakcji zapisany na fakturze. |
|
Czas transakcji (czas)
|
TransactionTime.valueDate | time |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Pewność czasu transakcji
|
TransactionTime.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Suma (tekst)
|
Total.text | string |
Zwraca sumę zapisaną na fakturze. |
|
Całkowita (liczba)
|
Total.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Pewność całkowitej
|
Total.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Sumy częściowe (tekst)
|
Subtotal.text | string |
Zwraca sumę częściową zapisaną na fakturze. |
|
Sumy częściowe (liczba)
|
Subtotal.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Pewność sumy częściowej
|
Subtotal.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Podatek (tekst)
|
Tax.text | string |
Zwraca podatek zgodnie z zapisem na fakturze. |
|
Podatek (numer)
|
Tax.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Zaufanie do podatku
|
Tax.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Porada (tekst)
|
Tip.text | string |
Zwraca poradę zapisaną na fakturze. |
|
Porada (liczba)
|
Tip.valueNumber | number |
Sformatowany jako liczba. Przykład: 1234.98. |
|
Pewność wierzchołka
|
Tip.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Przedmioty
|
Items.valueArray | array of object |
Tablica elementów liniowych |
|
Name
|
Items.valueArray.valueObject.Name.text | string | |
|
Pewność nazwy
|
Items.valueArray.valueObject.Name.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Ilość (tekst)
|
Items.valueArray.valueObject.Quantity.text | string |
Zwraca ilość zapisaną na fakturze. |
|
Ilość (liczba)
|
Items.valueArray.valueObject.Quantity.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Pewność ilości
|
Items.valueArray.valueObject.Quantity.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Cena (tekst)
|
Items.valueArray.valueObject.Price.text | string |
Zwraca cenę zapisaną na fakturze. |
|
Cena (liczba)
|
Items.valueArray.valueObject.Price.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Pewność ceny
|
Items.valueArray.valueObject.Price.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Łączna cena (tekst)
|
Items.valueArray.valueObject.TotalPrice.text | string |
Zwraca łączną cenę zapisaną na fakturze. |
|
Łączna cena (liczba)
|
Items.valueArray.valueObject.TotalPrice.valueNumber | number |
Sformatowany jako liczba. Przykład: 12. |
|
Pewność całkowitej ceny
|
Items.valueArray.valueObject.TotalPrice.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
Pola identyfikatorów
Pola identyfikatora dokumentu dla wersji 2.1.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Region kraju
|
CountryRegion.valueCountryRegion | string | |
|
Zaufanie do regionu kraju
|
CountryRegion.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data wygaśnięcia
|
DateOfExpiration.text | string |
Zwraca datę wygaśnięcia zapisaną na fakturze. |
|
Data wygaśnięcia (data)
|
DateOfExpiration.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Pewność daty wygaśnięcia
|
DateOfExpiration.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Data urodzenia (tekst)
|
DateOfBirth.text | string |
Zwraca datę urodzenia zapisaną na fakturze. |
|
Data urodzenia (data)
|
DateOfBirth.valueDate | date |
Sformatowane jako data. Przykład: 2019-05-31. |
|
Pewność daty urodzenia
|
DateOfBirth.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Numer dokumentu
|
DocumentNumber.text | string | |
|
Pewność numeru dokumentu
|
DocumentNumber.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Imię
|
FirstName.text | string | |
|
Pewność, że imię
|
FirstName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nazwisko
|
LastName.text | string | |
|
Pewność nazwiska
|
LastName.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Nationality
|
Nationality.valueCountryRegion | string | |
|
Zaufanie do narodowości
|
Nationality.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Sex
|
Sex.text | string | |
|
Zaufanie do seksu
|
Sex.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Strefa z możliwością odczytu maszyny
|
MachineReadableZone.text | string | |
|
Pewność, że strefa z możliwością odczytu maszyny
|
MachineReadableZone.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Rodzaj dokumentu
|
DocumentType.text | string | |
|
Pewność typu dokumentu
|
DocumentType.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Address
|
Address.text | string | |
|
Pewność adresu
|
Address.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
|
Region
|
Region.text | string | |
|
Pewność regionu
|
Region.confidence | float |
Jak pewny siebie model jest w przewidywaniu. |
FieldValue
Przewidywany obiekt wartości pola.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | FieldValueType |
Semantyczny typ danych wartości pola. |
|
valueString
|
valueString | string |
Wartość ciągu. |
|
valueDate
|
valueDate | date-time |
Wartość daty. |
|
valueTime
|
valueTime | date-time |
Wartość godziny. |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Wartość numeru telefonu. |
|
valueNumber
|
valueNumber | number |
Wartość zmiennoprzecinkowa. |
|
valueInteger
|
valueInteger | integer |
Wartość całkowita. |
|
SMS
|
text | string | |
|
boundingBox
|
boundingBox | BoundingBox |
Pole ograniczenia ćwiartki z współrzędnymi określonymi względem lewej górnej części oryginalnego obrazu. Osiem liczb reprezentuje cztery punkty, zgodnie z ruchem wskazówek zegara z lewego górnego rogu względem orientacji tekstu. Dla obrazu współrzędne (x, y) są mierzone w pikselach. W przypadku formatu PDF współrzędne (x, y) są mierzone w calach. |
|
pewność
|
confidence | Confidence |
Wartość ufności. |
|
pierwiastki
|
elements | array of ElementReference |
Jeśli parametr includeTextDetails ma wartość true, lista odwołań do elementów tekstowych stanowi to pole. |
|
page
|
page | integer |
Numer strony opartej na 1 w dokumencie wejściowym. |
FieldValueType
Pewność
ApiVersion_V30
AnalyzeResultOperation_V30
Stan i wynik operacji analizy.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | string |
Stan operacji. |
|
createdDateTime
|
createdDateTime | date-time |
Data i godzina (UTC), kiedy operacja analizy została przesłana. |
|
lastUpdatedDateTime
|
lastUpdatedDateTime | date-time |
Data i godzina (UTC), kiedy stan został ostatnio zaktualizowany. |
|
błąd
|
error | Error_V30 |
Informacje o błędzie. |
|
analyzeResult
|
analyzeResult | AnalyzeResult_V30 |
Wynik analizy dokumentu. |
AnalyzeResult_V30
Wynik analizy dokumentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
apiVersion
|
apiVersion | ApiVersion_V30 |
Wersja interfejsu API. |
|
modelId
|
modelId | ModelId_V30 |
Unikatowa nazwa modelu. |
|
stringIndexType
|
stringIndexType | StringIndexType_V30 |
Metoda używana do obliczania przesunięcia i długości ciągu. |
|
zawartość
|
content | string |
Połącz reprezentację ciągu wszystkich elementów tekstowych i wizualnych w kolejności odczytu. |
|
contentFormat (format treści)
|
contentFormat | ContentFormat_V40 |
Format zawartości w przeanalizowanym wyniku. |
|
Stron
|
pages | array of DocumentPage_V30 |
Przeanalizowane strony. |
|
Ustępów
|
paragraphs | array of DocumentParagraph_V30 |
Wyodrębnione akapity. |
|
tables
|
tables | array of DocumentTable_V30 |
Wyodrębnione tabele. |
|
Dane
|
figures | array of DocumentFigure_V40 |
Wyodrębnione dane. |
|
Sekcje
|
sections | array of DocumentSection_V40 |
Wyodrębnione sekcje. |
|
Pary kluczy-wartość
|
keyValuePairs | array of DocumentKeyValuePair_V30 |
Wyodrębnione pary klucz-wartość. |
|
entities
|
entities | array of DocumentEntity_V30 |
Wyodrębnione jednostki. |
|
Style
|
styles | array of DocumentStyle_V30 |
Wyodrębnione style czcionek. |
|
Języki
|
languages | array of DocumentLanguage_V30 |
Wykryte języki. |
|
Dokumentów
|
documents | array of Document_V30 |
Wyodrębnione dokumenty. |
|
Ostrzeżenia
|
warnings | array of Warning_V40 |
Napotkano listę ostrzeżeń. |
DocumentPage_V30
Elementy zawartości i układu wyodrębnione ze strony z danych wejściowych.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rodzaj
|
kind | string |
Rodzaj strony dokumentu. |
|
pageNumber
|
pageNumber | integer |
Numer strony opartej na 1 w dokumencie wejściowym. |
|
kąt
|
angle | number |
Ogólna orientacja zawartości w kierunku wskazówek zegara mierzona w stopniach między (-180, 180). |
|
width
|
width | number |
Szerokość obrazu/pliku PDF odpowiednio w pikselach/calach. |
|
height
|
height | number |
Wysokość obrazu/PLIKU PDF w pikselach/calach, odpowiednio. |
|
jednostka
|
unit | string |
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". |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja strony w kolejności odczytu łączy zawartość. |
|
words
|
words | array of DocumentWord_V30 |
Wyodrębnione wyrazy ze strony. |
|
selectionMarks
|
selectionMarks | array of DocumentSelectionMark_V30 |
Wyodrębnione znaczniki zaznaczenia ze strony. |
|
images
|
images | array of DocumentImage_V30 |
Wyodrębnione obrazy ze strony. |
|
Linie
|
lines | array of DocumentLine_V30 |
Wyodrębnione wiersze ze strony, potencjalnie zawierające zarówno elementy tekstowe, jak i wizualne. |
|
kody kreskowe
|
barcodes | array of DocumentBarcode_V31 |
Wyodrębnione kody kreskowe ze strony. |
|
formulas
|
formulas | array of DocumentFormula_V31 |
Wyodrębnione formuły ze strony. |
DocumentWord_V30
Obiekt wyrazu składający się z ciągłej sekwencji znaków. W przypadku języków rozdzielanych spacjami, takich jak chiński, japoński i koreański, każdy znak jest reprezentowany jako własny wyraz.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | string |
Zawartość tekstowa wyrazu. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
|
span
|
span | DocumentSpan_V30 |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentSelectionMark_V30
Obiekt zaznaczenia reprezentujący pola wyboru, przyciski radiowe i inne elementy wskazujące zaznaczenie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
state | DocumentSelectionMarkState_V30 |
Stan znacznika wyboru. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
|
span
|
span | DocumentSpan_V30 |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentImage_V30
Obiekt obrazu wykryty na stronie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
|
span
|
span | DocumentSpan_V30 |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
|
pageRef
|
pageRef | integer |
0-oparty na indeksie tablicy stron globalnych zawierających zawartość obrazu. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentSelectionMarkState_V30
DocumentStyle_V30
Obiekt reprezentujący obserwowane style tekstu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
backgroundColor
|
backgroundColor | string |
Kolor tła w formacie szesnastkowym #rrggbb. |
|
color
|
color | string |
Kolor pierwszego planu w formacie szesnastkowym #rrggbb. |
|
fontStyle
|
fontStyle | string |
Styl czcionki. |
|
fontWeight
|
fontWeight | string |
Waga czcionki. |
|
isHandwritten
|
isHandwritten | boolean |
To zawartość odręczna. |
|
podobneFontFamily
|
similarFontFamily | string |
Wizualnie najbardziej podobna czcionka z zestawu obsługiwanych rodzin czcionek z czcionkami rezerwowymi zgodnie z konwencją CSS (np. "Arial, sans-serif"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja elementów tekstowych w łączonej zawartości, do których ma zastosowanie styl. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentLanguage_V30
Obiekt reprezentujący wykryty język dla danego zakresu tekstu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
regionalny
|
locale | string |
Wykryty język. Wartość może zawierać kod języka ISO 639-1 (np. "en", "fr") lub tag języka BCP 47 (np. "zh-Hans"). |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja elementów tekstowych w łączonej zawartości, do których ma zastosowanie język. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentLine_V30
Obiekt wiersza zawartości składający się z sąsiedniej sekwencji elementów zawartości, takich jak wyrazy i znaczniki zaznaczenia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | string |
Połączona zawartość zawartych elementów w kolejności odczytu. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja wiersza w kolejności odczytu łączy zawartość. |
DocumentParagraph_V30
Obiekt akapitu składający się z ciągłych linii zwykle ze wspólnym wyrównaniem i odstępami.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rola
|
role | string |
Semantyczna rola akapitu. |
|
zawartość
|
content | string |
Połączona zawartość akapitu w kolejności czytania. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące akapit. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja akapitu w kolejności odczytu łączy zawartość. |
DocumentTable_V30
Obiekt tabeli składający się z komórek tabeli rozmieszczony w układzie prostokątnym.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rowCount
|
rowCount | integer |
Liczba wierszy w tabeli. |
|
columnCount
|
columnCount | integer |
Liczba kolumn w tabeli. |
|
Komórek
|
cells | array of DocumentTableCell_V30 |
Komórki zawarte w tabeli. |
|
napis
|
caption | DocumentCaption_V30 |
Obiekt reprezentujący lokalizację i zawartość podpisu tabeli. |
|
Przypisy dolne
|
footnotes | array of DocumentFootnote_V30 |
Przypisy dolne skojarzone z tabelą. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Wiązanie regionów obejmujących tabelę. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja tabeli w kolejności odczytu łączy zawartość. |
DocumentTableCell_V30
Obiekt reprezentujący lokalizację i zawartość komórki tabeli.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
rodzaj
|
kind | string |
Rodzaj komórki tabeli. |
|
rowIndex
|
rowIndex | integer |
Indeks wiersza komórki. |
|
columnIndex
|
columnIndex | integer |
Indeks kolumn komórki. |
|
rowSpan (rozpiętość)
|
rowSpan | integer |
Liczba wierszy obejmujących tę komórkę. |
|
columnSpan
|
columnSpan | integer |
Liczba kolumn obejmujących tę komórkę. |
|
zawartość
|
content | string |
Połączona zawartość komórki tabeli w kolejności odczytu. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące komórkę tabeli. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja komórki tabeli w kolejności odczytywania łączonej zawartości. |
DocumentCaption_V30
Obiekt reprezentujący lokalizację i zawartość podpisu tabeli.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | string |
Zawartość podpisu tabeli. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Wiązanie regionów obejmujących podpis tabeli. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja podpisu tabeli w kolejności odczytywania łączonej zawartości. |
DocumentFootnote_V30
Obiekt reprezentujący lokalizację i zawartość przypisu dolnego tabeli.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | string |
Zawartość przypisu dolnego tabeli. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące przypis dolny tabeli. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja przypisu dolnego tabeli w kolejności odczytywania łączonej zawartości. |
DocumentKeyValuePair_V30
Obiekt reprezentujący pole formularza z unikatową etykietą pola (klucz) i wartością pola (może być pusta).
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
klucz
|
key | DocumentKeyValueElement_V30 |
Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość. |
|
value
|
value | DocumentKeyValueElement_V30 |
Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentKeyValueElement_V30
Obiekt reprezentujący klucz pola lub wartość w parze klucz-wartość.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | string |
Połączona zawartość elementu klucz-wartość w kolejności odczytu. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące element klucz-wartość. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja elementu klucz-wartość w kolejności odczytu łączenie zawartości. |
DocumentEntity_V30
Obiekt reprezentujący różne kategorie jednostek.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kategoria
|
category | string |
Typ jednostki. |
|
Podkategorii
|
subCategory | string |
Typ podrzędny jednostki. |
|
zawartość
|
content | string |
Zawartość jednostki. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące jednostkę. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja jednostki w kolejności odczytu łączy zawartość. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
DocumentBarcode_V31
Obiekt kodu kreskowego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
|
rodzaj
|
kind | string |
Rodzaj kodu kreskowego. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
|
span
|
span | DocumentSpan_V30 |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
|
value
|
value | string |
Wartość kodu kreskowego |
DocumentFormula_V31
Obiekt formuły.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
|
rodzaj
|
kind | string |
Rodzaj formuły. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
|
span
|
span | DocumentSpan_V30 |
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość. |
|
value
|
value | string |
Wyrażenie LaTex opisujące formułę. |
DocumentFigure_V40
Obiekt reprezentujący rysunek w dokumencie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące rysunek. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja rysunku w kolejności odczytu połączona zawartość. |
|
pierwiastki
|
elements | array of DocumentElement_V40 |
Elementy podrzędne rysunku, z wyłączeniem podpisów lub przypisów dolnych. |
|
napis
|
caption | DocumentCaption_V30 |
Obiekt reprezentujący lokalizację i zawartość podpisu tabeli. |
|
Przypisy dolne
|
footnotes | array of DocumentFootnote_V30 |
Lista przypisów dolnych skojarzonych z rysunkiem. |
|
id
|
id | string |
Identyfikator rysunku. |
DocumentSection_V40
Obiekt reprezentujący sekcję w dokumencie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja sekcji w kolejności odczytywania łączonej zawartości. |
|
pierwiastki
|
elements | array of DocumentElement_V40 |
Elementy podrzędne sekcji. |
DocumentElement_V40
Wskaźnik JSON odwołujące się do elementu dokumentu, takiego jak akapit, tabela, sekcja itp.
Wskaźnik JSON odwołujące się do elementu dokumentu, takiego jak akapit, tabela, sekcja itp.
Warning_V40
Obiekt błędu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
Jeden z zdefiniowanych przez serwer zestaw kodów ostrzegawczych. |
|
komunikat
|
message | string |
Czytelna dla człowieka reprezentacja ostrzeżenia. |
|
miejsce docelowe
|
target | string |
Element docelowy błędu. |
ContentFormat_V40
Document_V30
Obiekt opisujący lokalizację i semantyczną zawartość dokumentu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
docType
|
docType | DocType_V30 |
Nazwa typu dokumentu. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące dokument. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja dokumentu w kolejności odczytu łączy zawartość. |
|
pola
|
fields | object |
Słownik nazwanych wartości pól. |
|
Pola formularza
|
_fields | array of DocumentFieldNameValue_V30 |
Tablica pól z właściwościami fieldName i fieldValue. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
BoundingPolygon_V30
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
number |
BoundingRegion_V30
Wiązanie wielokąta na określonej stronie danych wejściowych.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
pageNumber
|
pageNumber | integer |
1 numer strony strony zawierającej region ograniczenia. |
|
polygon
|
polygon | BoundingPolygon_V30 |
Wiązanie wielokąta ze współrzędnymi określonymi względem lewej górnej części strony. Liczby reprezentują wartości x, y wierzchołków wielokątnych, zgodnie z ruchem wskazówek zegara od lewej (-180 stopni włącznie) względem orientacji elementu. |
DocumentFieldType_V30
DocumentFieldNameValue_V30
Obiekt pola dokumentu o nazwie pola i jego wartości.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Nazwa pola
|
fieldName | string | |
|
fieldValue
|
fieldValue | DocumentField_V30 |
Obiekt reprezentujący zawartość i lokalizację wartości pola. |
DocumentField_V30
Obiekt reprezentujący zawartość i lokalizację wartości pola.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | DocumentFieldType_V30 |
Semantyczny typ danych wartości pola. |
|
valueString
|
valueString | string |
Wartość ciągu. |
|
valueDate
|
valueDate | date |
Wartość daty w formacie RRRR-MM-DD (ISO 8601). |
|
valueTime
|
valueTime | time |
Wartość czasu w formacie hh:mm:ss (ISO 8601). |
|
valuePhoneNumber
|
valuePhoneNumber | string |
Wartość numeru telefonu w formacie E.164 (np. +19876543210). |
|
valueNumber
|
valueNumber | number |
Wartość zmiennoprzecinkowa. |
|
valueInteger
|
valueInteger | integer |
Wartość całkowita. |
|
valueSelectionMark
|
valueSelectionMark | DocumentSelectionMarkState_V30 |
Stan znacznika wyboru. |
|
valueSignature
|
valueSignature | string |
Obecność podpisu. |
|
valueCountryRegion
|
valueCountryRegion | string |
3-literowa wartość kodu kraju (ISO 3166-1 alfa-3). |
|
valueCurrency
|
valueCurrency | CurrencyValue_V30 |
Wartość pola waluty. |
|
valueAddress
|
valueAddress | AddressValue_V30 |
Wartość pola adresu. |
|
valueBoolean
|
valueBoolean | boolean |
Wartość logiczna. |
|
zawartość
|
content | string |
Zawartość pola. |
|
boundingRegions
|
boundingRegions | array of BoundingRegion_V30 |
Regiony ograniczenia obejmujące pole. |
|
spans
|
spans | array of DocumentSpan_V30 |
Lokalizacja pola w kolejności odczytu łączy zawartość. |
|
pewność
|
confidence | Confidence_V30 |
Pewność przewidywania. |
Confidence_V30
DocType_V30
DocumentSpan_V30
Ciągły region połączonej właściwości zawartości określony jako przesunięcie i długość.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
przesunąć
|
offset | integer |
Indeks na podstawie zera zawartości reprezentowanej przez zakres. |
|
length
|
length | integer |
Liczba znaków w zawartości reprezentowanej przez zakres. |
StringIndexType_V30
Metoda używana do obliczania przesunięcia i długości ciągu.
Metoda używana do obliczania przesunięcia i długości ciągu.
ModelId_V30
Error_V30
Informacje o błędzie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
Kod błędu. |
|
komunikat
|
message | string |
Komunikat o błędzie. |
|
miejsce docelowe
|
target | string |
Element docelowy błędu. |
|
details
|
details | array of InnerError_V30 |
Lista szczegółowych błędów. |
|
innererror
|
innererror | InnerError_V30 |
Szczegółowy błąd. |
InnerError_V30
Szczegółowy błąd.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
Kod błędu. |
|
komunikat
|
message | string |
Komunikat o błędzie. |
CurrencyValue_V30
Wartość pola waluty.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kwota
|
amount | double |
Kwota waluty. |
|
kod waluty
|
currencyCode | string |
Rozpoznano kod waluty (ISO 4217), jeśli istnieje. |
|
currencySymbol
|
currencySymbol | string |
Etykieta symbolu waluty, jeśli istnieje. |
AddressValue_V30
Wartość pola adresu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
houseNumber
|
houseNumber | string |
Dom lub numer budynku. |
|
PoBox
|
poBox | string |
Numer skrzynki pocztowej. |
|
droga
|
road | string |
Nazwa ulicy. |
|
city
|
city | string |
Nazwa miasta, miasta, wsi itp. |
|
stan
|
state | string |
Dział administracyjny pierwszego poziomu. |
|
postalCode
|
postalCode | string |
Kod pocztowy używany do sortowania poczty. |
|
countryRegion
|
countryRegion | string |
Kraj lub region. |
|
adres ulicy
|
streetAddress | string |
Adres na poziomie ulicy, z wyłączeniem miasta, stanu, krajuRegion i kod pocztowy. |
|
cityDistrict
|
cityDistrict | string |
Dzielnice lub dzielnice w mieście, takim jak Brooklyn w Nowym Jorku lub City of Westminster w Londynie. |
|
dom
|
house | string |
Nazwa kompilacji, taka jak World Trade Center. |
|
poziom
|
level | string |
Numer podłogi, taki jak 3F. |
|
stateDistrict
|
stateDistrict | string |
Podział administracyjny drugiego poziomu używany w niektórych ustawieniach regionalnych. |
|
przedmieście
|
suburb | string |
Nieoficjalna nazwa sąsiedztwa, na przykład Chinatown. |
|
jednostka
|
unit | string |
Numer apartamentu lub biura. |