Document Models - Build Model

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Tworzy niestandardowy model analizy dokumentów.

POST {endpoint}/documentintelligence/documentModels:build?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.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
buildMode	True	DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
modelId	True	string	Unikatowa nazwa modelu dokumentu.
allowOverwrite		boolean	Zezwalaj na zastępowanie istniejącego modelu o tej samej nazwie.
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.
description		string	Opis modelu dokumentu.
maxTrainingHours		number	Maksymalna liczba godzin procesorów GPU równoważnych w wersji 100 do użycia na potrzeby trenowania modelu. Default=0.5.
tags		object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Nagłówki Operation-Location: string Retry-After: integer
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

Build Document Model

Przykładowe żądanie

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-11-30

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
AzureBlobContentSource	Zawartość usługi Azure Blob Storage.
AzureBlobFileListContentSource	Lista plików w usłudze Azure Blob Storage.
BuildDocumentModelRequest	Treść żądania utworzenia nowego niestandardowego modelu dokumentów.
DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentu.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.

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.

BuildDocumentModelRequest

Treść żądania utworzenia nowego niestandardowego modelu dokumentów.

Nazwa	Typ	Domyślna wartość	Opis
allowOverwrite	boolean	False	Zezwalaj na zastępowanie istniejącego modelu o tej samej nazwie.
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.
description	string		Opis modelu dokumentu.
maxTrainingHours	number	0.5	Maksymalna liczba godzin procesorów GPU równoważnych w wersji 100 do użycia na potrzeby trenowania modelu. Default=0.5.
modelId	string		Unikatowa nazwa modelu dokumentu.
tags	object		Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

DocumentBuildMode

Niestandardowy tryb kompilacji modelu dokumentu.

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

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.