Document Models - Build Model

Služba:

Azure AI Services

Verze rozhraní API:

2024-07-31-preview

Vytvoří vlastní model analýzy dokumentů.

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-07-31-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Koncový bod služby Document Intelligence
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Vyžadováno	Typ	Description
buildMode	True	DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
modelId	True	string	Jedinečný název modelu dokumentu
allowOverwrite		boolean	Povolte přepsání existujícího modelu se stejným názvem.
azureBlobFileListSource		AzureBlobFileListContentSource	Seznam souborů Azure Blob Storage určující trénovací data Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Umístění služby Azure Blob Storage obsahující trénovací data Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
description		string	Popis modelu dokumentu
maxTrainingHours		number	Maximální počet hodin GPU ekvivalentních V100, které se mají použít pro trénování modelu. Default=0,5.
tags		object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Build Document Model

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
AzureBlobContentSource	Obsah služby Azure Blob Storage
AzureBlobFileListContentSource	Seznam souborů ve službě Azure Blob Storage
BuildDocumentModelRequest	Text požadavku pro vytvoření nového vlastního modelu dokumentu
DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
Error	Objekt chyby.
ErrorResponse	Objekt odpovědi na chybu
InnerError	Objekt obsahující konkrétnější informace o chybě.

AzureBlobContentSource

Obsah služby Azure Blob Storage

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru služby Azure Blob Storage
prefix	string	Předpona názvu objektu blob

AzureBlobFileListContentSource

Seznam souborů ve službě Azure Blob Storage

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru služby Azure Blob Storage
fileList	string	Cesta k souboru JSONL v kontejneru určujícím podmnožinu dokumentů

BuildDocumentModelRequest

Text požadavku pro vytvoření nového vlastního modelu dokumentu

Name	Typ	Default value	Description
allowOverwrite	boolean	False	Povolte přepsání existujícího modelu se stejným názvem.
azureBlobFileListSource	AzureBlobFileListContentSource		Seznam souborů Azure Blob Storage určující trénovací data Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Umístění služby Azure Blob Storage obsahující trénovací data Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
buildMode	DocumentBuildMode		Režim sestavení vlastního modelu dokumentu
description	string		Popis modelu dokumentu
maxTrainingHours	number	0.5	Maximální počet hodin GPU ekvivalentních V100, které se mají použít pro trénování modelu. Default=0,5.
modelId	string		Jedinečný název modelu dokumentu
tags	object		Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

DocumentBuildMode

Režim sestavení vlastního modelu dokumentu

Name	Typ	Description
generative	string	Povolte dokumenty všech typů pomocí technik generující umělé inteligence.
neural	string	Podpora dokumentů s různými vizuálními šablonami
template	string	Cílové dokumenty s podobnými šablonami vizuálů

Error

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu

Name	Typ	Description
error	Error	Informace o chybě

InnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	InnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.