Freigeben über


Content Classifiers - Get

Abrufen von Klassifikatoreigenschaften.

GET {endpoint}/contentunderstanding/classifiers/{classifierId}?api-version=2025-05-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
classifierId
path True

string

pattern: ^[a-zA-Z0-9._-]{1,64}$

Die eindeutige Kennung des Klassifizierers.

endpoint
path True

string (uri)

Inhaltsverständnis-Dienstendpunkt.

api-version
query True

string

minLength: 1

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, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name Typ Beschreibung
200 OK

ContentClassifier

Die Anforderung ist erfolgreich.

Header

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

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 Classifier

Beispielanforderung

GET {endpoint}/contentunderstanding/classifiers/myClassifier?api-version=2025-05-01-preview

Beispiel für eine Antwort

{
  "classifierId": "myClassifier",
  "description": "My classifier",
  "tags": {
    "createdBy": "John"
  },
  "status": "ready",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "splitMode": "auto",
  "categories": {
    "receipt": {
      "description": "Sales receipts"
    },
    "invoice": {
      "analyzerId": "myInvoice"
    }
  }
}

Definitionen

Name Beschreibung
Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

ClassifierCategory

Eine Klassifikatorkategorie.

ClassifierSplitMode

Modus zum Aufteilen von Eingaben in Inhaltsobjekte.

ContentClassifier

Klassifizierer, der Inhalte in Kategorien mit optionaler Aufteilung klassifiziert.

ProcessingLocation

Der Ort, an dem die Daten verarbeitet werden können.

ResourceStatus

Status einer Ressource.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

details

Azure.Core.Foundations.Error[]

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

innererror

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message

string

Eine normal lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name Typ Beschreibung
error

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

innererror

Azure.Core.Foundations.InnerError

Innerer Fehler.

ClassifierCategory

Eine Klassifikatorkategorie.

Name Typ Beschreibung
analyzerId

string

Optionaler Analysator, der zum Verarbeiten des Inhalts verwendet wird.

description

string

Die Beschreibung der Kategorie.

ClassifierSplitMode

Modus zum Aufteilen von Eingaben in Inhaltsobjekte.

Wert Beschreibung
auto

Teilen Sie die Eingabe basierend auf den Eingabe- und Kategoriedefinitionen in Inhaltsobjekte auf.

noSplit

Behandeln Sie die gesamte Eingabe als ein einzelnes Inhaltsobjekt.

perPage

Teilen Sie jede Seite der Eingabe in ein separates Inhaltsobjekt auf.

ContentClassifier

Klassifizierer, der Inhalte in Kategorien mit optionaler Aufteilung klassifiziert.

Name Typ Standardwert Beschreibung
categories

<string,  ClassifierCategory>

Die Kategorien, nach denen klassifiziert werden soll.

classifierId

string

pattern: ^[a-zA-Z0-9._-]{1,64}$

Die eindeutige Kennung des Klassifizierers.

createdAt

string (date-time)

Das Datum und die Uhrzeit, zu der der Klassifikator erstellt wurde.

description

string

Eine Beschreibung des Klassifikators.

lastModifiedAt

string (date-time)

Das Datum und die Uhrzeit der letzten Änderung des Klassifikators.

processingLocation

ProcessingLocation

geography

Der Ort, an dem die Daten verarbeitet werden können.

splitMode

ClassifierSplitMode

noSplit

Modus zum Aufteilen von Eingaben in Inhaltsobjekte.

status

ResourceStatus

Der Status des Klassifikators.

tags

object

Tags, die dem Klassifikator zugeordnet sind.

warnings

Azure.Core.Foundations.Error[]

Warnungen, die beim Erstellen des Klassifikators aufgetreten sind.

ProcessingLocation

Der Ort, an dem die Daten verarbeitet werden können.

Wert Beschreibung
dataZone

Daten können in derselben Datenzone wie die Ressource verarbeitet werden.

geography

Daten können in derselben Geografie wie die Ressource verarbeitet werden.

global

Daten können in jedem Azure-Rechenzentrum weltweit verarbeitet werden.

ResourceStatus

Status einer Ressource.

Wert Beschreibung
creating

Die Ressource wird erstellt.

deleting

Die Ressource wird gelöscht.

failed

Fehler bei der Ressource beim Erstellen.

ready

Die Ressource ist bereit.