Document Classifiers - Build Classifier

Service:

Azure AI Services

API Version:

2023-07-31

Erstellt einen benutzerdefinierten Dokumentklassifizierer.

POST {endpoint}/formrecognizer/documentClassifiers:build?api-version=2023-07-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
api-version	query	True	string	Angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
classifierId	True	string	Eindeutiger Dokumentklassifizierername.
docTypes	True	<string,  ClassifierDocumentTypeDetails>	Liste der Zu klassifizierenden Dokumenttypen.
description		string	Beschreibung des Dokumentklassifizierers.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wird erfolgreich in die Warteschlange gestellt. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
BuildDocumentClassifierRequest	Anforderungstext zum Erstellen einer neuen benutzerdefinierten Dokumentklassifizierung.
ClassifierDocumentTypeDetails	Informationen zum Klassifiziererdokumenttyp.
Error	Fehlerinformationen.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Detaillierter Fehler.

AzureBlobContentSource

Azure Blob Storage Inhalt.

Name	Typ	Beschreibung
containerUrl	string	Azure Blob Storage Container-URL.
prefix	string	Präfix des Blobnamens.

AzureBlobFileListContentSource

Dateiliste in Azure Blob Storage.

Name	Typ	Beschreibung
containerUrl	string	Azure Blob Storage Container-URL.
fileList	string	Pfad zu einer JSONL-Datei im Container, die eine Teilmenge der Dokumente für das Training angibt.

BuildDocumentClassifierRequest

Anforderungstext zum Erstellen einer neuen benutzerdefinierten Dokumentklassifizierung.

Name	Typ	Beschreibung
classifierId	string	Eindeutiger Dokumentklassifizierername.
description	string	Beschreibung des Dokumentklassifizierers.
docTypes	<string,  ClassifierDocumentTypeDetails>	Liste der Zu klassifizierenden Dokumenttypen.

ClassifierDocumentTypeDetails

Informationen zum Klassifiziererdokumenttyp.

Name	Typ	Beschreibung
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage Dateiliste, die die Trainingsdaten für einen Klassifiziererdokumenttyp angibt. Es muss entweder azureBlobSource oder azureBlobFileListSource angegeben werden.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage Speicherort, der die Trainingsdaten für einen Klassifiziererdokumenttyp enthält. Es muss entweder azureBlobSource oder azureBlobFileListSource angegeben werden.

Error

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	Error[]	Liste der detaillierten Fehler.
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.