Miscellaneous Operations - Get Operation

Service:

Azure AI Services

API Version:

2024-02-29-preview

Ruft Informationen zu einem Vorgang ab.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&api-version=2024-02-29-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Document Intelligence-Dienstendpunkt.
operationId	path	True	string	Vorgangs-ID
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	OperationDetails: DocumentClassifierBuildOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	Die Anforderung wurde erfolgreich durchgeführt. 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 Operation

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getOperation&api-version=2024-02-29-preview

Sample Response

Status code:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-02-29-preview"
  }
}

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
ClassifierDocumentTypeDetails	Dokumenttypinformationen zum Klassifizierer.
ContentSourceKind	Typ der Inhaltsquelle.
DocumentBuildMode	Erstellungsmodus für benutzerdefiniertes Dokumentmodell.
DocumentClassifierBuildOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentClassifierDetails	Dokumentklassifizierungsinformationen.
DocumentFieldSchema	Beschreibung des semantischen Feldschemas mithilfe einer JSON-Schemasyntax.
DocumentFieldType	Semantischer Datentyp des Feldwerts.
DocumentModelBuildOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentModelComposeOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentModelCopyToOperationDetails	Abrufen des Vorgangsantwortobjekts.
DocumentModelDetails	Dokumentmodellinformationen.
DocumentTypeDetails	Dokumenttypinformationen.
Error	Das Fehlerobjekt.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält.
OperationKind	Vorgangstyp.
OperationStatus	Vorgangsstatus
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, die eine Teilmenge von Dokumenten angibt.

ClassifierDocumentTypeDetails

Dokumenttypinformationen zum Klassifizierer.

Name	Typ	Beschreibung
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage Dateiliste, in der die Trainingsdaten für einen Klassifiziererdokumenttyp angegeben werden. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage Speicherort, der die Trainingsdaten für einen Klassifiziererdokumenttyp enthält. Entweder azureBlobSource oder azureBlobFileListSource muss 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	Inhalte, die über die Base64-Codierung dargestellt werden.
url	string	Inhalt an einer bestimmten URL.

DocumentBuildMode

Erstellungsmodus für benutzerdefiniertes Dokumentmodell.

Name	Typ	Beschreibung
neural	string	Unterstützen Sie Dokumente mit verschiedenen visuellen Vorlagen.
template	string	Zieldokumente mit ähnlichen visuellen Vorlagen.

DocumentClassifierBuildOperationDetails

Abrufen des Vorgangsantwortobjekts.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Vorgangs verwendet wird.
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Vorgang erstellt wurde.
error	Error	Fehler aufgetreten.
kind	string: documentClassifierBuild	Vorgangstyp.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID
percentCompleted	integer	Vorgangsfortschritt (0-100).
resourceLocation	string	URL der Ressource, auf die dieser Vorgang abzielt.
result	DocumentClassifierDetails	Vorgangsergebnis nach Erfolg.
status	OperationStatus	Vorgangsstatus notStarted, running, completed, or failed
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentClassifierDetails

Dokumentklassifizierungsinformationen.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Dokumentklassifizierers verwendet wird.
baseClassifierId	string	BasisklassifierId, auf der der Klassifizierer trainiert wurde.
classifierId	string	Eindeutiger Dokumentklassifizierungsname.
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Dokumentklassifizierungsbezeichner erstellt wurde.
description	string	Dokumentklassifiziererbeschreibung.
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.

DocumentFieldSchema

Beschreibung des semantischen Feldschemas mithilfe einer JSON-Schemasyntax.

Name	Typ	Beschreibung
description	string	Feldbeschreibung.
example	string	Beispielfeldinhalt.
items	DocumentFieldSchema	Feldtypschema jedes Arrayelements.
properties	<string,  DocumentFieldSchema>	Benannte Unterfelder des Objektfelds.
type	DocumentFieldType	Semantischer Datentyp des Feldwerts.

DocumentFieldType

Semantischer Datentyp des Feldwerts.

Name	Typ	Beschreibung
address	string	Analysierte Adresse.
array	string	Liste der Unterfelder desselben Typs.
boolean	string	Boolescher Wert, normalisiert auf true oder false.
countryRegion	string	Land/Region, normalisiert im ISO 3166-1 Alpha-3-Format (z. B. USA).
currency	string	Währungsbetrag mit optionalem Währungssymbol und Einheit.
date	string	Datum, normalisiert im FORMAT ISO 8601 (JJJJ-MM-TT).
integer	string	Ganze Zahl, normalisiert auf 64-Bit-Ganzzahl mit Vorzeichen.
number	string	Gleitkommazahl, normalisiert auf Gleitkomma mit doppelter Genauigkeit.
object	string	Benannte Liste von Unterfeldern mit potenziell unterschiedlichen Typen.
phoneNumber	string	Telefonnummer, normalisiert im Format E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Array ausgewählter Zeichenfolgenwerte.
selectionMark	string	Ist das Feld ausgewählt?
signature	string	Ist die Signatur vorhanden?
string	string	Nur-Text.
time	string	Zeit, normalisiert im ISO 8601-Format (hh:mm:ss).

DocumentModelBuildOperationDetails

Abrufen des Vorgangsantwortobjekts.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Vorgangs verwendet wird.
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Vorgang erstellt wurde.
error	Error	Fehler aufgetreten.
kind	string: documentModelBuild	Vorgangstyp.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID
percentCompleted	integer	Vorgangsfortschritt (0-100).
resourceLocation	string	URL der Ressource, auf die dieser Vorgang abzielt.
result	DocumentModelDetails	Vorgangsergebnis nach Erfolg.
status	OperationStatus	Vorgangsstatus notStarted, running, completed, or failed
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentModelComposeOperationDetails

Abrufen des Vorgangsantwortobjekts.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Vorgangs verwendet wird.
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Vorgang erstellt wurde.
error	Error	Fehler aufgetreten.
kind	string: documentModelCompose	Vorgangstyp.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID
percentCompleted	integer	Vorgangsfortschritt (0-100).
resourceLocation	string	URL der Ressource, auf die dieser Vorgang abzielt.
result	DocumentModelDetails	Vorgangsergebnis nach Erfolg.
status	OperationStatus	Vorgangsstatus notStarted, running, completed, or failed
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentModelCopyToOperationDetails

Abrufen des Vorgangsantwortobjekts.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Vorgangs verwendet wird.
createdDateTime	string	Datum und Uhrzeit (UTC), wann der Vorgang erstellt wurde.
error	Error	Fehler aufgetreten.
kind	string: documentModelCopyTo	Vorgangstyp.
lastUpdatedDateTime	string	Datum und Uhrzeit (UTC), zu dem die status zuletzt aktualisiert wurde.
operationId	string	Vorgangs-ID
percentCompleted	integer	Vorgangsfortschritt (0-100).
resourceLocation	string	URL der Ressource, auf die dieser Vorgang abzielt.
result	DocumentModelDetails	Vorgangsergebnis nach Erfolg.
status	OperationStatus	Vorgangsstatus notStarted, running, completed, or failed
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.

DocumentModelDetails

Dokumentmodellinformationen.

Name	Typ	Beschreibung
apiVersion	string	API-Version, die zum Erstellen dieses Dokumentmodells verwendet wird.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage Dateiliste, in der die Trainingsdaten angegeben werden. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage Speicherort mit den Trainingsdaten. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden.
buildMode	DocumentBuildMode	Erstellungsmodus für benutzerdefiniertes Dokumentmodell.
createdDateTime	string	Datum und Uhrzeit (UTC), wann das Dokumentmodell erstellt wurde.
description	string	Dokumentmodellbeschreibung.
docTypes	<string,  DocumentTypeDetails>	Unterstützte Dokumenttypen.
expirationDateTime	string	Datum und Uhrzeit (UTC), wann das Dokumentmodell abläuft.
modelId	string	Eindeutiger Name des Dokumentmodells.
tags	object	Liste der Schlüssel-Wert-Tagattribute, die dem Dokumentmodell zugeordnet sind.
warnings	Warning[]	Liste der Warnungen, die beim Erstellen des Modells aufgetreten sind.

DocumentTypeDetails

Dokumenttypinformationen.

Name	Typ	Beschreibung
buildMode	DocumentBuildMode	Erstellungsmodus für benutzerdefiniertes Dokumentmodell.
description	string	Dokumentmodellbeschreibung.
fieldConfidence	object	Geschätzte Zuverlässigkeit für jedes Feld.
fieldSchema	<string,  DocumentFieldSchema>	Beschreibung des semantischen Dokumentschemas unter Verwendung einer JSON-Schemasyntax.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten 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 für Menschen 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 der vom Server definierten Fehlercodes.
innererror	InnerError	Innerer Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

OperationKind

Vorgangstyp.

Name	Typ	Beschreibung
documentClassifierBuild	string	Erstellen Sie ein neues benutzerdefiniertes Klassifizierermodell.
documentModelBuild	string	Erstellen Sie ein neues benutzerdefiniertes Dokumentmodell.
documentModelCompose	string	Erstellen Sie aus vorhandenen Modellen ein neues benutzerdefiniertes Dokumentmodell.
documentModelCopyTo	string	Kopieren Sie ein vorhandenes Dokumentmodell in eine andere Ressource, Region oder ein anderes Abonnement.

OperationStatus

Vorgangsstatus

Name	Typ	Beschreibung
canceled	string	Der Vorgang wurde abgebrochen.
completed	string	Der Vorgang wurde abgeschlossen.
failed	string	Beim Vorgang ist ein Fehler aufgetreten.
notStarted	string	Der Vorgang wurde noch nicht gestartet.
running	string	Der Vorgang wird ausgeführt.
succeeded	string	Der Vorgang war erfolgreich.

Warning

Das Fehlerobjekt.

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