Document Models - Build Model
Compila un modello di analisi dei documenti personalizzato.
POST {endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com). |
api-version
|
query | True |
string |
Versione dell'API richiesta. |
Intestazione della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Chiave privata per la sottoscrizione di Servizi cognitivi di Azure. |
Corpo della richiesta
Nome | Necessario | Tipo | Descrizione |
---|---|---|---|
buildMode | True |
Modalità di compilazione del modello di documento personalizzato. |
|
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 viene accodata correttamente. Headers Operation-Location: string |
|
Other Status Codes |
Errore rilevato. |
Sicurezza
Ocp-Apim-Subscription-Key
Chiave privata per la sottoscrizione di Servizi cognitivi di Azure.
Type:
apiKey
In:
header
Esempio
Build Document Model
Sample Request
POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31
{
"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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31
Definizioni
Nome | Descrizione |
---|---|
Azure |
Archiviazione BLOB di Azure contenuto. |
Azure |
Elenco di file in Archiviazione BLOB di Azure. |
Build |
Corpo della richiesta per compilare un nuovo modello di documento personalizzato. |
Document |
Modalità di compilazione del modello di documento personalizzato. |
Error |
Informazioni sugli errori. |
Error |
Oggetto risposta di errore. |
Inner |
Errore dettagliato. |
AzureBlobContentSource
Archiviazione BLOB di Azure contenuto.
Nome | Tipo | Descrizione |
---|---|---|
containerUrl |
string |
Archiviazione BLOB di Azure URL del contenitore. |
prefix |
string |
Prefisso del nome DEL BLOB. |
AzureBlobFileListContentSource
Elenco di file in Archiviazione BLOB di Azure.
Nome | Tipo | Descrizione |
---|---|---|
containerUrl |
string |
Archiviazione BLOB di Azure URL del contenitore. |
fileList |
string |
Percorso di un file JSONL all'interno del contenitore che specifica un subset di documenti per il training. |
BuildDocumentModelRequest
Corpo della richiesta 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 personalizzato. |
|
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 personalizzato.
Nome | Tipo | Descrizione |
---|---|---|
neural |
string |
Supportare documenti con modelli visivi diversi. |
template |
string |
Impostare come destinazione i documenti con modelli di oggetto visivo simili. |
Error
Informazioni sugli errori.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
details |
Error[] |
Elenco degli errori dettagliati. |
innererror |
Errore dettagliato. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione dell'errore. |
ErrorResponse
Oggetto risposta di errore.
Nome | Tipo | Descrizione |
---|---|---|
error |
Informazioni sugli errori. |
InnerError
Errore dettagliato.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore. |
innererror |
Errore dettagliato. |
|
message |
string |
Messaggio di errore. |