Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Analyse le document avec le modèle de document.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Nom du modèle de document unique. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Version de l’API demandée.
features	query		DocumentAnalysisFeature[]	Liste des fonctionnalités d’analyse facultatives.
locale	query		string	Indicateur de paramètres régionaux pour la reconnaissance de texte et l’analyse de document. La valeur peut contenir uniquement le code de langue (par exemple, « en », « fr ») ou la balise de langue BCP 47 (par exemple, « en-US »).
pages	query		string	Liste des numéros de page basés sur 1 à analyser. Ex. "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Méthode utilisée pour calculer le décalage et la longueur de chaîne.

En-tête de la demande

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"

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Clé secrète de votre abonnement Azure Cognitive Services.

Corps de la demande

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"

Nom	Type	Description
base64Source	string	Encodage en base64 du document à analyser. UrlSource ou base64Source doit être spécifié.
urlSource	string	URL du document à analyser. UrlSource ou base64Source doit être spécifié.

Réponses

Nom	Type	Description
202 Accepted		La demande est mise en file d’attente. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erreur rencontrée.

Sécurité

Ocp-Apim-Subscription-Key

Clé secrète de votre abonnement Azure Cognitive Services.

Type: apiKey
In: header

Exemples

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

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"
}

Sample Response

Status code:

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

Sample Request

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"
}

Sample Response

Status code:

202

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

Définitions

Nom	Description
AnalyzeDocumentRequest	Paramètres d’analyse de document.
DocumentAnalysisFeature	Liste des fonctionnalités d’analyse facultatives.
Error	Informations d’erreur.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Erreur détaillée.
StringIndexType	Méthode utilisée pour calculer le décalage et la longueur de chaîne.

AnalyzeDocumentRequest

Paramètres d’analyse de document.

Nom	Type	Description
base64Source	string	Encodage en base64 du document à analyser. UrlSource ou base64Source doit être spécifié.
urlSource	string	URL du document à analyser. UrlSource ou base64Source doit être spécifié.

DocumentAnalysisFeature

Liste des fonctionnalités d’analyse facultatives.

Nom	Type	Description
barcodes	string	Activez la détection des codes-barres dans le document.
formulas	string	Activez la détection d’expressions mathématiques dans le document.
keyValuePairs	string	Activez la détection des paires de valeurs de clé générales (champs de formulaire) dans le document.
languages	string	Activez la détection de la langue de contenu de texte.
ocrHighResolution	string	Effectuez l’OCR à une résolution plus élevée pour gérer les documents avec des caractères fins.
styleFont	string	Activez la reconnaissance de différents styles de police.

Error

Informations d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	Error[]	Liste des erreurs détaillées.
innererror	InnerError	Erreur détaillée.
message	string	Message d’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	Error	Informations d’erreur.

InnerError

Erreur détaillée.

Nom	Type	Description
code	string	Code d’erreur.
innererror	InnerError	Erreur détaillée.
message	string	Message d’erreur.

StringIndexType

Méthode utilisée pour calculer le décalage et la longueur de chaîne.

Nom	Type	Description
textElements	string	Caractère d’affichage perçu par l’utilisateur, ou cluster graphème, tel que défini par Unicode 8.0.0.
unicodeCodePoint	string	Unité de caractères représentée par un seul point de code Unicode. Utilisé par Python 3.
utf16CodeUnit	string	Unité de caractères représentée par une unité de code Unicode 16 bits. Utilisé par JavaScript, Java et .NET.