Document Classifiers - List Classifiers

Service:

Azure AI Services

Version d'API:

2024-02-29-preview

Répertorier tous les classifieurs de documents.

GET {endpoint}/documentintelligence/documentClassifiers?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	PagedDocumentClassifierDetails	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 Document Classifiers

Exemple de requête

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers?api-version=2024-02-29-preview

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-02-29-preview",
      "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-02-29-preview",
      "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	Stockage Blob Azure contenu.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
ClassifierDocumentTypeDetails	Informations sur le type de document classifieur.
ContentSourceKind	Type de source de contenu.
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.
PagedDocumentClassifierDetails	Collection paginée d’éléments DocumentClassifierDetails
Warning	Objet d’erreur.

AzureBlobContentSource

Stockage Blob Azure contenu.

Nom	Type	Description
containerUrl	string	Stockage Blob Azure’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’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	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.
sourceKind	ContentSourceKind	Type de source de données d’entraînement.

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.

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,  ClassifierDocumentTypeDetails>	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.

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	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 des codes d’erreur définis par le serveur.
innererror	InnerError	Erreur interne.
message	string	Représentation lisible par l’homme 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 de cette page

Warning

Objet d’erreur.

Nom	Type	Description
code	string	Un des ensembles 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.