Miscellaneous - Get Operation

Service:

Azure AI Services

API Version:

2023-07-31

Ruft Informationen zu einem Vorgang ab.

GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string url	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus2.api.cognitive.microsoft.com
operationId	path	True	string uuid	Eindeutige Vorgangs-ID. Regex pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
api-version	query	True	string	Angeforderte API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Antworten

Name	Typ	Beschreibung
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	OK.
Other Status Codes	ErrorResponse	Fehler.

Sicherheit

Ocp-Apim-Subscription-Key

Der geheime Schlüssel für Ihr Azure Cognitive Services-Abonnement.

Type: apiKey
In: header

Beispiele

Get Operation

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Sample Response

Status code:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

Definitionen

Name	Beschreibung
AzureBlobContentSource	Azure Blob Storage Inhalt.
AzureBlobFileListContentSource	Dateiliste in Azure Blob Storage.
ClassifierDocumentTypeDetails	Dokumenttypinformationen zum Klassifizierer.
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	Fehlerinformationen.
ErrorResponse	Fehlerantwortobjekt.
InnerError	Detaillierter Fehler.
OperationStatus	Vorgangsstatus

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 im Container, die eine Teilmenge der Dokumente für das Training 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.

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
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.
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.

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 eine 64-Bit-Ganzzahl mit Vorzeichen.
number	string	Gleitkommazahl, normalisiert zu Gleitkomma mit doppelter Genauigkeit.
object	string	Benannte Liste von Unterfeldern mit potenziell unterschiedlichen Typen.
phoneNumber	string	Telefonnummer, normalisiert im Format E.164 (+{CountryCode}{SubscriberNumber}).
selectionMark	string	Ist das Feld ausgewählt?
signature	string	Ist die Signatur vorhanden?
string	string	Nur-Text.
time	string	Zeit, normalisiert im FORMAT ISO 8601 (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
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
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
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.
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.

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

Fehlerinformationen.

Name	Typ	Beschreibung
code	string	Fehlercode
details	Error[]	Liste der detaillierten Fehler.
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.
target	string	Ziel des Fehlers.

ErrorResponse

Fehlerantwortobjekt.

Name	Typ	Beschreibung
error	Error	Fehlerinformationen.

InnerError

Detaillierter Fehler.

Name	Typ	Beschreibung
code	string	Fehlercode
innererror	InnerError	Detaillierter Fehler.
message	string	Fehlermeldung.

OperationStatus

Vorgangsstatus

Name	Typ	Beschreibung
canceled	string	Der Vorgang wurde abgebrochen.
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.