Miscellaneous Operations - Get Operation

Service:

Azure AI Services

Version d'API:

2024-07-31-preview

Obtient les informations d’opération.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&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.
operationId	path	True	string	ID d’opération
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string uuid	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom	Type	Description
200 OK	OperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	La demande a réussi. En-têtes x-ms-client-request-id: string
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 Operation

Exemple de requête

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getOperation&api-version=2024-07-31-preview

Exemple de réponse

Code d’état:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-07-31-preview"
  }
}

Définitions

Nom	Description
AzureBlobContentSource	Contenu stockage Blob Azure.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
ClassifierDocumentTypeDetails	Informations de type de document classifieur.
ContentSourceKind	Type de source de contenu.
DocumentAnalysisFeature	Fonctionnalités d’analyse de document à activer.
DocumentBuildMode	Mode de génération de modèle de document personnalisé.
DocumentClassifierBuildOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentClassifierCopyToOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentClassifierDetails	Informations de classifieur de document.
DocumentFieldSchema	Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON.
DocumentFieldType	Type de données sémantiques de la valeur du champ.
DocumentModelBuildOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentModelComposeOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentModelCopyToOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentModelDetails	Informations sur le modèle de document.
DocumentTypeDetails	Informations sur le type de document.
Error	Objet d’erreur.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Objet contenant des informations plus spécifiques sur l’erreur.
OperationKind	Type d’opération.
OperationStatus	État de l’opération.
SplitMode	Comportement de fractionnement de fichiers.
Warning	Objet d’erreur.

AzureBlobContentSource

Contenu stockage Blob Azure.

Nom	Type	Description
containerUrl	string	URL du conteneur Stockage Blob Azure.
prefix	string	Préfixe de nom d’objet blob.

AzureBlobFileListContentSource

Liste de fichiers dans Stockage Blob Azure.

Nom	Type	Description
containerUrl	string	URL du conteneur Stockage Blob Azure.
fileList	string	Chemin d’accès à un fichier JSONL dans le conteneur spécifiant un sous-ensemble de documents.

ClassifierDocumentTypeDetails

Informations de type de document classifieur.

Nom	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Liste de fichiers Stockage Blob Azure spécifiant les données d’entraînement d’un type de document classifieur. AzureBlobSource ou azureBlobFileListSource doit être spécifié.
azureBlobSource	AzureBlobContentSource	Emplacement stockage Blob Azure contenant les données d’apprentissage d’un type de document classifieur. AzureBlobSource ou azureBlobFileListSource doit être spécifié.
sourceKind	ContentSourceKind	Type de source de données d’apprentissage.

ContentSourceKind

Type de source de contenu.

Nom	Type	Description
azureBlob	string	Fichiers dans un chemin d’accès au sein d’un conteneur Stockage Blob Azure.
azureBlobFileList	string	Liste de fichiers spécifiant des fichiers individuels dans un conteneur Stockage Blob Azure.
base64	string	Contenu représenté par l’encodage Base64.
url	string	Contenu à une URL spécifique.

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.

DocumentBuildMode

Mode de génération de modèle de document personnalisé.

Nom	Type	Description
generative	string	Activez les documents de tous les types à l’aide de techniques d’IA génératives.
neural	string	Prise en charge des documents avec différents modèles visuels.
template	string	Cibler des documents avec des modèles visuels similaires.

DocumentClassifierBuildOperationDetails

Obtenir l’objet de réponse de l’opération.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer cette opération.
createdDateTime	string	Date et heure (UTC) de la création de l’opération.
error	Error	Erreur rencontrée.
kind	string: documentClassifierBuild	Type d’opération.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour de l’état.
operationId	string	ID d’opération
percentCompleted	integer	Progression de l’opération (0-100).
resourceLocation	string	URL de la ressource ciblée par cette opération.
result	DocumentClassifierDetails	Résultat de l’opération en cas de réussite.
status	OperationStatus	État de l’opération. notStarted, running, completed ou failed
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentClassifierCopyToOperationDetails

Obtenir l’objet de réponse de l’opération.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer cette opération.
createdDateTime	string	Date et heure (UTC) de la création de l’opération.
error	Error	Erreur rencontrée.
kind	string: documentClassifierCopyTo	Type d’opération.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour de l’état.
operationId	string	ID d’opération
percentCompleted	integer	Progression de l’opération (0-100).
resourceLocation	string	URL de la ressource ciblée par cette opération.
result	DocumentClassifierDetails	Résultat de l’opération en cas de réussite.
status	OperationStatus	État de l’opération. notStarted, running, completed ou failed
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentClassifierDetails

Informations de classifieur de document.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer ce classifieur de document.
baseClassifierId	string	ClassifierId de base sur lequel le classifieur a été formé.
classifierId	string	Nom de classifieur de document unique.
createdDateTime	string	Date et heure (UTC) lors de la création du classifieur de document.
description	string	Description du classifieur de document.
docTypes	<string,  ClassifierDocumentTypeDetails>	Liste des types de documents à classer.
expirationDateTime	string	Date et heure (UTC) à laquelle le classifieur de document expire.
warnings	Warning[]	Liste des avertissements rencontrés lors de la génération du classifieur.

DocumentFieldSchema

Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON.

Nom	Type	Description
description	string	Description du champ.
example	string	Exemple de contenu de champ.
items	DocumentFieldSchema	Schéma de type de champ de chaque élément de tableau.
properties	<string,  DocumentFieldSchema>	Sous-champs nommés du champ objet.
type	DocumentFieldType	Type de données sémantiques de la valeur du champ.

DocumentFieldType

Type de données sémantiques de la valeur du champ.

Nom	Type	Description
address	string	Adresse analysée.
array	string	Liste des sous-champs du même type.
boolean	string	Valeur booléenne, normalisée en true ou false.
countryRegion	string	Pays/région, normalisé au format ISO 3166-1 alpha-3 (par exemple aux États-Unis).
currency	string	Montant monétaire avec symbole et unité monétaire facultatifs.
date	string	Date, normalisée au format ISO 8601 (AAAA-MM-DD).
integer	string	Nombre entier, normalisé en entier signé 64 bits.
number	string	Nombre à virgule flottante, normalisé à double précision à virgule flottante.
object	string	Liste nommée des sous-champs de types potentiellement différents.
phoneNumber	string	Numéro de téléphone, normalisé au format E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Tableau de valeurs de chaîne sélectionnées.
selectionMark	string	Le champ est-il sélectionné ?
signature	string	La signature est-elle présente ?
string	string	Texte brut.
time	string	Heure, normalisée au format ISO 8601 (hh :mm :ss).

DocumentModelBuildOperationDetails

Obtenir l’objet de réponse de l’opération.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer cette opération.
createdDateTime	string	Date et heure (UTC) de la création de l’opération.
error	Error	Erreur rencontrée.
kind	string: documentModelBuild	Type d’opération.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour de l’état.
operationId	string	ID d’opération
percentCompleted	integer	Progression de l’opération (0-100).
resourceLocation	string	URL de la ressource ciblée par cette opération.
result	DocumentModelDetails	Résultat de l’opération en cas de réussite.
status	OperationStatus	État de l’opération. notStarted, running, completed ou failed
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentModelComposeOperationDetails

Obtenir l’objet de réponse de l’opération.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer cette opération.
createdDateTime	string	Date et heure (UTC) de la création de l’opération.
error	Error	Erreur rencontrée.
kind	string: documentModelCompose	Type d’opération.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour de l’état.
operationId	string	ID d’opération
percentCompleted	integer	Progression de l’opération (0-100).
resourceLocation	string	URL de la ressource ciblée par cette opération.
result	DocumentModelDetails	Résultat de l’opération en cas de réussite.
status	OperationStatus	État de l’opération. notStarted, running, completed ou failed
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentModelCopyToOperationDetails

Obtenir l’objet de réponse de l’opération.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer cette opération.
createdDateTime	string	Date et heure (UTC) de la création de l’opération.
error	Error	Erreur rencontrée.
kind	string: documentModelCopyTo	Type d’opération.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour de l’état.
operationId	string	ID d’opération
percentCompleted	integer	Progression de l’opération (0-100).
resourceLocation	string	URL de la ressource ciblée par cette opération.
result	DocumentModelDetails	Résultat de l’opération en cas de réussite.
status	OperationStatus	État de l’opération. notStarted, running, completed ou failed
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentModelDetails

Informations sur le modèle de document.

Nom	Type	Valeur par défaut	Description
apiVersion	string		Version de l’API utilisée pour créer ce modèle de document.
azureBlobFileListSource	AzureBlobFileListContentSource		Liste de fichiers stockage Blob Azure spécifiant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doit être spécifié.
azureBlobSource	AzureBlobContentSource		Emplacement stockage Blob Azure contenant les données d’apprentissage. AzureBlobSource ou azureBlobFileListSource doit être spécifié.
buildMode	DocumentBuildMode		Mode de génération de modèle de document personnalisé.
classifierId	string		Pour les modèles composés, le classifieur personnalisé à fractionner et classifier le fichier d’entrée.
createdDateTime	string		Date et heure (UTC) lors de la création du modèle de document.
description	string		Description du modèle de document.
docTypes	<string,  DocumentTypeDetails>		Types de documents pris en charge.
expirationDateTime	string		Date et heure (UTC) à laquelle le modèle de document expire.
modelId	string		Nom unique du modèle de document.
split	SplitMode	none	Pour les modèles composés, le comportement de fractionnement de fichier.
tags	object		Liste des attributs de balise clé-valeur associés au modèle de document.
trainingHours	number		Nombre d’heures GPU équivalentes à V100 consommées pour l’entraînement du modèle.
warnings	Warning[]		Liste des avertissements rencontrés lors de la génération du modèle.

DocumentTypeDetails

Informations sur le type de document.

Nom	Type	Description
buildMode	DocumentBuildMode	Mode de génération de modèle de document personnalisé.
confidenceThreshold	number	Effectuez uniquement une analyse si la confiance docType est supérieure au seuil.
description	string	Description du modèle de document.
features	DocumentAnalysisFeature[]	Liste des fonctionnalités d’analyse facultatives.
fieldConfidence	object	Confiance estimée pour chaque champ.
fieldSchema	<string,  DocumentFieldSchema>	Description du schéma sémantique de document à l’aide d’une syntaxe de style de schéma JSON.
maxDocumentsToAnalyze	integer	Nombre maximal de documents de type spécifié à analyser. Default=all.
modelId	string	Modèle de document à utiliser pour l’analyse de documents avec un type spécifié.
queryFields	string[]	Liste des champs supplémentaires à extraire. Ex. « NumberOfGuests,StoreNumber »

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.

OperationKind

Type d’opération.

Nom	Type	Description
documentClassifierBuild	string	Générez un nouveau modèle de classifieur personnalisé.
documentClassifierCopyTo	string	Copiez un classifieur de document existant vers une ressource, une région ou un abonnement différent.
documentModelBuild	string	Générez un nouveau modèle de document personnalisé.
documentModelCompose	string	Composez un nouveau modèle de document personnalisé à partir de modèles existants.
documentModelCopyTo	string	Copiez un modèle de document existant vers une ressource, une région ou un abonnement différent.

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.

SplitMode

Comportement de fractionnement de fichiers.

Nom	Type	Description
auto	string	Fractionner automatiquement le fichier en documents.
none	string	Traitez l’intégralité du fichier en tant que document unique.
perPage	string	Traitez chaque page du fichier comme un document distinct.

Warning

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’avertissement définis par le serveur.
message	string	Représentation lisible par l’homme de l’avertissement.
target	string	Cible de l’erreur.