Document Models - Build Model

Servizio:: Azure AI Services

Versione API:: 2024-11-30

Compila un modello di analisi dei documenti personalizzato.

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-11-30

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Endpoint del servizio Document Intelligence.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
buildMode	True	DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Nome univoco del modello di documento.
allowOverwrite		boolean	Consentire la sovrascrittura di un modello esistente con lo stesso nome.
azureBlobFileListSource		AzureBlobFileListContentSource	Elenco di file di Archiviazione BLOB di Azure che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Percorso di Archiviazione BLOB di Azure contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
description		string maxLength: 4096	Descrizione del modello di documento.
maxTrainingHours		number (float)	Numero massimo di ore GPU equivalenti V100 da usare per il training del modello. Valore predefinito=0.5.
tags		object	Elenco degli attributi di tag chiave-valore associati al modello di documento.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Intestazioni Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Risposta di errore imprevista.

Nome

Tipo

Descrizione

202 Accepted

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Intestazioni

Operation-Location: string
Retry-After: integer

Other Status Codes

DocumentIntelligenceErrorResponse

Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Build Document Model

Esempio di richiesta

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-11-30

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

Risposta di esempio

Codice di stato:: 202

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

Definizioni

Nome	Descrizione
AzureBlobContentSource	Contenuto di Archiviazione BLOB di Azure.
AzureBlobFileListContentSource	Elenco di file in Archiviazione BLOB di Azure.
BuildDocumentModelRequest	Corpo della richiesta per creare un nuovo modello di documento personalizzato.
DocumentBuildMode	Modalità di compilazione del modello di documento personalizzato.
DocumentIntelligenceError	Oggetto error.
DocumentIntelligenceErrorResponse	Oggetto risposta di errore.
DocumentIntelligenceInnerError	Oggetto contenente informazioni più specifiche sull'errore.

AzureBlobContentSource

Object

Contenuto di Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string (uri)	URL del contenitore di Archiviazione BLOB di Azure.
prefix	string	Prefisso del nome BLOB.

AzureBlobFileListContentSource

Object

Elenco di file in Archiviazione BLOB di Azure.

Nome	Tipo	Descrizione
containerUrl	string (uri)	URL del contenitore di Archiviazione BLOB di Azure.
fileList	string	Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti.

BuildDocumentModelRequest

Object

Corpo della richiesta per creare un nuovo modello di documento personalizzato.

Nome	Tipo	Valore predefinito	Descrizione
allowOverwrite	boolean	False	Consentire la sovrascrittura di un modello esistente con lo stesso nome.
azureBlobFileListSource	AzureBlobFileListContentSource		Elenco di file di Archiviazione BLOB di Azure che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Percorso di Archiviazione BLOB di Azure contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode		Modalità di compilazione del modello di documento personalizzato.
description	string maxLength: 4096		Descrizione del modello di documento.
maxTrainingHours	number (float)	0.5	Numero massimo di ore GPU equivalenti V100 da usare per il training del modello. Valore predefinito=0.5.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$		Nome univoco del modello di documento.
tags	object		Elenco degli attributi di tag chiave-valore associati al modello di documento.

DocumentBuildMode

Enumerazione

Modalità di compilazione del modello di documento personalizzato.

Valore	Descrizione
template	Eseguire la destinazione di documenti con modelli di oggetti visivi simili.
neural	Supportare documenti con modelli visivi diversi.

DocumentIntelligenceError

Object

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	DocumentIntelligenceError[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	DocumentIntelligenceInnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

DocumentIntelligenceErrorResponse

Object

Oggetto risposta di errore.

Nome	Tipo	Descrizione
error	DocumentIntelligenceError	Informazioni sull'errore.

DocumentIntelligenceInnerError

Object

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	DocumentIntelligenceInnerError	Errore interno.
message	string	Rappresentazione leggibile dell'errore.