Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Analyse le document avec le modèle de document.

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Point de terminaison du service Document Intelligence.
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 à utiliser pour cette opération.
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 »).
outputContentFormat	query		ContentFormat	Format du contenu de niveau supérieur du résultat d’analyse.
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+)?))*$
queryFields	query		string[]	Liste des champs supplémentaires à extraire. Ex. « NumberOfGuests,StoreNumber »
stringIndexType	query		StringIndexType	Méthode utilisée pour calculer le décalage et la longueur de chaîne.

Corps de la demande

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 a été acceptée pour traitement, mais le traitement n’est pas encore terminé. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

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

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

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

Définitions

Nom	Description
AnalyzeDocumentRequest	Paramètres d’analyse de document.
ContentFormat	Format du contenu dans le résultat analysé.
DocumentAnalysisFeature	Liste des fonctionnalités d’analyse facultatives.
Error	Objet error.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Objet contenant des informations plus spécifiques sur l’erreur.
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é.

ContentFormat

Format du contenu dans le résultat analysé.

Nom	Type	Description
markdown	string	Représentation Markdown du contenu du document avec des en-têtes de section, des tables, etc.
text	string	Représentation en texte brut du contenu du document sans mise en forme.

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 clé-valeur générales (champs de formulaire) dans le document.
languages	string	Activez la détection de la langue du contenu texte.
ocrHighResolution	string	Effectuez la reconnaissance optique de caractères à une résolution plus élevée pour gérer les documents avec des caractères affinés.
queryFields	string	Activez l’extraction de champs supplémentaires via le paramètre de requête queryFields.
styleFont	string	Activer la reconnaissance de différents styles de police.

Error

Objet error.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	Error	Informations sur l’erreur.

InnerError

Objet contenant des informations plus spécifiques sur l’erreur.

Nom	Type	Description
code	string	Un des ensembles de codes d’erreur définis par le serveur.
innererror	InnerError	Erreur interne.
message	string	Représentation lisible de l’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 point de code Unicode unique. 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.