Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

Génère un classifieur de documents personnalisé.

POST {endpoint}/formrecognizer/documentClassifiers:build?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).
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 de votre abonnement Azure Cognitive Services.

Corps de la demande

Nom	Obligatoire	Type	Description
classifierId	True	string	Nom unique du classifieur de document.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Liste des types de documents à classer.
description		string	Description du classifieur de document.

Réponses

Nom	Type	Description
202 Accepted		La demande est mise en file d’attente. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Erreur rencontrée.

Sécurité

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

Exemples

Build Document Classifier

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentClassifiers:build?api-version=2023-07-31

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Sample Response

Status code:

202

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

Définitions

Nom	Description
AzureBlobContentSource	Stockage Blob Azure contenu.
AzureBlobFileListContentSource	Liste de fichiers dans Stockage Blob Azure.
BuildDocumentClassifierRequest	Corps de la demande pour créer un nouveau classifieur de documents personnalisé.
ClassifierDocumentTypeDetails	Informations sur le type de document classifieur.
Error	Informations d’erreur.
ErrorResponse	Objet de réponse d’erreur.
InnerError	Erreur détaillée.

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 pour l’entraînement.

BuildDocumentClassifierRequest

Corps de la demande pour créer un nouveau classifieur de documents personnalisé.

Nom	Type	Description
classifierId	string	Nom unique du classifieur de document.
description	string	Description du classifieur de document.
docTypes	<string,  ClassifierDocumentTypeDetails>	Liste des types de documents à classer.

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.

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.