Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	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.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage seznam souborů určující trénovací data. Je nutné zadat buď azureBlobSource, nebo azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage umístění obsahující trénovací data. Je nutné zadat buď azureBlobSource, nebo azureBlobFileListSource.
description		string	Popis modelu dokumentu
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. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď.

Zabezpečení

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

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

Příklady

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

Definice

Name	Description
AzureBlobContentSource	Azure Blob Storage obsah.
AzureBlobFileListContentSource	Seznam souborů v Azure Blob Storage.
BuildDocumentModelRequest	Text žádosti o 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

Azure Blob Storage obsah.

Name	Typ	Description
containerUrl	string	Azure Blob Storage adresu URL kontejneru.
prefix	string	Předpona názvu objektu blob.

AzureBlobFileListContentSource

Seznam souborů v Azure Blob Storage.

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

BuildDocumentModelRequest

Text žádosti o vytvoření nového vlastního modelu dokumentu

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage seznam souborů určující trénovací data. Je nutné zadat buď azureBlobSource, nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage umístění obsahující trénovací data. Je nutné zadat buď azureBlobSource, nebo azureBlobFileListSource.
buildMode	DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
description	string	Popis modelu dokumentu
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
neural	string	Podpora dokumentů s různými vizuálními šablonami
template	string	Zacílit dokumenty s podobnými vizuálními šablonami.

Error

Objekt chyby.

Name	Typ	Description
code	string	Jeden ze serverem definované sady 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 o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
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	Jeden ze serverem definované sady kódů chyb.
innererror	InnerError	Vnitřní chyba.
message	string	Lidsky čitelná reprezentace chyby.