Document Classifiers - List Classifiers

Service:

Azure AI Services

Version d'API:

2024-11-30

Répertorier tous les classifieurs de document.

GET {endpoint}/documentintelligence/documentClassifiers?api-version=2024-11-30

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string uri	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 requête.

Réponses

Nom	Type	Description
200 OK	PagedDocumentClassifierDetails	La demande a réussi. En-têtes x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	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 Document Classifiers

Exemple de requête

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?api-version=2024-11-30

Exemple de réponse

Code d’état:

200

{
  "value": [
    {
      "classifierId": "classifier1",
      "description": "Classifier1 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "docTypes": {
        "formA": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formADocs/"
          }
        },
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        }
      }
    },
    {
      "classifierId": "classifier2",
      "description": "Classifier2 description",
      "createdDateTime": "2022-07-30T00:00:00Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "apiVersion": "2024-11-30",
      "docTypes": {
        "formB": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formBDocs/"
          }
        },
        "formC": {
          "azureBlobSource": {
            "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
            "prefix": "formCDocs/"
          }
        }
      }
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?nextLink=nextLinkData"
}

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.
DocumentClassifierDetails	Informations de classifieur de document.
DocumentIntelligenceError	Objet d’erreur.
DocumentIntelligenceErrorResponse	Objet de réponse d’erreur.
DocumentIntelligenceInnerError	Objet contenant des informations plus spécifiques sur l’erreur.
DocumentIntelligenceWarning	Objet d’erreur.
PagedDocumentClassifierDetails	Collection paginée d’éléments DocumentClassifierDetails

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.

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.
modifiedDateTime	string	Date et heure (UTC) de la dernière modification du modèle de document.
warnings	DocumentIntelligenceWarning[]	Liste des avertissements rencontrés lors de la génération du classifieur.

DocumentIntelligenceError

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	DocumentIntelligenceError[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	DocumentIntelligenceError	Informations d’erreur.

DocumentIntelligenceInnerError

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	DocumentIntelligenceInnerError	Erreur interne.
message	string	Représentation lisible par l’homme de l’erreur.

DocumentIntelligenceWarning

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.

PagedDocumentClassifierDetails

Collection paginée d’éléments DocumentClassifierDetails

Nom	Type	Description
nextLink	string	Lien vers la page suivante des éléments
value	DocumentClassifierDetails[]	Éléments DocumentClassifierDetails sur cette page