Document Models - Build Model

Szolgáltatás:

Azure AI Services

API-verzió:

2024-07-31-preview

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

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string uri	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string	A művelethez használni kívánt 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.
allowOverwrite		boolean	Meglévő modell felülírásának engedélyezése ugyanazzal a névvel.
azureBlobFileListSource		AzureBlobFileListContentSource	A betanítási adatokat meghatározó Azure Blob Storage-fájllista. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
azureBlobSource		AzureBlobContentSource	A betanítási adatokat tartalmazó Azure Blob Storage-hely. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
description		string	A dokumentummodell leírása.
maxTrainingHours		number	A modell betanításához használandó V100-egyenértékű GPU-órák maximális száma. Default=0.5.
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érelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be. Fejlécek Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

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

Példák

Build Document Model

Mintakérelem

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-07-31-preview

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Mintaválasz

Állapotkód:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage-tartalom.
AzureBlobFileListContentSource	Fájllista az Azure Blob Storage-ban.
BuildDocumentModelRequest	Kérje meg a törzset, hogy hozzon létre egy új egyéni dokumentummodellt.
DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról.

AzureBlobContentSource

Azure Blob Storage-tartalom.

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

AzureBlobFileListContentSource

Fájllista az Azure Blob Storage-ban.

Name	Típus	Description
containerUrl	string	Az 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

Kérje meg a törzset, hogy hozzon létre egy új egyéni dokumentummodellt.

Name	Típus	Alapértelmezett érték	Description
allowOverwrite	boolean	False	Meglévő modell felülírásának engedélyezése ugyanazzal a névvel.
azureBlobFileListSource	AzureBlobFileListContentSource		A betanítási adatokat meghatározó Azure Blob Storage-fájllista. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
azureBlobSource	AzureBlobContentSource		A betanítási adatokat tartalmazó Azure Blob Storage-hely. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
buildMode	DocumentBuildMode		Egyéni dokumentummodell összeállítási módja.
description	string		A dokumentummodell leírása.
maxTrainingHours	number	0.5	A modell betanításához használandó V100-egyenértékű GPU-órák maximális száma. Default=0.5.
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
generative	string	Minden típusú dokumentum engedélyezése generatív AI-technikákkal.
neural	string	Különböző vizualizációs sablonokkal rendelkező 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 ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

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

InnerError

Egy objektum, amely részletesebb 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 ember által olvasható ábrázolása.