Document Models - Analyze Document

Service:

Azure AI Services

Version d'API:

2022-08-31

Analyse le document avec le modèle de document.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	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. Modèle d’expression régulière: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}
api-version	query	True	ApiVersion	Version de l’API demandée.
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" Modèle d’expression régulière: ^(\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"

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

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

Nom	Type	Description
base64Source	string	Encodage en base64 du document à analyser
urlSource	string	URL du document à analyser

Réponses

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

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

AnalyzeDocument_Base64

AnalyzeDocument_Url

AnalyzeDocument_Base64

Exemple de requête

HTTP

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

{
  "base64Source": ""
}

Exemple de réponse

Code d’état:

202

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

AnalyzeDocument_Url

Exemple de requête

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

Exemple de réponse

Code d’état:

202

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

Définitions

Nom	Description
AnalyzeDocumentRequest	Paramètres d’analyse de document.
ApiVersion	Version de l’API.
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	string	URL du document à analyser

ApiVersion

Version de l’API.

Nom	Type	Description
2022-08-31	string

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
unicodeCodePoint	string
utf16CodeUnit	string