Document Models - Analyze Document From Stream

Service:

Azure AI Services

Version d'API:

2024-07-31-preview

Analyse le document avec le modèle de document.

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-07-31-preview

Avec des paramètres facultatifs:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-07-31-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	Point de terminaison du service Document Intelligence.
modelId	path	True	string	Nom unique du modèle de document. Modèle d’expression régulière: ^[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»).
output	query		AnalyzeOutputOption[]	Sorties supplémentaires à générer pendant l’analyse.
outputContentFormat	query		ContentFormat	Format du contenu de niveau supérieur d’analyse du résultat.
pages	query		string	Liste des numéros de page basés sur 1 à analyser. Ex. "1-3,5,7-9" Modèle d’expression régulière: ^(\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 de chaîne et la longueur.

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’a pas encore été terminé. En-têtes Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

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

Exemples

Analyze Document from Url

Exemple de requête

HTTP

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

"{binaryFile}"

Exemple de réponse

Code d’état:

202

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

Définitions

Nom	Description
AnalyzeOutputOption	Sorties supplémentaires à générer pendant l’analyse.
ContentFormat	Format du contenu dans le résultat analysé.
DocumentAnalysisFeature	Fonctionnalités d’analyse de document à activer.
Error	Objet d’erreur.
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 de chaîne et la longueur.

AnalyzeOutputOption

Sorties supplémentaires à générer pendant l’analyse.

Nom	Type	Description
figures	string	Générez des images rognées de figures détectées.
pdf	string	Générer une sortie PDF pouvant faire l’objet d’une recherche.

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 tableaux, etc.
text	string	Représentation en texte brut du contenu du document sans mise en forme.

DocumentAnalysisFeature

Fonctionnalités d’analyse de document à activer.

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

Error

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des 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 par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	Error	Informations d’erreur.

InnerError

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

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	InnerError	Erreur interne.
message	string	Représentation lisible par l’homme de l’erreur.

StringIndexType

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

Nom	Type	Description
textElements	string	Caractère d’affichage perçu par l’utilisateur ou cluster grapheme, 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.