Miscellaneous Operations - Get Document Classifier Build Operation

Référence

Service:: Azure AI Services

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

Obtient les informations d’opération.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&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	DocumentClassifierBuildOperationDetails	La demande a réussi. En-têtes x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Nom

Type

Description

200 OK

DocumentClassifierBuildOperationDetails

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 - Document Classifier Build

Exemple de requête

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&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": "documentClassifierBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
  "result": {
    "classifierId": "myClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-07-31-preview",
    "docTypes": {
      "formA": {
        "azureBlobSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "prefix": "formADocs/"
        }
      },
      "formB": {
        "azureBlobFileListSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "fileList": "formB.jsonl"
        }
      }
    }
  }
}

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.
DocumentClassifierBuildOperationDetails	Obtenir l’objet de réponse de l’opération.
DocumentClassifierDetails	Informations de classifieur 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.
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.

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.

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.

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.

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.

Partager via

Miscellaneous Operations - Get Document Classifier Build Operation

Paramètres URI

En-tête de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

OAuth2Auth

Étendues

Exemples

Get Operation - Document Classifier Build

Exemple de requête

Exemple de réponse

Définitions

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

Warning

Ressources supplémentaires