Miscellaneous Operations - Get Document Classifier Copy To Operation

Dienst:: Azure AI Services

API-Version:: 2024-11-30

Ruft Vorgangsinformationen ab.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierCopyToOperation&api-version=2024-11-30

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Document Intelligence-Dienstendpunkt.
operationId	path	True	string	Vorgangs-ID
api-version	query	True	string minLength: 1	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	DocumentClassifierCopyToOperationDetails	Die Anforderung ist erfolgreich. Header x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

200 OK

DocumentClassifierCopyToOperationDetails

Die Anforderung ist erfolgreich.

Header

x-ms-client-request-id: string

Other Status Codes

DocumentIntelligenceErrorResponse

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 Operation - Document Classifier Copy To

Beispielanforderung

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierCopyToOperation&api-version=2024-11-30

Beispiel für eine Antwort

Statuscode:: 200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentClassifierCopyTo",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myCustomClassifier",
  "result": {
    "classifierId": "myCustomClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-11-30",
    "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.
DocumentClassifierCopyToOperationDetails	Dient zum Abrufen des Operation-Antwortobjekts.
DocumentClassifierDetails	Dokumentklassifiziererinformationen.
DocumentIntelligenceError	Das Fehlerobjekt.
DocumentIntelligenceErrorResponse	Fehlerantwortobjekt.
DocumentIntelligenceInnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
DocumentIntelligenceOperationStatus	Vorgangsstatus.
DocumentIntelligenceWarning	Das Fehlerobjekt.
OperationKind	Typ des Vorgangs.

AzureBlobContentSource

Objekt

Azure Blob Storage-Inhalt.

Name	Typ	Beschreibung
containerUrl	string (uri)	Azure Blob Storage-Container-URL.
prefix	string	Blobnamenpräfix.

AzureBlobFileListContentSource

Objekt

Dateiliste in Azure Blob Storage.

Name	Typ	Beschreibung
containerUrl	string (uri)	Azure Blob Storage-Container-URL.
fileList	string	Pfad zu einer JSONL-Datei innerhalb des Containers, der eine Teilmenge von Dokumenten angibt.

ClassifierDocumentTypeDetails

Objekt

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

Enumeration

Typ der Inhaltsquelle.

Wert	Beschreibung
url	Inhalt an einer bestimmten URL.
base64	Inhalte, die über die Base64-Codierung dargestellt werden.
azureBlob	Dateien in einem Pfad innerhalb eines Azure Blob Storage-Containers.
azureBlobFileList	Eine Dateiliste, die einzelne Dateien in einem Azure Blob Storage-Container angibt.

DocumentClassifierCopyToOperationDetails

Objekt

Dient zum Abrufen des Operation-Antwortobjekts.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Vorgangs verwendet wird.
createdDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann der Vorgang erstellt wurde.
error	DocumentIntelligenceError	Fehler.
kind	string: documentClassifierCopyTo	Typ des Vorgangs.
lastUpdatedDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann der Status zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID
percentCompleted	integer (int32) minimum: 0 maximum: 100	Vorgangsfortschritt (0-100).
resourceLocation	string (uri)	DIE URL der Ressource, die von diesem Vorgang verwendet wird.
result	DocumentClassifierDetails	Vorgangsergebnis nach Erfolg.
status	DocumentIntelligenceOperationStatus	Vorgangsstatus. notStarted, running, completed oder failed
tags	object	Liste der Schlüsselwerttagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentClassifierDetails

Objekt

Dokumentklassifiziererinformationen.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Dokumentklassifizierers verwendet wird.
baseClassifierId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Basisklassifizierer-ID, auf deren Grundlage der Klassifizierer trainiert wurde.
classifierId	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Eindeutiger Dokumentklassifizierername.
createdDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann der Dokumentklassifizierer erstellt wurde.
description	string maxLength: 4096	Beschreibung des Dokumentklassifizierers.
docTypes	<string, ClassifierDocumentTypeDetails>	Liste der Zu klassifizierenden Dokumenttypen.
expirationDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann der Dokumentklassifizierer abläuft.
modifiedDateTime	string (date-time)	Datum und Uhrzeit (UTC), wann das Dokumentmodell zuletzt geändert wurde.
warnings	DocumentIntelligenceWarning[]	Liste der Warnungen, die beim Erstellen des Klassifizierers aufgetreten sind.

DocumentIntelligenceError

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	DocumentIntelligenceError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Objekt

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	DocumentIntelligenceError	Fehlerinformationen.

DocumentIntelligenceInnerError

Objekt

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

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	DocumentIntelligenceInnerError	Innerer Fehler.
message	string	Eine lesbare Darstellung des Fehlers.

DocumentIntelligenceOperationStatus

Enumeration

Vorgangsstatus.

Wert	Beschreibung
notStarted	Der Vorgang wurde noch nicht gestartet.
running	Der Vorgang wird ausgeführt.
failed	Fehler beim Vorgang.
succeeded	Der Vorgang ist erfolgreich.
canceled	Der Vorgang wurde abgebrochen.
skipped	Der Vorgang wurde übersprungen.

DocumentIntelligenceWarning

Objekt

Das Fehlerobjekt.

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

OperationKind

Enumeration

Typ des Vorgangs.

Wert	Beschreibung
documentModelBuild	Erstellen Sie ein neues benutzerdefiniertes Dokumentmodell.
documentModelCompose	Verfassen Sie ein neues benutzerdefiniertes Dokumentmodell aus vorhandenen Modellen.
documentModelCopyTo	Kopieren Sie ein vorhandenes Dokumentmodell in potenziell eine andere Ressource, Region oder ein anderes Abonnement.
documentClassifierCopyTo	Kopieren Sie einen vorhandenen Dokumentklassifizierer in potenziell eine andere Ressource, Region oder ein anderes Abonnement.
documentClassifierBuild	Erstellen Sie ein neues benutzerdefiniertes Klassifizierermodell.