Document Classifiers - Get Classifier

Dienst:

Azure AI Services

API-Version:

2024-07-31-preview

Ruft detaillierte Dokumentklassifiziererinformationen ab.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-07-31-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
classifierId	path	True	string	Eindeutiger Dokumentklassifizierername. RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
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.

Anforderungsheader

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

Antworten

Name	Typ	Beschreibung
200 OK	DocumentClassifierDetails	Die Anforderung ist erfolgreich. Header x-ms-client-request-id: string
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

Get Document Classifier

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-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	Dokumentklassifiziererinformationen.
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	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.

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.

DocumentClassifierDetails

Dokumentklassifiziererinformationen.

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

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.

Warning

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der serverdefinierten Warnungscodes.
message	string	Eine lesbare Darstellung der Warnung.
target	string	Das Ziel des Fehlers.