Analyzers - Get Operation Status

Dienst:

Azure AI Services

API-Version:

2024-12-01-preview

Rufen Sie den Status eines Analyseerstellungsvorgangs ab.

GET {endpoint}/contentunderstanding/analyzers/{analyzerId}/operations/{operationId}?api-version=2024-12-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
analyzerId	path	True	string	Der eindeutige Bezeichner des Analyzers. RegEx-Muster: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Inhaltsverständnis-Dienstendpunkt.
operationId	path	True	string	Die eindeutige ID des Vorgangs.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK		Die Anforderung ist erfolgreich.
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 Analyzer Operation Status

Beispielanforderung

HTTP

GET {endpoint}/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "Succeeded",
  "result": {
    "analyzerId": "myAnalyzer",
    "description": "My custom analyzer",
    "tags": {
      "createdBy": "John"
    },
    "status": "creating",
    "createdAt": "2024-10-14T18:46:36.051Z",
    "lastModifiedAt": "2024-10-14T18:46:36.051Z",
    "baseAnalyzerId": "prebuilt-document",
    "config": {
      "locales": null,
      "enableFace": false,
      "enableOcr": true,
      "enableLayout": true,
      "enableBarcode": true,
      "enableFormula": false,
      "returnDetails": true
    },
    "fieldSchema": {
      "name": "MyForm",
      "description": "My custom form",
      "fields": {
        "Company": {
          "type": "string",
          "description": "Name of company."
        }
      },
      "definitions": {}
    },
    "trainingData": {
      "kind": "blob",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  }
}

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/Guidelines.md#7102-error-condition-responses.

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 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/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.