Document Models - Get Analyze Batch Result

Référence

Service:: Azure AI Services

Version d'API:: 2024-07-31-preview

Obtient le résultat de l’analyse de document par lots.

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults/{resultId}?api-version=2024-07-31-preview

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}$`
resultId	path	True	string uuid	Analyser l’ID de résultat de l’opération de traitement par lots.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	AnalyzeBatchResultOperation	La demande a réussi.
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

Get Analyze Batch Documents Result

Exemple de requête

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

Exemple de réponse

Code d’état:: 200

{
  "status": "completed",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "result": {
    "succeededCount": 1,
    "failedCount": 1,
    "skippedCount": 1,
    "details": [
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file1.pdf",
        "resultUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer/trainingDocsResult/file1.pdf.ocr.json",
        "status": "succeeded"
      },
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file2.jpg",
        "status": "failed",
        "error": {
          "code": "InvalidRequest",
          "message": "Invalid request.",
          "innererror": {
            "code": "InvalidContent",
            "message": "The file format is unsupported or corrupted. Refer to documentation for the list of supported formats."
          }
        }
      },
      {
        "sourceUrl": "https://myStorageAccount.blob.core.windows.net/myContainer/trainingDocs/file3.png",
        "status": "skipped"
      }
    ]
  }
}

Définitions

Nom	Description
AnalyzeBatchOperationDetail	Détail de l’opération pour un document dans une analyse par lots.
AnalyzeBatchResult	Résultat de l’analyse de document batch.
AnalyzeBatchResultOperation	État et résultat de l’opération d’analyse par lots.
Error	Objet d’erreur.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Objet contenant des informations plus spécifiques sur l’erreur.
OperationStatus	État de l’opération.

AnalyzeBatchOperationDetail

Détail de l’opération pour un document dans une analyse par lots.

Nom	Type	Description
error	Error	Erreur rencontrée.
resultUrl	string	URL du résultat d’analyse JSON.
sourceUrl	string	URL du document source.
status	OperationStatus	Analyser l’état. réussite, échec ou ignoré

AnalyzeBatchResult

Résultat de l’analyse de document batch.

Nom	Type	Description
details	AnalyzeBatchOperationDetail[]	Détails de l’opération pour chaque document du lot.
failedCount	integer	Nombre de documents qui se sont terminés avec l’état ont échoué.
skippedCount	integer	Nombre de documents qui se sont terminés avec l’état ignoré.
succeededCount	integer	Nombre de documents qui se sont terminés avec l’état réussi.

AnalyzeBatchResultOperation

État et résultat de l’opération d’analyse par lots.

Nom	Type	Description
createdDateTime	string	Date et heure (UTC) de l’envoi de l’opération.
error	Error	Erreur rencontrée lors de l’analyse de document par lots.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour de l’état.
percentCompleted	integer	Progression de l’opération (0-100).
result	AnalyzeBatchResult	Résultat de l’analyse de document batch.
status	OperationStatus	État de l’opération. notStarted, running, completed ou failed

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.

OperationStatus

État de l’opération.

Nom	Type	Description
canceled	string	L’opération a été annulée.
completed	string	L’opération est terminée.
failed	string	L’opération a échoué.
notStarted	string	L’opération n’a pas encore démarré.
running	string	L’opération est en cours.
succeeded	string	L’opération a réussi.

Partager via