Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
buildMode	True	DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
modelId	True	string	Egyedi dokumentummodell neve.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage betanítási adatokat tartalmazó fájllista. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
description		string	A 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ést elfogadták feldolgozásra, de a feldolgozás még nem fejeződött be. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

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éldák

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

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage tartalmat.
AzureBlobFileListContentSource	Fájllista Azure Blob Storage.
BuildDocumentModelRequest	Törzs kérése új egyéni dokumentummodell létrehozásához.
DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

AzureBlobContentSource

Azure Blob Storage tartalmat.

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

AzureBlobFileListContentSource

Fájllista 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 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 tartalmazó fájllista. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
buildMode	DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
description	string	A 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 összeállítási módja.

Name	Típus	Description
neural	string	Különböző vizualizációs sablonokat tartalmazó dokumentumok támogatása.
template	string	Céldokumentumok hasonló vizualizációs sablonokkal.

Error

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibaadatok.

InnerError

Egy objektum, amely pontosabb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	InnerError	Belső hiba.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.