Document Models - Build Model
Compila un modello di analisi dei documenti personalizzato.
POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-02-29-preview
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
endpoint
|
path | True |
string |
Endpoint del servizio Document Intelligence. |
api-version
|
query | True |
string |
Versione dell'API da usare per questa operazione. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
buildMode | True |
Modalità di compilazione del modello di documento personalizzata. |
|
modelId | True |
string |
Nome univoco del modello di documento. |
azureBlobFileListSource |
Archiviazione BLOB di Azure elenco di file che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource. |
||
azureBlobSource |
Archiviazione BLOB di Azure posizione contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource. |
||
description |
string |
Descrizione del modello di documento. |
|
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. Headers
|
|
Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
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
Nome | Descrizione |
---|---|
https://cognitiveservices.azure.com/.default |
Esempio
Build Document Model
Sample Request
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
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview
Definizioni
Nome | Descrizione |
---|---|
Azure |
Archiviazione BLOB di Azure contenuto. |
Azure |
Elenco di file in Archiviazione BLOB di Azure. |
Build |
Richiedere il corpo per compilare un nuovo modello di documento personalizzato. |
Document |
Modalità di compilazione del modello di documento personalizzata. |
Error |
Oggetto error. |
Error |
Oggetto risposta errore. |
Inner |
Oggetto contenente informazioni più specifiche sull'errore. |
AzureBlobContentSource
Archiviazione BLOB di Azure contenuto.
Nome | Tipo | Descrizione |
---|---|---|
containerUrl |
string |
ARCHIVIAZIONE BLOB DI AZURE URL contenitore. |
prefix |
string |
Prefisso del nome BLOB. |
AzureBlobFileListContentSource
Elenco di file in Archiviazione BLOB di Azure.
Nome | Tipo | Descrizione |
---|---|---|
containerUrl |
string |
ARCHIVIAZIONE BLOB DI AZURE URL contenitore. |
fileList |
string |
Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti. |
BuildDocumentModelRequest
Richiedere il corpo per compilare un nuovo modello di documento personalizzato.
Nome | Tipo | Descrizione |
---|---|---|
azureBlobFileListSource |
Archiviazione BLOB di Azure elenco di file che specifica i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource. |
|
azureBlobSource |
Archiviazione BLOB di Azure posizione contenente i dati di training. È necessario specificare azureBlobSource o azureBlobFileListSource. |
|
buildMode |
Modalità di compilazione del modello di documento personalizzata. |
|
description |
string |
Descrizione del modello di documento. |
modelId |
string |
Nome univoco del modello di documento. |
tags |
object |
Elenco degli attributi di tag chiave-valore associati al modello di documento. |
DocumentBuildMode
Modalità di compilazione del modello di documento personalizzata.
Nome | Tipo | Descrizione |
---|---|---|
neural |
string |
Supportare documenti con modelli visivi diversi. |
template |
string |
Visualizzare documenti di destinazione con modelli di oggetto visivo simili. |
Error
Oggetto error.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Uno di un set definito dal server di codici di errore. |
details |
Error[] |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Rappresentazione leggibile dell'errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Oggetto risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error |
Informazioni sull'errore. |
InnerError
Oggetto contenente informazioni più specifiche sull'errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Uno di un set definito dal server di codici di errore. |
innererror |
Errore interno. |
|
message |
string |
Rappresentazione leggibile dell'errore. |