Miscellaneous - Get Operation

Service:

Azure AI Services

API Version:

2023-07-31

Obtient des informations sur l’opération.

GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string url	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus2.api.cognitive.microsoft.com).
operationId	path	True	string uuid	ID d’opération unique. Regex pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Clé secrète pour votre abonnement Azure Cognitive Services.

Réponses

Nom	Type	Description
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	OK.
Other Status Codes	ErrorResponse	Erreur rencontrée.

Sécurité

Ocp-Apim-Subscription-Key

Clé secrète pour votre abonnement Azure Cognitive Services.

Type: apiKey
In: header

Exemples

Get Operation

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Sample Response

Status code:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

Définitions

Nom	Description
AzureBlobContentSource	Stockage Blob Azure contenu.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
ClassifierDocumentTypeDetails	Informations sur le type de document classifieur.
DocumentBuildMode	Mode de génération de modèle de document personnalisé.
DocumentClassifierBuildOperationDetails	Obtient l’objet de réponse Operation.
DocumentClassifierDetails	Informations de classifieur de document.
DocumentFieldSchema	Description du schéma sémantique de champ à l’aide d’une syntaxe de style schéma JSON.
DocumentFieldType	Type de données sémantique de la valeur de champ.
DocumentModelBuildOperationDetails	Obtient l’objet de réponse Operation.
DocumentModelComposeOperationDetails	Obtient l’objet de réponse Operation.
DocumentModelCopyToOperationDetails	Obtient l’objet de réponse Operation.
DocumentModelDetails	Informations sur le modèle de document.
DocumentTypeDetails	Informations sur le type de document.
Error	Informations d’erreur.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Erreur détaillée.
OperationStatus	État de l’opération.

AzureBlobContentSource

Stockage Blob Azure contenu.

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

AzureBlobFileListContentSource

Liste de fichiers dans Stockage Blob Azure.

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

ClassifierDocumentTypeDetails

Informations sur le type de document classifieur.

Nom	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Stockage Blob Azure liste de fichiers spécifiant les données d’entraînement d’un type de document classifieur. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés.
azureBlobSource	AzureBlobContentSource	Stockage Blob Azure’emplacement contenant les données d’entraînement d’un type de document classifieur. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés.

DocumentBuildMode

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

Nom	Type	Description
neural	string	Documents de support avec divers modèles visuels.
template	string	Documents cibles avec des modèles visuels similaires.

DocumentClassifierBuildOperationDetails

Obtient l’objet de réponse Operation.

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 du status.
operationId	string	ID de l'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.
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.
classifierId	string	Nom unique du classifieur de document.
createdDateTime	string	Date et heure (UTC) de création du classifieur de documents.
description	string	Description du classifieur de document.
docTypes	<string,  ClassifierDocumentTypeDetails>	Liste des types de documents à classer.
expirationDateTime	string	Date et heure (UTC) d’expiration du classifieur de documents.

DocumentFieldSchema

Description du schéma sémantique de champ à l’aide d’une syntaxe de style 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 d’objet.
type	DocumentFieldType	Type de données sémantique de la valeur de champ.

DocumentFieldType

Type de données sémantique de la valeur de 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 sur true ou false.
countryRegion	string	Pays/région, normalisé au format ISO 3166-1 alpha-3 (par exemple, États-Unis).
currency	string	Montant monétaire avec symbole et unité de devise facultatifs.
date	string	Date, normalisée au format ISO 8601 (AAAA-MM-JJ).
integer	string	Nombre entier normalisé en entier signé 64 bits.
number	string	Nombre à virgule flottante, normalisé en virgule flottante double précision.
object	string	Liste nommée de sous-champs de types potentiellement différents.
phoneNumber	string	Numéro de téléphone, normalisé au format E.164 (+{CountryCode}{SubscriberNumber}).
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

Obtient l’objet de réponse Operation.

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 du status.
operationId	string	ID de l'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.
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentModelComposeOperationDetails

Obtient l’objet de réponse Operation.

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 du status.
operationId	string	ID de l'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.
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentModelCopyToOperationDetails

Obtient l’objet de réponse Operation.

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 du status.
operationId	string	ID de l'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.
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	Description
apiVersion	string	Version de l’API utilisée pour créer ce modèle de document.
createdDateTime	string	Date et heure (UTC) de 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) de l’expiration du modèle de document.
modelId	string	Nom du modèle de document unique.
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

DocumentTypeDetails

Informations sur le type de document.

Nom	Type	Description
buildMode	DocumentBuildMode	Mode de génération de modèle de document personnalisé.
description	string	Description du modèle de document.
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.

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.

OperationStatus

État de l’opération.

Nom	Type	Description
canceled	string	L’opération a été annulé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.