Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analizuje dokument przy użyciu modelu dokumentów.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Punkt końcowy usługi Analizy dokumentów.
modelId	path	True	string	Unikatowa nazwa modelu dokumentu. Regex pattern: ^[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ówki dotyczące 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").
outputContentFormat	query		ContentFormat	Format zawartości najwyższego poziomu wyników analizy.
pages	query		string	Lista numerów stron opartych na 1 do przeanalizowania. Np. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Lista dodatkowych pól do wyodrębnienia. Np. "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

Treść żądania

Nazwa	Typ	Opis
base64Source	string	Kodowanie dokumentu w formacie Base64 do analizy. Należy określić wartość urlSource lub base64Source.
urlSource	string	Adres URL dokumentu do analizy. Należy określić wartość urlSource lub base64Source.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Przykłady

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Analyze Document from Url

Sample Request

HTTP

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

{
  "urlSource": "http://host.com/doc.pdf"
}

Sample Response

Status code:

202

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

Definicje

Nazwa	Opis
AnalyzeDocumentRequest	Parametry analizy dokumentu.
ContentFormat	Format zawartości w analizowanym wyniku.
DocumentAnalysisFeature	Lista opcjonalnych funkcji analizy.
Error	Obiekt błędu.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

AnalyzeDocumentRequest

Parametry analizy dokumentu.

Nazwa	Typ	Opis
base64Source	string	Kodowanie dokumentu w formacie Base64 do analizy. Należy określić wartość urlSource lub base64Source.
urlSource	string	Adres URL dokumentu do analizy. Należy określić wartość urlSource lub base64Source.

ContentFormat

Format zawartości w analizowanym wyniku.

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

DocumentAnalysisFeature

Lista opcjonalnych funkcji analizy.

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 większej rozdzielczości, aby obsługiwać dokumenty z drobnym 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.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

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

InnerError

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

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	InnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

StringIndexType

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

Nazwa	Typ	Opis
textElements	string	Znak wyświetlany postrzegany przez użytkownika lub klaster grafu zdefiniowany przez unicode 8.0.0.
unicodeCodePoint	string	Jednostka znaków reprezentowana przez pojedynczy punkt kodu Unicode. Używany przez język Python 3.
utf16CodeUnit	string	Jednostka znaków reprezentowana przez 16-bitową jednostkę kodu Unicode. Używane przez języki JavaScript, Java i .NET.