Miscellaneous Operations - Get Document Classifier Build Operation
Ruft Informationen zu einem Vorgang ab.
GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierBuildOperation&api-version=2024-02-29-preview
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string |
Der Document Intelligence-Dienstendpunkt. |
operation
|
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 |
Die Anforderung wurde erfolgreich durchgeführt. Headers x-ms-client-request-id: string |
|
Other Status Codes |
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 - Document Classifier Build
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierBuildOperation&api-version=2024-02-29-preview
Sample Response
{
"operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
"status": "succeeded",
"percentCompleted": 100,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:13:01Z",
"kind": "documentClassifierBuild",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier",
"result": {
"classifierId": "myClassifier",
"description": "Classifier description",
"createdDateTime": "2022-07-30T00:00:00Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2024-02-29-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 |
---|---|
Azure |
Azure Blob Storage Inhalt. |
Azure |
Dateiliste in Azure Blob Storage. |
Classifier |
Dokumenttypinformationen zum Klassifizierer. |
Content |
Typ der Inhaltsquelle. |
Document |
Abrufen des Vorgangsantwortobjekts. |
Document |
Dokumentklassifizierungsinformationen. |
Error |
Das Fehlerobjekt. |
Error |
Fehlerantwortobjekt. |
Inner |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. |
Operation |
Vorgangstyp. |
Operation |
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 |
Azure Blob Storage Dateiliste, in der die Trainingsdaten für einen Klassifiziererdokumenttyp angegeben werden. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden. |
|
azureBlobSource |
Azure Blob Storage Speicherort, der die Trainingsdaten für einen Klassifiziererdokumenttyp enthält. Entweder azureBlobSource oder azureBlobFileListSource muss angegeben werden. |
|
sourceKind |
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. |
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 |
Fehler aufgetreten. |
|
kind |
string:
document |
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 |
Vorgangsergebnis nach Erfolg. |
|
status |
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,
Classifier |
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 |
Einer der vom Server definierten Fehlercodes. |
details |
Error[] |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
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 |
Fehlerinformationen. |
InnerError
Ein Objekt, das spezifischere Informationen zum Fehler enthält.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Einer der vom Server definierten Fehlercodes. |
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. |