Document Models - Analyze Document From Stream

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Analizuje dokument przy użyciu modelu dokumentów.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-11-30

Z parametrami opcjonalnymi:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-11-30&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy usługi Analizy dokumentów.
modelId	path	True	string	Unikatowa nazwa modelu dokumentu. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
features	query		DocumentAnalysisFeature[]	Lista opcjonalnych funkcji analizy.
locale	query		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").
output	query		AnalyzeOutputOption[]	Dodatkowe dane wyjściowe do wygenerowania podczas analizy.
outputContentFormat	query		DocumentContentFormat	Format zawartości najwyższego poziomu wyników analizy.
pages	query		string	1 numery stron do przeanalizowania. Ex. "1-3,5,7-9" Wzorzec wyrażenia regularnego: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista dodatkowych pól do wyodrębnienia. Ex. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

Treść żądania

Media Types: "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Nazwa	Typ	Opis
input	string	Zawartość wejściowa.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Nagłówki Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	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

Analyze Document from Url

Przykładowe żądanie

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?api-version=2024-11-30&pages=1-2,4&locale=en-US&stringIndexType=textElements

"{binaryFile}"

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definicje

Nazwa	Opis
AnalyzeOutputOption	Dodatkowe dane wyjściowe do wygenerowania podczas analizy.
DocumentAnalysisFeature	Funkcje analizy dokumentów do włączenia.
DocumentContentFormat	Format zawartości w przeanalizowanym wyniku.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

AnalyzeOutputOption

Dodatkowe dane wyjściowe do wygenerowania podczas analizy.

Nazwa	Typ	Opis
figures	string	Generowanie przyciętych obrazów wykrytych liczb.
pdf	string	Generowanie danych wyjściowych pliku PDF z możliwością wyszukiwania.

DocumentAnalysisFeature

Funkcje analizy dokumentów do włączenia.

Nazwa	Typ	Opis
barcodes	string	Włącz wykrywanie kodów kreskowych w dokumencie.
formulas	string	Włącz wykrywanie wyrażeń matematycznych w dokumencie.
keyValuePairs	string	Włącz wykrywanie ogólnych par wartości klucza (pól formularza) w dokumencie.
languages	string	Włącz wykrywanie języka zawartości tekstowej.
ocrHighResolution	string	Wykonaj funkcję OCR w wyższej rozdzielczości, aby obsługiwać dokumenty z precyzyjnym drukowaniem.
queryFields	string	Włącz wyodrębnianie dodatkowych pól za pomocą parametru zapytania QueryFields.
styleFont	string	Włącz rozpoznawanie różnych stylów czcionek.

DocumentContentFormat

Format zawartości w przeanalizowanym wyniku.

Nazwa	Typ	Opis
markdown	string	Reprezentacja markdown zawartości dokumentu z nagłówkami sekcji, tabelami itp.
text	string	Reprezentacja zwykłego tekstu zawartości dokumentu bez formatowania.

DocumentIntelligenceError

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	DocumentIntelligenceError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Informacje o błędzie.

DocumentIntelligenceInnerError

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	DocumentIntelligenceInnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

StringIndexType

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

Nazwa	Typ	Opis
textElements	string	Postrzegany przez użytkownika znak wyświetlania lub klaster grafu, zgodnie z definicją w standardze Unicode 8.0.0.
unicodeCodePoint	string	Jednostka znaku 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.