Miscellaneous Operations - List Operations
Listes toutes les opérations.
GET {endpoint}/documentintelligence/operations?api-version=2024-02-29-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Point de terminaison du service Document Intelligence. |
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 demande. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
La demande a réussi. En-têtes x-ms-client-request-id: string |
|
Other Status Codes |
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 Operations
Exemple de requête
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-02-29-preview
Exemple de réponse
{
"value": [
{
"operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
"status": "running",
"percentCompleted": 0,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:12:58Z",
"kind": "documentModelBuild",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
"apiVersion": "2024-02-29-preview"
}
],
"nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}
Définitions
Nom | Description |
---|---|
Azure |
Stockage Blob Azure contenu. |
Azure |
Liste de fichiers dans Stockage Blob Azure. |
Classifier |
Informations sur le type de document classifieur. |
Content |
Type de source de contenu. |
Document |
Mode de génération du modèle de document personnalisé. |
Document |
Obtient l’objet de réponse Operation. |
Document |
Informations de classifieur de document. |
Document |
Description du schéma sémantique de champ à l’aide d’une syntaxe de style de schéma JSON. |
Document |
Type de données sémantique de la valeur de champ. |
Document |
Obtient l’objet de réponse Operation. |
Document |
Obtient l’objet de réponse Operation. |
Document |
Obtient l’objet de réponse Operation. |
Document |
Informations sur le modèle de document. |
Document |
Informations sur le type de document. |
Error |
Objet d’erreur. |
Error |
Objet de réponse d’erreur. |
Inner |
Objet contenant des informations plus spécifiques sur l’erreur. |
Operation |
Type d’opération. |
Operation |
État de l’opération. |
Paged |
Collection paginée d’éléments OperationDetails |
Warning |
Objet error. |
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. |
ClassifierDocumentTypeDetails
Informations sur le type de document classifieur.
Nom | Type | Description |
---|---|---|
azureBlobFileListSource |
Stockage Blob Azure liste de fichiers spécifiant les données d’apprentissage d’un type de document classifieur. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés. |
|
azureBlobSource |
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. |
|
sourceKind |
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 dans 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é via l’encodage Base64. |
url |
string |
Contenu à une URL spécifique. |
DocumentBuildMode
Mode de génération du modèle de document personnalisé.
Nom | Type | Description |
---|---|---|
neural |
string |
Documents de support avec divers modèles visuels. |
template |
string |
Ciblez les documents 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 |
Erreur rencontrée. |
|
kind |
string:
document |
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 |
Résultat de l’opération en cas de réussite. |
|
status |
É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 |
Base classifierId sur lequel le classifieur a été entraîné. |
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,
Classifier |
Liste des types de documents à classer. |
expirationDateTime |
string |
Date et heure (UTC) d’expiration du classifieur de documents. |
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 |
Schéma de type de champ de chaque élément de tableau. |
|
properties |
<string,
Document |
Sous-champs nommés du champ d’objet. |
type |
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}). |
selectionGroup |
string |
Tableau des 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
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 |
Erreur rencontrée. |
|
kind |
string:
document |
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 |
Résultat de l’opération en cas de réussite. |
|
status |
É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
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 |
Erreur rencontrée. |
|
kind |
string:
document |
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 |
Résultat de l’opération en cas de réussite. |
|
status |
É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
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 |
Erreur rencontrée. |
|
kind |
string:
document |
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 |
Résultat de l’opération en cas de réussite. |
|
status |
É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 | Description |
---|---|---|
apiVersion |
string |
Version de l’API utilisée pour créer ce modèle de document. |
azureBlobFileListSource |
Stockage Blob Azure liste de fichiers spécifiant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés. |
|
azureBlobSource |
Stockage Blob Azure’emplacement contenant les données d’entraînement. AzureBlobSource ou azureBlobFileListSource doivent être spécifiés. |
|
buildMode |
Mode de génération de modèle de document personnalisé. |
|
createdDateTime |
string |
Date et heure (UTC) de création du modèle de document. |
description |
string |
Description du modèle de document. |
docTypes |
<string,
Document |
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. |
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 |
Mode de génération du modèle de document personnalisé. |
|
description |
string |
Description du modèle de document. |
fieldConfidence |
object |
Confiance estimée pour chaque champ. |
fieldSchema |
<string,
Document |
Description du schéma sémantique du document à l’aide d’une syntaxe de style de schéma JSON. |
Error
Objet d’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Un des codes d’erreur définis par le serveur. |
details |
Error[] |
Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée. |
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 |
Informations d’erreur. |
InnerError
Objet contenant des informations plus spécifiques sur l’erreur.
Nom | Type | Description |
---|---|---|
code |
string |
Un des codes d’erreur définis par le serveur. |
innererror |
Erreur interne. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
OperationKind
Type d’opération.
Nom | Type | Description |
---|---|---|
documentClassifierBuild |
string |
Créez un nouveau modèle de classifieur personnalisé. |
documentModelBuild |
string |
Créez 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 potentiellement 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. |
PagedOperationDetails
Collection paginée d’éléments OperationDetails
Nom | Type | Description |
---|---|---|
nextLink |
string |
Lien vers la page suivante des éléments |
value | OperationDetails[]: |
Éléments OperationDetails de cette page |
Warning
Objet error.
Nom | Type | Description |
---|---|---|
code |
string |
Un des ensembles de codes d’avertissement définis par le serveur. |
message |
string |
Représentation lisible de l’avertissement. |
target |
string |
Cible de l’erreur. |