Miscellaneous Operations - Get Document Model Build Operation

Service:

Azure AI Services

API Version:

2024-02-29-preview

Pobiera informacje o operacji.

GET {endpoint}/documentintelligence/operations/{operationId}?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	DocumentModelBuildOperationDetails	Żądanie zakończyło się pomyślnie. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

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

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

Przykłady

Get Operation - Document Model Build

Sample Request

HTTP

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

Sample Response

Status code:

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-02-29-preview"
  }
}

Definicje

Nazwa	Opis
AzureBlobContentSource	Azure Blob Storage zawartości.
AzureBlobFileListContentSource	Lista plików w Azure Blob Storage.
DocumentBuildMode	Niestandardowy tryb kompilacji modelu 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.
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.
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.

DocumentBuildMode

Niestandardowy tryb kompilacji modelu dokumentów.

Nazwa	Typ	Opis
neural	string	Obsługa dokumentów z różnymi szablonami wizualnymi.
template	string	Dokumenty docelowe z podobnymi szablonami wizualnymi.

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 podpole 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 z podpisem.
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}{SubscriberNumber}).
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żywana do utworzenia tej operacji.
createdDateTime	string	Data i godzina (UTC) podczas tworzenia 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.

DocumentModelDetails

Informacje o modelu dokumentu.

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API używana do tworzenia tego modelu dokumentu.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage lista plików określająca dane treningowe. Należy określić element azureBlobSource lub azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage lokalizacji zawierającej dane szkoleniowe. Należy określić element azureBlobSource lub azureBlobFileListSource.
buildMode	DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentów.
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.
tags	object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.
warnings	Warning[]	Lista ostrzeżeń napotkanych podczas tworzenia modelu.

DocumentTypeDetails

Informacje o typie dokumentu.

Nazwa	Typ	Opis
buildMode	DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentów.
description	string	Opis modelu dokumentu.
fieldConfidence	object	Szacowana pewność dla każdego pola.
fieldSchema	<string,  DocumentFieldSchema>	Opis schematu semantycznego dokumentu przy użyciu składni stylu schematu JSON.

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.