Ce document explique comment gérer les schémas de document dans Document AI Warehouse, y compris les opérations de création, de récupération, de listage, de mise à jour et de suppression.
Que sont les schémas de document ?
Chaque document est d'un certain type et est spécifié par un schéma.
Un schéma de document définit la structure d'un type de document (par exemple, une facture ou un bulletin de salaire) dans Document AI Warehouse, où les administrateurs peuvent spécifier des propriétés de différents types de données (texte, numérique, date ou énumération).
Les propriétés sont utilisées pour représenter les données extraites, les balises de classification ou d'autres balises commerciales ajoutées aux documents par des utilisateurs humains ou par l'IA. Par exemple, Invoice_Amount (numérique), Due_Date (date) ou Supplier_Name (texte).
Attributs de propriété : chaque propriété peut être déclarée comme
filtrable : peut être utilisée pour filtrer les résultats de recherche
interrogeable : indexée pour pouvoir être trouvée dans les requêtes de recherche
obligatoire :
requiredpermet de s'assurer que la propriété existe dans le document (nous vous recommandons d'enregistrer la plupart des propriétés en tant querequired = false, sauf si la propriété est obligatoire)
Schéma extensible : dans certains cas, les utilisateurs finaux disposant d'un accès en modification doivent ajouter ou supprimer des propriétés de schéma dans les documents. Cette fonctionnalité est compatible avec une "propriété MAP", qui est une liste de paires clé/valeur.
Chaque paire clé/valeur d'une propriété MAP peut être un type de données (texte, numérique, date ou énumération).
Par exemple, une facture peut contenir une propriété MAP "Invoice_Entities" avec les paires clé/valeur suivantes :
Invoice_Amount (numérique) 1000
Due_Date (date) 24/12/2021
Supplier_Name (texte) ABC Corp
Immuabilité du schéma : notez que les schémas ou les propriétés de schéma peuvent être ajoutés, mais ne peuvent actuellement pas être modifiés ni supprimés. Définissez donc soigneusement les schémas.
Avant de commencer
Avant de commencer, assurez-vous d'avoir terminé la Démarrage rapide page.
Créer un schéma
Créez un schéma de document.
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
Pour en savoir plus, consultez la documentation de référence de l'API Python Document AI Warehouse.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez ladocumentation de référence de l'API Document AI Warehouse Java.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Document AI Warehouse Node.js.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Obtenir un schéma
Obtenez les détails d'un schéma de document.
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
Pour en savoir plus, consultez la documentation de référence de l'API Python Document AI Warehouse.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez la documentation de référence de l'API Document AI Warehouse Java.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Document AI Warehouse Node.js.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Lister les schémas
Listez les schémas de document.
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
Pour en savoir plus, consultez la documentation de référence de l'API Python Document AI Warehouse.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez la documentation de référence de l'API Document AI Warehouse Java.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Supprimer un schéma
Supprimez un schéma de document.
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
Pour en savoir plus, consultez la documentation de référence de l'API Python Document AI Warehouse.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez ladocumentation de référence de l'API Document AI Warehouse Java.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Document AI Warehouse Node.js.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Mettre à jour un schéma
Mettez à jour un schéma de document. Actuellement, la logique de mise à jour n'est compatible qu'avec l'ajout de nouvelles définitions de propriétés. Le nouveau schéma de document doit inclure toutes les définitions de propriétés présentes dans le schéma existant.
Types compatibles :
- Pour les propriétés existantes, les utilisateurs peuvent modifier les paramètres de métadonnées suivants :
is_repeatable,is_metadata,is_required. - Pour les propriétés ENUM existantes, les utilisateurs peuvent ajouter ou supprimer des valeurs ENUM possibles. Ils peuvent modifier l'indicateur
EnumTypeOptions.validation_check_disabledpour désactiver la vérification de la validation. La vérification de la validation permet de s'assurer que les valeurs ENUM spécifiées dans les documents se trouvent dans la plage de valeurs ENUM possibles définies dans la définition de la propriété lors de l'appel de l'APICreateDocument. - L'ajout de nouvelles définitions de propriétés est compatible.
- Pour les propriétés existantes, les utilisateurs peuvent modifier les paramètres de métadonnées suivants :
Formats non compatibles :
- Pour les schémas existants, les mises à jour de
display_nameetdocument_is_folderne sont pas autorisées. - Pour les propriétés existantes, les mises à jour de
name,display_nameetvalue_type_optionsne sont pas autorisées.
- Pour les schémas existants, les mises à jour de
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
Pour en savoir plus, consultez la documentation de référence de l'API Python Document AI Warehouse.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez ladocumentation de référence de l'API Document AI Warehouse Java.
Pour vous authentifier auprès de Document AI Warehouse, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Étapes suivantes
- Passez à la section Gérer les documents pour découvrir comment gérer les documents.