Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

Egyéni dokumentumelemzési modellt hoz létre.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string url	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Kért API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string	Az Azure Cognitive Services-előfizetés titkos kulcsa.

Kérelem törzse

Name	Kötelező	Típus	Description
buildMode	True	DocumentBuildMode	Egyéni dokumentummodell buildelési módja.
modelId	True	string	Egyedi dokumentummodell neve.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage betanítási adatokat megadva fájllistát. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
description		string	Dokumentummodell leírása.
tags		object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

Válaszok

Name	Típus	Description
202 Accepted		A kérés sikeresen várólistára van helyezve. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Az Azure Cognitive Services-előfizetés titkos kulcsa.

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage tartalmat.
AzureBlobFileListContentSource	Fájllista a Azure Blob Storage.
BuildDocumentModelRequest	Törzs kérése új egyéni dokumentummodell létrehozásához.
DocumentBuildMode	Egyéni dokumentummodell buildelési módja.
Error	Hibainformáció.
ErrorResponse	Hibaválasz-objektum.
InnerError	Részletes hiba.

AzureBlobContentSource

Azure Blob Storage tartalmat.

Name	Típus	Description
containerUrl	string	Azure Blob Storage tároló URL-címe.
prefix	string	Blobnév előtag.

AzureBlobFileListContentSource

Fájllista a Azure Blob Storage.

Name	Típus	Description
containerUrl	string	Azure Blob Storage tároló URL-címe.
fileList	string	Egy JSONL-fájl elérési útja a tárolóban, amely a betanításhoz szükséges dokumentumok egy részhalmazát adja meg.

BuildDocumentModelRequest

Törzs kérése új egyéni dokumentummodell létrehozásához.

Name	Típus	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage betanítási adatokat megadva fájllistát. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
buildMode	DocumentBuildMode	Egyéni dokumentummodell buildelési módja.
description	string	Dokumentummodell leírása.
modelId	string	Egyedi dokumentummodell neve.
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

DocumentBuildMode

Egyéni dokumentummodell buildelési módja.

Name	Típus	Description
neural	string	Különböző vizualizációs sablonokkal rendelkező dokumentumok támogatása.
template	string	Hasonló vizualizációs sablonokkal rendelkező dokumentumok céldokumentumai.

Error

Hibainformáció.

Name	Típus	Description
code	string	Hibakód.
details	Error[]	Részletes hibák listája.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibainformáció.

InnerError

Részletes hiba.

Name	Típus	Description
code	string	Hibakód.
innererror	InnerError	Részletes hiba.
message	string	Hibaüzenet.