Document Models - Build Model

Szolgáltatás:

Azure AI Services

API-verzió:

2022-08-31

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

POST {endpoint}/formrecognizer/documentModels:build?api-version=2022-08-31

URI-paraméterek

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

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

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.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet.
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. Fejlécek Operation-Location: string
Other Status Codes	ErrorResponse	Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

Példák

BuildDocumentModel

Mintakérelem

HTTP

POST {endpoint}/formrecognizer/documentModels:build?api-version=2022-08-31

{
  "modelId": "{modelId}",
  "description": "{modelDescription}",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "{blobNamePrefix}"
  },
  "tags": {
    "createdBy": "{userId}"
  }
}

Mintaválasz

Állapotkód:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

Definíciók

Name	Description
ApiVersion	API-verzió.
AzureBlobContentSource	Azure Blob Storage tartalmat.
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.

ApiVersion

API-verzió.

Name	Típus	Description
2022-08-31	string

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.

BuildDocumentModelRequest

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

Name	Típus	Description
azureBlobSource	AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet.
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
template	string

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.