Udostępnij za pośrednictwem


Miscellaneous Operations - Get Document Classifier Build Operation

Pobiera informacje o operacji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string

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

Nieprzezroczysty, unikatowy globalnie, wygenerowany przez klienta identyfikator ciągu 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

ErrorResponse

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

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AzureBlobContentSource

Azure Blob Storage zawartości.

AzureBlobFileListContentSource

Lista plików w Azure Blob Storage.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

ContentSourceKind

Typ źródła zawartości.

DocumentClassifierBuildOperationDetails

Pobierz obiekt odpowiedzi Operacji.

DocumentClassifierDetails

Informacje o klasyfikatorze dokumentu.

Error

Obiekt błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

InnerError

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

OperationKind

Typ operacji.

OperationStatus

Stan operacji.

Warning

Obiekt błędu.

AzureBlobContentSource

Azure Blob Storage zawartości.

Nazwa Typ Opis
containerUrl

string

Azure Blob Storage adres URL kontenera.

prefix

string

Prefiks nazwy obiektu blob.

AzureBlobFileListContentSource

Lista plików w Azure Blob Storage.

Nazwa Typ Opis
containerUrl

string

Azure Blob Storage adres URL kontenera.

fileList

string

Ścieżka do pliku JSONL w kontenerze określającym podzestaw dokumentów.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

Nazwa Typ Opis
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage lista plików określająca dane treningowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource.

azureBlobSource

AzureBlobContentSource

Azure Blob Storage lokalizacji zawierającej 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 Azure Blob Storage.

azureBlobFileList

string

Lista plików określająca poszczególne pliki w kontenerze 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żywana do utworzenia tej operacji.

createdDateTime

string

Data i godzina (UTC) podczas tworzenia operacji.

error

Error

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

OperationStatus

Stan operacji. notStarted, running, completed, or failed

tags

object

Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

DocumentClassifierDetails

Informacje o klasyfikatorze dokumentu.

Nazwa Typ Opis
apiVersion

string

Wersja interfejsu API używana do tworzenia klasyfikatora dokumentów.

baseClassifierId

string

Base classifierId, na podstawie którego klasyfikator został wytrenowany.

classifierId

string

Unikatowa nazwa klasyfikatora dokumentu.

createdDateTime

string

Data i godzina (UTC) utworzenia klasyfikatora dokumentów.

description

string

Opis klasyfikatora dokumentu.

docTypes

<string,  ClassifierDocumentTypeDetails>

Lista typów dokumentów do klasyfikowania.

expirationDateTime

string

Data i godzina (UTC), kiedy klasyfikator dokumentu wygaśnie.

warnings

Warning[]

Lista ostrzeżeń napotkanych podczas tworzenia klasyfikatora.

Error

Obiekt błędu.

Nazwa Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

Error[]

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.

innererror

InnerError

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.

ErrorResponse

Błąd obiektu odpowiedzi.

Nazwa Typ Opis
error

Error

Informacje o błędzie.

InnerError

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

InnerError

Błąd wewnętrzny.

message

string

Czytelna dla człowieka reprezentacja błędu.

OperationKind

Typ operacji.

Nazwa Typ Opis
documentClassifierBuild

string

Utwórz nowy niestandardowy model klasyfikatora.

documentModelBuild

string

Utwórz nowy niestandardowy model dokumentu.

documentModelCompose

string

Utwórz nowy niestandardowy model dokumentów z istniejących modeli.

documentModelCopyTo

string

Skopiuj istniejący model dokumentu do potencjalnie innego zasobu, regionu lub subskrypcji.

OperationStatus

Stan operacji.

Nazwa Typ Opis
canceled

string

Operacja została anulowana.

completed

string

Operacja została ukończona.

failed

string

Operacja nie powiodła się.

notStarted

string

Operacja nie została jeszcze uruchomiona.

running

string

Operacja jest w toku.

succeeded

string

Operacja zakończyła się pomyślnie.

Warning

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.