Document Classifiers - Build Classifier

Dienst:

Azure AI Services

API-Version:

2024-11-30

Erstellt einen benutzerdefinierten Dokumentklassifizierer.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-11-30

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
classifierId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentklassifizierername.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Liste der Zu klassifizierenden Dokumenttypen.
allowOverwrite		boolean	Zulassen, dass ein vorhandener Klassifizierer mit demselben Namen überschrieben wird.
baseClassifierId		string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Basisklassifizierer-ID, über die der Klassifizierer trainiert werden soll.
description		string maxLength: 4096	Beschreibung des Dokumentklassifizierers.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Build Document Classifier

Beispielanforderung

HTTP

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

{
  "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"
      }
    }
  }
}

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-11-30

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage-Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
BuildDocumentClassifierRequest	Fordern Sie den Textkörper an, um einen neuen benutzerdefinierten Dokumentklassifizierer zu erstellen.
ClassifierDocumentTypeDetails	Informationen zum Klassifiziererdokumenttyp.
ContentSourceKind	Typ der Inhaltsquelle.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.

AzureBlobContentSource

Objekt

Azure Blob Storage-Inhalt.

Name	Typ	Beschreibung
containerUrl	string (uri)	Azure Blob Storage-Container-URL.
prefix	string	Blobnamenpräfix.

AzureBlobFileListContentSource

Objekt

Dateiliste in Azure Blob Storage.

Name	Typ	Beschreibung
containerUrl	string (uri)	Azure Blob Storage-Container-URL.
fileList	string	Pfad zu einer JSONL-Datei innerhalb des Containers, der eine Teilmenge von Dokumenten angibt.

BuildDocumentClassifierRequest

Objekt

Fordern Sie den Textkörper an, um einen neuen benutzerdefinierten Dokumentklassifizierer zu erstellen.

Name	Typ	Standardwert	Beschreibung
allowOverwrite	boolean	False	Zulassen, dass ein vorhandener Klassifizierer mit demselben Namen überschrieben wird.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Basisklassifizierer-ID, über die der Klassifizierer trainiert werden soll.
classifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Eindeutiger Dokumentklassifizierername.
description	string maxLength: 4096		Beschreibung des Dokumentklassifizierers.
docTypes	<string,  ClassifierDocumentTypeDetails>		Liste der Zu klassifizierenden Dokumenttypen.

ClassifierDocumentTypeDetails

Objekt

Informationen zum Klassifiziererdokumenttyp.

Name	Typ	Beschreibung
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage-Dateiliste, die die Schulungsdaten für einen Klassifiziererdokumenttyp angibt. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage-Speicherort, der die Schulungsdaten für einen Klassifiziererdokumenttyp enthält. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
sourceKind	ContentSourceKind	Typ der Schulungsdatenquelle.

ContentSourceKind

Enumeration

Typ der Inhaltsquelle.

Wert	Beschreibung
url	Inhalt an einer bestimmten URL.
base64	Inhalte, die über die Base64-Codierung dargestellt werden.
azureBlob	Dateien in einem Pfad innerhalb eines Azure Blob Storage-Containers.
azureBlobFileList	Eine Dateiliste, die einzelne Dateien in einem Azure Blob Storage-Container angibt.

DocumentIntelligenceError

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

DocumentIntelligenceErrorResponse

Objekt

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	DocumentIntelligenceInnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.