Questo documento descrive come gestire gli schemi di documenti in Document AI Warehouse, incluse le operazioni di creazione, recupero, elenco, aggiornamento ed eliminazione.
Che cosa sono gli schemi di documenti
Ogni documento è di un determinato tipo di documento ed è specificato da uno schema.
Uno schema di documento definisce la struttura di un tipo di documento (ad esempio, fattura o busta paga) in Document AI Warehouse, dove gli amministratori possono specificare le proprietà di diversi tipi di dati (testo | numerico | data | enumerazione).
Le proprietà vengono utilizzate per rappresentare i dati estratti, i tag di classificazione o altri tag aziendali aggiunti ai documenti dall'AI o dagli utenti umani, ad esempio Invoice_Amount (numerico), Due_Date (data) o Supplier_Name (testo).
Attributi delle proprietà:ogni proprietà può essere dichiarata come
Filtrabile: può essere utilizzata per filtrare i risultati di ricerca
Ricercabile: indicizzata in modo che possa essere trovata nelle query di ricerca
Obbligatoria:
requiredviene utilizzata per garantire che la proprietà esista nel documento (ti consigliamo di salvare la maggior parte delle proprietà comerequired = false, a meno che la proprietà non sia obbligatoria).
Schema estensibile:in alcuni casi, gli utenti finali con accesso in modifica devono aggiungere / eliminare nuove proprietà dello schema nei documenti. Questa operazione è supportata da una "proprietà MAP", che è un elenco di coppie chiave-valore.
Ogni coppia chiave-valore in una proprietà MAP può essere di un tipo di dati (testo | numerico | data | enumerazione).
Ad esempio, la fattura può contenere una proprietà MAP "Invoice_Entities" con le seguenti coppie chiave-valore:
Invoice_Amount (numerico) 1000
Due_Date (data) 24/12/2021
Supplier_Name (testo) ABC Corp
Immutabilità dello schema:tieni presente che gli schemi o le proprietà dello schema possono essere aggiunti, ma al momento non possono essere modificati o eliminati, quindi definisci lo schema con attenzione.
Prima di iniziare
Prima di iniziare, assicurati di aver completato la pagina Guida rapida.
Crea uno schema
Crea uno schema di documento.
REST
curl --location --request POST --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--data '{
"display_name": "Test Doc Schema",
"property_definitions": [
{
"name": "plaintiff",
"display_name": "Plaintiff",
"is_searchable": true,
"is_repeatable": true,
"text_type_options": {}
}
]
}'Python
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Python.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per saperne di più, consulta la Documentazione di riferimento dell'Java API di Document AI Warehouse.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Node.js.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Ottieni uno schema
Ottieni i dettagli di uno schema di documento.
REST
curl --request GET --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas/{document_schema_id} \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8"Python
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Python.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per saperne di più, consulta la Documentazione di riferimento dell'Java API di Document AI Warehouse.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Node.js.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Elenca schemi
Elenca gli schemi di documenti.
REST
curl --request GET --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8"Python
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Python.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per saperne di più, consulta la Documentazione di riferimento dell'Java API di Document AI Warehouse.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Elimina uno schema
Elimina uno schema di documento.
REST
curl --request DELETE --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas/{document_schema_id} \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8"Python
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Python.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per saperne di più, consulta la Documentazione di riferimento dell'Java API di Document AI Warehouse.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Node.js
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Node.js.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Aggiorna uno schema
Aggiorna uno schema di documento. Al momento, la logica di aggiornamento supporta solo l'aggiunta di nuove definizioni di proprietà. Il nuovo schema di documento deve includere tutte le definizioni di proprietà presenti nello schema esistente.
Supportato:
- Per le proprietà esistenti, gli utenti possono modificare le seguenti impostazioni dei metadati:
is_repeatable,is_metadata,is_required. - Per le proprietà ENUM esistenti, gli utenti possono aggiungere nuovi valori possibili ENUM o eliminare i valori possibili ENUM esistenti. Possono aggiornare il flag
EnumTypeOptions.validation_check_disabledper disattivare il controllo di convalida. Il controllo di convalida viene utilizzato per assicurarsi che i valori ENUM specificati nei documenti rientrino nell'intervallo di valori ENUM possibili definiti nella definizione della proprietà quando si chiama l'APICreateDocument. - È supportata l'aggiunta di nuove definizioni di proprietà.
- Per le proprietà esistenti, gli utenti possono modificare le seguenti impostazioni dei metadati:
Non supportato:
- Per lo schema esistente, non sono consentiti aggiornamenti a
display_nameedocument_is_folder. - Per le proprietà esistenti, non sono consentiti aggiornamenti a
name,display_nameevalue_type_options.
- Per lo schema esistente, non sono consentiti aggiornamenti a
REST
curl --request PATCH --url https://contentwarehouse.googleapis.com/v1/projects/PROJECT_NUMBER/locations/LOCATION/documentSchemas/{document_schema_id} \
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-Type: application/json; charset=UTF-8" \
--data '{
"document_schema": {
"display_name": "Test Doc Schema",
"property_definitions": [
{
"name": "plaintiff",
"display_name": "Plaintiff",
"is_repeatable": true,
"text_type_options": {}
}
]
}
}'Python
Per saperne di più, consulta la documentazione di riferimento dell'API Document AI Warehouse Python.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Java
Per saperne di più, consulta la Documentazione di riferimento dell'Java API di Document AI Warehouse.
Per eseguire l'autenticazione in Document AI Warehouse, configura le credenziali predefinite dell'applicazione. Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.
Passaggi successivi
- Vai a Gestire i documenti per scoprire come gestire i documenti.