Document Classifiers - Get Classifier

Service:

Azure AI Services

API Version:

2024-02-29-preview

Ruft detaillierte Dokumentklassifizierungsinformationen ab.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-02-29-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
classifierId	path	True	string	Eindeutiger Dokumentklassifizierername. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Ein undurchsichtiger, global eindeutiger, vom Client generierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	DocumentClassifierDetails	Die Anforderung war erfolgreich. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Eine unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Beispiele

Get Document Classifier

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier 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": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
ClassifierDocumentTypeDetails	Informationen zum Klassifiziererdokumenttyp.
ContentSourceKind	Typ der Inhaltsquelle.
DocumentClassifierDetails	Dokumentklassifizierungsinformationen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
Warning	Das Fehlerobjekt.

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 innerhalb des Containers, der eine Teilmenge von Dokumenten angibt.

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.
sourceKind	ContentSourceKind	Typ der Trainingsdatenquelle.

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	Inhalt, der über die Base64-Codierung dargestellt wird.
url	string	Inhalt an einer bestimmten URL.

DocumentClassifierDetails

Dokumentklassifizierungsinformationen.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Dokumentklassifizierers verwendet wird.
baseClassifierId	string	Basisklassifizierer-Id, auf der der Klassifizierer trainiert wurde.
classifierId	string	Eindeutiger Dokumentklassifizierername.
createdDateTime	string	Datum und Uhrzeit (UTC), zu dem der Dokumentklassifizierer erstellt wurde.
description	string	Beschreibung des Dokumentklassifizierers.
docTypes	<string,  ClassifierDocumentTypeDetails>	Liste der Zu klassifizierenden Dokumenttypen.
expirationDateTime	string	Datum und Uhrzeit (UTC), wann die Dokumentklassifizierung abläuft.
warnings	Warning[]	Liste der Warnungen, die beim Erstellen des Klassifizierers aufgetreten sind.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz 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	Einer von einem serverdefiniertem Satz von Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

Warning

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer von einem serverdefiniertem Satz von Warnungscodes.
message	string	Eine lesbare Darstellung der Warnung.
target	string	Das Ziel des Fehlers.