Document Models - Analyze Document From Stream
Analyse le document avec le modèle de document.
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview
POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?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. |
model
|
path | True |
string |
Nom du modèle de document unique. Regex pattern: |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
features
|
query |
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 »). |
|
output
|
query |
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: |
|
query
|
query |
string[] |
Liste des champs supplémentaires à extraire. Ex. « NumberOfGuests,StoreNumber » |
|
string
|
query |
Méthode utilisée pour calculer le décalage et la longueur de chaîne. |
Corps de la demande
Media Types: "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 |
---|---|---|
input |
string |
Contenu d’entrée. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
La demande a été acceptée pour traitement, mais le traitement n’est pas encore terminé. Headers
|
|
Other Status Codes |
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 Url
Sample Request
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements
"{binaryFile}"
Sample Response
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 |
---|---|
Content |
Format du contenu dans le résultat analysé. |
Document |
Liste des fonctionnalités d’analyse facultatives. |
Error |
Objet error. |
Error |
Objet de réponse d’erreur. |
Inner |
Objet contenant des informations plus spécifiques sur l’erreur. |
String |
Méthode utilisée pour calculer le décalage et la longueur de chaîne. |
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 |
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 |
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 |
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. |