Document Models - Analyze Document

Tjänst:

Azure AI Services

API-version:

2022-08-31

Analyserar dokument med dokumentmodell.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Unikt namn på dokumentmodell. Reguljärt uttrycksmönster: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}
api-version	query	True	ApiVersion	Begärd API-version.
locale	query		string	Språktips för textigenkänning och dokumentanalys. Värdet får endast innehålla språkkoden (t.ex. "en", "fr") eller bcp 47-språktaggen (t.ex. "en-US").
pages	query		string	Lista över 1-baserade sidnummer som ska analyseras. t.ex. "1-3,5,7-9" Reguljärt uttrycksmönster: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

Begärandehuvud

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif"

Name	Typ	Description
base64Source	string	Base64-kodning av dokumentet som ska analyseras
urlSource	string	Dokument-URL som ska analyseras

Svar

Name	Typ	Description
202 Accepted		Begäran har placerats i kö. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel påträffades.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

AnalyzeDocument_Base64

AnalyzeDocument_Url

AnalyzeDocument_Base64

Exempelbegäran

HTTP

POST {endpoint}/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

{
  "base64Source": ""
}

Exempelsvar

Statuskod:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/prebuilt-layout/analyzeResults/{resultId}?api-version=2022-08-31

AnalyzeDocument_Url

Exempelbegäran

HTTP

POST {endpoint}/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2022-08-31

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

Exempelsvar

Statuskod:

202

Operation-Location: {endpoint}/formrecognizer/documentModels/customModel/analyzeResults/{resultId}?api-version=2022-08-31

Definitioner

Name	Description
AnalyzeDocumentRequest	Parametrar för dokumentanalys.
ApiVersion	API-version.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
InnerError	Detaljerat fel.
StringIndexType	Metod som används för att beräkna strängförskjutning och längd.

AnalyzeDocumentRequest

Parametrar för dokumentanalys.

Name	Typ	Description
base64Source	string	Base64-kodning av dokumentet som ska analyseras
urlSource	string	Dokument-URL som ska analyseras

ApiVersion

API-version.

Name	Typ	Description
2022-08-31	string

Error

Felinformation.

Name	Typ	Description
code	string	Felkod.
details	Error[]	Lista över detaljerade fel.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Detaljerat fel.

Name	Typ	Description
code	string	Felkod.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.

StringIndexType

Metod som används för att beräkna strängförskjutning och längd.

Name	Typ	Description
textElements	string
unicodeCodePoint	string
utf16CodeUnit	string