Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Tworzy niestandardowy model analizy dokumentów.

POST {endpoint}/documentintelligence/documentModels:build?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.
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 dokumentów.
modelId	True	string	Unikatowa nazwa 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.
description		string	Opis modelu dokumentu.
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. Headers Operation-Location: string Retry-After: integer
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

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-02-29-preview

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

Sample Response

Status code:

202

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

Definicje

Nazwa	Opis
AzureBlobContentSource	Azure Blob Storage zawartości.
AzureBlobFileListContentSource	Lista plików w Azure Blob Storage.
BuildDocumentModelRequest	Zażądaj treści w celu utworzenia nowego niestandardowego modelu dokumentów.
DocumentBuildMode	Niestandardowy tryb kompilacji modelu dokumentów.
Error	Obiekt błędu.
ErrorResponse	Błąd obiektu odpowiedzi.
InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.

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.

BuildDocumentModelRequest

Zażądaj treści w celu utworzenia nowego niestandardowego modelu dokumentów.

Nazwa	Typ	Opis
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.
description	string	Opis modelu dokumentu.
modelId	string	Unikatowa nazwa modelu dokumentu.
tags	object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

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.

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.