Document Models - Analyze Document

Usługa:

Azure AI Services

Wersja interfejsu API:

2023-07-31

Analizuje dokument za pomocą modelu dokumentu.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31

Z parametrami opcjonalnymi:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).
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	Żądana wersja interfejsu API.
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").
pages	query		string	Lista 1 numerów stron do przeanalizowania. Np. "1-3,5,7-9" Wzorzec wyrażenia regularnego: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

Nagłówek żądania

Media Types: "application/json", "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	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz tajny subskrypcji usług Azure Cognitive Services.

Treść żądania

Media Types: "application/json", "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
base64Source	string	Kodowanie base64 dokumentu 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 pomyślnie w kolejce. Nagłówki Operation-Location: string
Other Status Codes	ErrorResponse	Napotkano błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji usług Azure Cognitive Services.

Typ: apiKey
W: header

Przykłady

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Przykładowe żądanie

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Przykładowe żądanie

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

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

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Definicje

Nazwa	Opis
AnalyzeDocumentRequest	Parametry analizy dokumentów.
DocumentAnalysisFeature	Lista opcjonalnych funkcji analizy.
Error	Informacje o błędzie.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Szczegółowy błąd.
StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

AnalyzeDocumentRequest

Parametry analizy dokumentów.

Nazwa	Typ	Opis
base64Source	string	Kodowanie base64 dokumentu 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.

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 optyczne rozpoznawanie znaków w wyższej rozdzielczości, aby obsługiwać dokumenty z drobnym drukowaniem.
styleFont	string	Włącz rozpoznawanie różnych stylów czcionek.

Error

Informacje o błędzie.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	Error[]	Lista szczegółowych błędów.
innererror	InnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

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

InnerError

Szczegółowy błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
innererror	InnerError	Szczegółowy błąd.
message	string	Komunikat o błędzie.

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.