Analyzer - Get Analyze Invoice Result

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2.1

Śledzenie postępu i uzyskiwanie wyniku operacji analizowania faktury.

GET {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/{resultId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	Analizowanie identyfikatora wyniku operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeOperationResult	Powodzenie
Other Status Codes	ErrorResponse	Jednostka odpowiedzi towarzysząca nieudanych odpowiedzi zawierających dodatkowe szczegóły dotyczące błędu.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Get analyze receipt result

Przykładowe żądanie

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Przykładowa odpowiedź

Kod stanu:: 200

{
  "status": "running",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": [],
    "documentResults": [],
    "errors": []
  }
}

Definicje

Nazwa	Opis
AnalyzeOperationResult	Stan i wynik operacji analizy w kolejce.
AnalyzeResult	Analizowanie wyniku operacji.
Appearance	Obiekt reprezentujący wygląd wiersza tekstu.
DataTable	Informacje o wyodrębnionej tabeli zawartej na stronie.
DataTableCell	Informacje o wyodrębnionej komórce w tabeli.
DocumentResult	Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.
ErrorInformation
ErrorResponse
FieldValue	Rozpoznana wartość pola.
FieldValueType	Semantyczny typ danych wartości pola.
KeyValueElement	Informacje o wyodrębnionym kluczu lub wartości w parze klucz-wartość.
KeyValuePair	Informacje o wyodrębnionej parze klucz-wartość.
KeyValueType	Semantyczny typ danych elementu wartości klucza.
LengthUnit	Jednostka używana przez właściwości width, height i boundingBox. W przypadku obrazów jednostka jest "pixel". W przypadku formatu PDF jednostka jest "cal".
OperationStatus	Stan operacji w kolejce.
PageResult	Wyodrębnione informacje z jednej strony.
ReadResult	Tekst wyodrębniony ze strony w dokumencie wejściowym.
SelectionMark	Informacje o wyodrębnionym znaczniku zaznaczenia.
Style	Obiekt reprezentujący styl wiersza tekstu.
TextLine	Obiekt reprezentujący wyodrębniony wiersz tekstu.
TextStyle	Nazwa stylu wiersza tekstu, w tym pismo ręczne i inne.
TextWord	Obiekt reprezentujący wyraz.

AnalyzeOperationResult

Stan i wynik operacji analizy w kolejce.

Nazwa	Typ	Opis
analyzeResult	AnalyzeResult	Wyniki operacji analizy.
createdDateTime	string	Data i godzina (UTC) przesłania operacji analizy.
lastUpdatedDateTime	string	Data i godzina (UTC) ostatniej aktualizacji stanu.
status	OperationStatus	Stan operacji.

AnalyzeResult

Analizowanie wyniku operacji.

Nazwa	Typ	Opis
documentResults	DocumentResult[]	Informacje na poziomie dokumentu wyodrębnione z danych wejściowych.
errors	ErrorInformation[]	Lista błędów zgłoszonych podczas operacji analizy.
pageResults	PageResult[]	Informacje na poziomie strony wyodrębnione z danych wejściowych.
readResults	ReadResult[]	Tekst wyodrębniony z danych wejściowych.
version	string	Wersja schematu używana dla tego wyniku.

Appearance

Obiekt reprezentujący wygląd wiersza tekstu.

Nazwa	Typ	Opis
style	Style	Obiekt reprezentujący styl wiersza tekstu.

DataTable

Informacje o wyodrębnionej tabeli zawartej na stronie.

Nazwa	Typ	Opis
boundingBox	number[]	Pole ograniczenia tabeli.
cells	DataTableCell[]	Lista komórek zawartych w tabeli.
columns	integer	Liczba kolumn.
rows	integer	Liczba wierszy.

DataTableCell

Informacje o wyodrębnionej komórce w tabeli.

Nazwa	Typ	Domyślna wartość	Opis
boundingBox	number[]		Pole ograniczenia komórki.
columnIndex	integer		Indeks kolumn komórki.
columnSpan	integer	1	Liczba kolumn obejmujących tę komórkę.
confidence	number		Wartość ufności.
elements	string[]		Jeśli właściwość includeTextDetails jest ustawiona na wartość true, lista odwołań do elementów tekstowych tworzących tę komórkę tabeli.
isFooter	boolean	False	Czy bieżąca komórka jest komórką stopki?
isHeader	boolean	False	Czy bieżąca komórka jest komórką nagłówka?
rowIndex	integer		Indeks wiersza komórki.
rowSpan	integer	1	Liczba wierszy obejmujących tę komórkę.
text	string		Zawartość tekstowa komórki.

DocumentResult

Zestaw wyodrębnionych pól odpowiadających dokumentowi wejściowemu.

Nazwa	Typ	Opis
docType	string	Typ dokumentu.
docTypeConfidence	number	Przewidywana pewność typu dokumentu.
fields	<string, FieldValue>	Słownik nazwanych wartości pól.
modelId	string	Identyfikator modelu.
pageRange	integer[]	Numer pierwszej i ostatniej strony, w którym znajduje się dokument.

ErrorInformation

Nazwa	Typ	Opis
code	string
message	string

ErrorResponse

Nazwa	Typ	Opis
error	ErrorInformation

FieldValue

Rozpoznana wartość pola.

Nazwa	Typ	Opis
boundingBox	number[]	Pole ograniczenia wartości pola, jeśli jest to konieczne.
confidence	number	Współczynnik ufności.
elements	string[]	Jeśli parametr includeTextDetails ma wartość true, lista odwołań do elementów tekstowych tworzących to pole.
page	integer	Numer strony opartej na 1 w dokumencie wejściowym.
text	string	Zawartość tekstowa wyodrębnionego pola.
type	FieldValueType	Typ wartości pola.
valueArray	FieldValue[]	Tablica wartości pól.
valueCountryRegion	string	3-literowy kod kraju (ISO 3166-1 alfa-3).
valueDate	string	Wartość daty.
valueInteger	integer	Wartość całkowita.
valueNumber	number	Wartość zmiennoprzecinkowa.
valueObject	<string, FieldValue>	Słownik nazwanych wartości pól.
valuePhoneNumber	string	Wartość numeru telefonu.
valueSelectionMark	enum: selected unselected	Wartość znacznika wyboru.
valueString	string	Wartość ciągu.
valueTime	string	Wartość godziny.

FieldValueType

Semantyczny typ danych wartości pola.

Nazwa	Typ	Opis
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

Informacje o wyodrębnionym kluczu lub wartości w parze klucz-wartość.

Nazwa	Typ	Opis
boundingBox	number[]	Pole ograniczenia klucza lub wartości.
elements	string[]	Jeśli parametr includeTextDetails ma wartość true, lista odwołań do elementów tekstowych tworzących ten klucz lub wartość.
text	string	Zawartość tekstowa klucza lub wartości.
type	KeyValueType	Semantyczny typ danych elementu wartości klucza.

KeyValuePair

Informacje o wyodrębnionej parze klucz-wartość.

Nazwa	Typ	Opis
confidence	number	Wartość ufności.
key	KeyValueElement	Informacje o wyodrębnionym kluczu w parze klucz-wartość.
label	string	Etykieta zdefiniowana przez użytkownika dla wpisu pary klucz/wartość.
value	KeyValueElement	Informacje o wyodrębnionej wartości w parze klucz-wartość.

KeyValueType

Semantyczny typ danych elementu wartości klucza.

Nazwa	Typ	Opis
selectionMark	string
string	string

LengthUnit

Jednostka używana przez właściwości width, height i boundingBox. W przypadku obrazów jednostka jest "pixel". W przypadku formatu PDF jednostka jest "cal".

Nazwa	Typ	Opis
inch	string
pixel	string

OperationStatus

Stan operacji w kolejce.

Nazwa	Typ	Opis
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Wyodrębnione informacje z jednej strony.

Nazwa	Typ	Opis
clusterId	integer	Identyfikator klastra.
keyValuePairs	KeyValuePair[]	Lista par klucz-wartość wyodrębnionych ze strony.
page	integer	Numer strony.
tables	DataTable[]	Lista tabel danych wyodrębnionych ze strony.

ReadResult

Tekst wyodrębniony ze strony w dokumencie wejściowym.

Nazwa	Typ	Opis
angle	number	Ogólna orientacja tekstu w kierunku wskazówek zegara, mierzona w stopniach między (-180, 180).
height	number	Wysokość obrazu/pliku PDF odpowiednio w pikselach/calach.
lines	TextLine[]	Jeśli właściwość includeTextDetails ma wartość true, lista rozpoznanych wierszy tekstu. Maksymalna liczba zwracanych wierszy wynosi 300 na stronę. Linie są posortowane 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.
page	integer	Numer strony opartej na 1 w dokumencie wejściowym.
selectionMarks	SelectionMark[]	Lista oznaczeń zaznaczenia wyodrębnionych ze strony.
unit	LengthUnit	Jednostka używana przez właściwości width, height i boundingBox. W przypadku obrazów jednostka jest "pixel". W przypadku formatu PDF jednostka jest "cal".
width	number	Szerokość obrazu/pliku PDF odpowiednio w pikselach/calach.

SelectionMark

Informacje o wyodrębnionym znaczniku zaznaczenia.

Nazwa	Typ	Opis
boundingBox	number[]	Pole ograniczenia znacznika wyboru.
confidence	number	Wartość ufności.
state	enum: selected unselected	Stan znacznika wyboru.

Style

Obiekt reprezentujący styl wiersza tekstu.

Nazwa	Typ	Opis
confidence	number	Pewność stylu wiersza tekstu.
name	TextStyle	Nazwa stylu wiersza tekstu, w tym pismo ręczne i inne.

TextLine

Obiekt reprezentujący wyodrębniony wiersz tekstu.

Nazwa	Typ	Opis
appearance	Appearance	Właściwości wyglądu tekstu.
boundingBox	number[]	Pole ograniczenia wyodrębnionej linii.
text	string	Zawartość tekstowa wiersza.
words	TextWord[]	Lista wyrazów w wierszu tekstu.

TextStyle

Nazwa stylu wiersza tekstu, w tym pismo ręczne i inne.

Nazwa	Typ	Opis
handwriting	string
other	string

TextWord

Obiekt reprezentujący wyraz.

Nazwa	Typ	Opis
boundingBox	number[]	Pole ograniczenia wyodrębnionego wyrazu.
confidence	number	Wartość ufności.
text	string	Zawartość tekstowa wyrazu.

Udostępnij za pośrednictwem