Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

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

POST {endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Tajný klíč vašeho předplatného služeb Azure Cognitive Services.

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 azureBlobSource nebo azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage umístění obsahující trénovací data. Je nutné zadat 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		Požadavek je úspěšně zařazen do fronty. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč vašeho předplatného služeb Azure Cognitive Services.

Type: apiKey
In: header

Příklady

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31

{
  "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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

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	Informace o chybě.
ErrorResponse	Objekt odpovědi na chybu.
InnerError	Podrobná chyba.

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ů pro trénování

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 azureBlobSource nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage umístění 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
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	Podpořte dokumenty s různými vizuálními šablonami.
template	string	Zaměřte se na dokumenty s podobnými vizuálními šablonami.

Error

Informace o chybě.

Name	Typ	Description
code	string	Kód chyby
details	Error[]	Seznam podrobných chyb
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu.

Name	Typ	Description
error	Error	Informace o chybě.

InnerError

Podrobná chyba.

Name	Typ	Description
code	string	Kód chyby
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.