Document Classifiers - Build Classifier

  • Referenz
Dienst:
Azure AI Services
API-Version:
2024-07-31-preview

Erstellt einen benutzerdefinierten Dokumentklassifizierer.

POST {endpoint}/documentintelligence/documentClassifiers:build?api-version=2024-07-31-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

uri

Der Document Intelligence-Dienstendpunkt.
api-version
 query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
classifierId True

string

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

Basisklassifizierer-ID, über die der Klassifizierer trainiert werden soll.
description

string

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

ErrorResponse

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

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:build?api-version=2024-07-31-preview

{
  "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-07-31-preview

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.
Error

Das Fehlerobjekt.
ErrorResponse

Fehlerantwortobjekt.
InnerError

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

AzureBlobContentSource

Azure Blob Storage-Inhalt.

Name Typ Beschreibung
containerUrl

string

Azure Blob Storage-Container-URL.
prefix

string

Blobnamenpräfix.

AzureBlobFileListContentSource

Dateiliste in Azure Blob Storage.

Name Typ Beschreibung
containerUrl

string

Azure Blob Storage-Container-URL.
fileList

string

Pfad zu einer JSONL-Datei innerhalb des Containers, der eine Teilmenge von Dokumenten angibt.

BuildDocumentClassifierRequest

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

Basisklassifizierer-ID, über die der Klassifizierer trainiert werden soll.
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 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

Typ der Inhaltsquelle.

Name Typ Beschreibung
azureBlob

string

Dateien in einem Pfad innerhalb eines Azure Blob Storage-Containers.
azureBlobFileList

string

Eine Dateiliste, die einzelne Dateien in einem Azure Blob Storage-Container angibt.
base64

string

Inhalte, die über die Base64-Codierung dargestellt werden.
url

string

Inhalt an einer bestimmten URL.

Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
details

Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

InnerError

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.

ErrorResponse

Fehlerantwortobjekt.

Name Typ Beschreibung
error

Error

Fehlerinformationen.

InnerError

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

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.
innererror

InnerError

Innerer Fehler.
message

string

Eine lesbare Darstellung des Fehlers.