Miscellaneous Operations - Get Document Classifier Build Operation

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Pobiera informacje o operacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy usługi Analizy dokumentów.
operationId	path	True	string	Identyfikator operacji
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string uuid	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DocumentClassifierBuildOperationDetails	Żądanie zakończyło się pomyślnie. Nagłówki x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Operation - Document Classifier Build

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "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-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"
        }
      }
    }
  }
}

Definicje

Nazwa	Opis
AzureBlobContentSource	Zawartość usługi Azure Blob Storage.
AzureBlobFileListContentSource	Lista plików w usłudze Azure Blob Storage.
ClassifierDocumentTypeDetails	Informacje o typie dokumentu klasyfikatora.
ContentSourceKind	Typ źródła zawartości.
DocumentClassifierBuildOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentClassifierDetails	Informacje klasyfikatora dokumentów.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
DocumentIntelligenceOperationStatus	Stan operacji.
DocumentIntelligenceWarning	Obiekt błędu.
OperationKind	Typ operacji.

AzureBlobContentSource

Zawartość usługi Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string	Adres URL kontenera usługi Azure Blob Storage.
prefix	string	Prefiks nazwy obiektu blob.

AzureBlobFileListContentSource

Lista plików w usłudze Azure Blob Storage.

Nazwa	Typ	Opis
containerUrl	string	Adres URL kontenera usługi Azure Blob Storage.
fileList	string	Ścieżka do pliku JSONL w kontenerze określającym podzbiór dokumentów.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

Nazwa	Typ	Opis
azureBlobFileListSource	AzureBlobFileListContentSource	Lista plików usługi Azure Blob Storage określająca dane szkoleniowe dla klasyfikatora typu dokumentu. Należy określić element azureBlobSource lub azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Lokalizacja usługi Azure Blob Storage zawierająca dane szkoleniowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource.
sourceKind	ContentSourceKind	Typ źródła danych trenowania.

ContentSourceKind

Typ źródła zawartości.

Nazwa	Typ	Opis
azureBlob	string	Pliki w ścieżce w kontenerze usługi Azure Blob Storage.
azureBlobFileList	string	Lista plików określająca poszczególne pliki w kontenerze usługi Azure Blob Storage.
base64	string	Zawartość reprezentowana za pomocą kodowania Base64.
url	string	Zawartość pod określonym adresem URL.

DocumentClassifierBuildOperationDetails

Pobierz obiekt odpowiedzi Operacji.

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API użyta do utworzenia tej operacji.
createdDateTime	string	Data i godzina (UTC) utworzenia operacji.
error	DocumentIntelligenceError	Napotkano błąd.
kind	string: documentClassifierBuild	Typ operacji.
lastUpdatedDateTime	string	Data i godzina (UTC), kiedy stan został ostatnio zaktualizowany.
operationId	string	Identyfikator operacji
percentCompleted	integer	Postęp operacji (0–100).
resourceLocation	string	Adres URL zasobu objętego tą operacją.
result	DocumentClassifierDetails	Wynik operacji po powodzeniu.
status	DocumentIntelligenceOperationStatus	Stan operacji. notStarted, running, completed, or failed
tags	object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

DocumentClassifierDetails

Informacje klasyfikatora dokumentów.

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API użyta do utworzenia tego klasyfikatora dokumentów.
baseClassifierId	string	Identyfikator klasyfikatora podstawowego, na podstawie którego został wytrenowany klasyfikator.
classifierId	string	Unikatowa nazwa klasyfikatora dokumentów.
createdDateTime	string	Data i godzina (UTC) utworzenia klasyfikatora dokumentów.
description	string	Opis klasyfikatora dokumentów.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista typów dokumentów do klasyfikowania.
expirationDateTime	string	Data i godzina (UTC), kiedy klasyfikator dokumentu wygaśnie.
modifiedDateTime	string	Data i godzina (UTC) ostatniej modyfikacji modelu dokumentu.
warnings	DocumentIntelligenceWarning[]	Lista ostrzeżeń napotkanych podczas tworzenia klasyfikatora.

DocumentIntelligenceError

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	DocumentIntelligenceError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

DocumentIntelligenceErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Informacje o błędzie.

DocumentIntelligenceInnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	DocumentIntelligenceInnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

DocumentIntelligenceOperationStatus

Stan operacji.

Nazwa	Typ	Opis
canceled	string	Operacja została anulowana.
failed	string	Operacja nie powiodła się.
notStarted	string	Operacja nie została jeszcze uruchomiona.
running	string	Operacja jest w toku.
skipped	string	Operacja została pominięta.
succeeded	string	Operacja zakończyła się pomyślnie.

DocumentIntelligenceWarning

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów ostrzegawczych.
message	string	Czytelna dla człowieka reprezentacja ostrzeżenia.
target	string	Element docelowy błędu.

OperationKind

Typ operacji.

Nazwa	Typ	Opis
documentClassifierBuild	string	Utwórz nowy niestandardowy model klasyfikatora.
documentClassifierCopyTo	string	Skopiuj istniejący klasyfikator dokumentów do potencjalnie innego zasobu, regionu lub subskrypcji.
documentModelBuild	string	Utwórz nowy niestandardowy model dokumentów.
documentModelCompose	string	Utwórz nowy niestandardowy model dokumentów na podstawie istniejących modeli.
documentModelCopyTo	string	Skopiuj istniejący model dokumentów do potencjalnie innego zasobu, regionu lub subskrypcji.