Miscellaneous Operations - Get Operation

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-07-31-preview

Pobiera informacje o operacji.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&api-version=2024-07-31-preview

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	OperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	Żą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

Przykładowe żądanie

HTTP

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

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": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-07-31-preview"
  }
}

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.
DocumentAnalysisFeature	Funkcje analizy dokumentów do włączenia.
DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
DocumentClassifierBuildOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentClassifierCopyToOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentClassifierDetails	Informacje klasyfikatora dokumentów.
DocumentFieldSchema	Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON.
DocumentFieldType	Semantyczny typ danych wartości pola.
DocumentModelBuildOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentModelComposeOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentModelCopyToOperationDetails	Pobierz obiekt odpowiedzi Operacji.
DocumentModelDetails	Informacje o modelu dokumentu.
DocumentTypeDetails	Informacje o typie 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.
SplitMode	Zachowanie dzielenia plików.
Warning	Obiekt błędu.

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.

DocumentAnalysisFeature

Funkcje analizy dokumentów do włączenia.

Nazwa	Typ	Opis
barcodes	string	Włącz wykrywanie kodów kreskowych w dokumencie.
formulas	string	Włącz wykrywanie wyrażeń matematycznych w dokumencie.
keyValuePairs	string	Włącz wykrywanie ogólnych par wartości klucza (pól formularza) w dokumencie.
languages	string	Włącz wykrywanie języka zawartości tekstowej.
ocrHighResolution	string	Wykonaj funkcję OCR w wyższej rozdzielczości, aby obsługiwać dokumenty z precyzyjnym drukowaniem.
queryFields	string	Włącz wyodrębnianie dodatkowych pól za pomocą parametru zapytania QueryFields.
styleFont	string	Włącz rozpoznawanie różnych stylów czcionek.

DocumentBuildMode

Niestandardowy tryb kompilacji modelu dokumentu.

Nazwa	Typ	Opis
generative	string	Włącz dokumenty wszystkich typów przy użyciu technik generowania sztucznej inteligencji.
neural	string	Obsługa dokumentów z różnymi szablonami wizualnymi.
template	string	Dokumenty docelowe z podobnymi szablonami wizualizacji.

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

DocumentClassifierCopyToOperationDetails

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	Error	Napotkano błąd.
kind	string: documentClassifierCopyTo	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 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.
warnings	Warning[]	Lista ostrzeżeń napotkanych podczas tworzenia klasyfikatora.

DocumentFieldSchema

Opis schematu semantycznego pola przy użyciu składni stylu schematu JSON.

Nazwa	Typ	Opis
description	string	Opis pola.
example	string	Przykładowa zawartość pola.
items	DocumentFieldSchema	Schemat typu pola każdego elementu tablicy.
properties	<string,  DocumentFieldSchema>	Nazwane pola podrzędne pola obiektu.
type	DocumentFieldType	Semantyczny typ danych wartości pola.

DocumentFieldType

Semantyczny typ danych wartości pola.

Nazwa	Typ	Opis
address	string	Przeanalizowany adres.
array	string	Lista pól podrzędnych tego samego typu.
boolean	string	Wartość logiczna, znormalizowana do wartości true lub false.
countryRegion	string	Kraj/region, znormalizowany do formatu ISO 3166-1 alfa-3 (np. USA).
currency	string	Kwota waluty z opcjonalnym symbolem waluty i jednostką.
date	string	Data, znormalizowana do formatu ISO 8601 (RRRR-MM-DD).
integer	string	Liczba całkowita, znormalizowana do 64-bitowej liczby całkowitej ze znakiem.
number	string	Liczba zmiennoprzecinkowa znormalizowana do podwójnej precyzji zmiennoprzecinkowa.
object	string	Nazwana lista pól podrzędnych potencjalnie różnych typów.
phoneNumber	string	Numer telefonu, znormalizowany do formatu E.164 (+{CountryCode}{Numer subskrybenta}).
selectionGroup	string	Tablica wybranych wartości ciągów.
selectionMark	string	Czy pole jest zaznaczone?
signature	string	Czy podpis jest obecny?
string	string	Zwykły tekst.
time	string	Czas znormalizowany do formatu ISO 8601 (hh:mm:ss).

DocumentModelBuildOperationDetails

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	Error	Napotkano błąd.
kind	string: documentModelBuild	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	DocumentModelDetails	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.

DocumentModelComposeOperationDetails

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	Error	Napotkano błąd.
kind	string: documentModelCompose	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	DocumentModelDetails	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.

DocumentModelCopyToOperationDetails

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	Error	Napotkano błąd.
kind	string: documentModelCopyTo	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	DocumentModelDetails	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.

DocumentModelDetails

Informacje o modelu dokumentu.

Nazwa	Typ	Domyślna wartość	Opis
apiVersion	string		Wersja interfejsu API używana do tworzenia tego modelu dokumentów.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista plików usługi Azure Blob Storage określająca dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Lokalizacja usługi Azure Blob Storage zawierająca dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource.
buildMode	DocumentBuildMode		Niestandardowy tryb kompilacji modelu dokumentu.
classifierId	string		W przypadku modeli skomponowanych klasyfikator niestandardowy do dzielenia i klasyfikowania pliku wejściowego.
createdDateTime	string		Data i godzina (UTC) utworzenia modelu dokumentu.
description	string		Opis modelu dokumentu.
docTypes	<string,  DocumentTypeDetails>		Obsługiwane typy dokumentów.
expirationDateTime	string		Data i godzina (UTC), kiedy model dokumentu wygaśnie.
modelId	string		Unikatowa nazwa modelu dokumentu.
split	SplitMode	none	W przypadku modeli skomponowanych zachowanie dzielenia plików.
tags	object		Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.
trainingHours	number		Liczba godzin procesorów GPU równoważnych w wersji 100 używanych na potrzeby trenowania modelu.
warnings	Warning[]		Lista ostrzeżeń napotkanych podczas tworzenia modelu.

DocumentTypeDetails

Informacje o typie dokumentu.

Nazwa	Typ	Opis
buildMode	DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
confidenceThreshold	number	Wykonaj analizę tylko wtedy, gdy pewność dokumentu przekracza próg.
description	string	Opis modelu dokumentu.
features	DocumentAnalysisFeature[]	Lista opcjonalnych funkcji analizy.
fieldConfidence	object	Szacowana pewność dla każdego pola.
fieldSchema	<string,  DocumentFieldSchema>	Opis schematu semantycznego dokumentu przy użyciu składni stylu schematu JSON.
maxDocumentsToAnalyze	integer	Maksymalna liczba dokumentów określonego typu do przeanalizowania. Default=all.
modelId	string	Model dokumentów używany do analizowania dokumentów o określonym typie.
queryFields	string[]	Lista dodatkowych pól do wyodrębnienia. Ex. "NumberOfGuests,StoreNumber"

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

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.

SplitMode

Zachowanie dzielenia plików.

Nazwa	Typ	Opis
auto	string	Automatycznie podziel plik na dokumenty.
none	string	Traktuj cały plik jako pojedynczy dokument.
perPage	string	Traktuj każdą stronę w pliku jako oddzielny dokument.

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.