Métadonnées du document

Vous pouvez ajouter des métadonnées aux documents de votre compartiment Amazon S3 afin de personnaliser les résultats du chat et de contrôler l'accès au niveau des documents. Les métadonnées sont des informations supplémentaires sur un document, telles que son titre, sa date de création et ses autorisations d'accès.

Amazon Quick prend en charge l'attribution des sources par le biais de citations. Si vous spécifiez le champ de _source_uri métadonnées, les liens d'attribution de source dans les résultats du chat dirigent les utilisateurs vers l'URL configurée. Si vous ne spécifiez pas un_source_uri, les utilisateurs peuvent toujours accéder aux documents sources via des liens de citation cliquables qui téléchargent le fichier au moment de la requête.

Emplacement des métadonnées du document

Dans Amazon S3, chaque fichier de métadonnées peut être associé à un document indexé. Vos fichiers de métadonnées doivent être stockés dans le même compartiment Amazon S3 que vos fichiers indexés. Vous pouvez spécifier un emplacement dans le compartiment Amazon S3 pour vos fichiers de métadonnées lors de la configuration de votre intégration Amazon S3 dans Amazon Quick.

Si vous ne spécifiez pas de préfixe Amazon S3, vos fichiers de métadonnées doivent être stockés au même endroit que vos documents indexés. Si vous spécifiez un préfixe Amazon S3 pour vos fichiers de métadonnées, ceux-ci doivent figurer dans une structure de répertoire parallèle à celle de vos documents indexés. Amazon Quick recherche uniquement vos métadonnées dans le répertoire indiqué. Si les métadonnées ne sont pas lues, vérifiez que l’emplacement du répertoire correspond à celui de vos métadonnées.

Les exemples suivants illustrent la manière dont l’emplacement du document indexé est mappé à l’emplacement du fichier de métadonnées. La clé Amazon S3 du document est ajoutée au préfixe Amazon S3 des métadonnées, puis suffixée .metadata.json pour former le chemin Amazon S3 du fichier de métadonnées.

Bucket name:
     s3://bucketName
Document path:
     documents
Metadata path:
     none
File mapping
     s3://bucketName/documents/file.txt -> 
        s3://bucketName/documents/file.txt.metadata.json
            

Bucket name:
     s3://bucketName
Document path:
     documents/legal
Metadata path:
     metadata
File mapping
     s3://bucketName/documents/legal/file.txt -> 
        s3://bucketName/metadata/documents/legal/file.txt.metadata.json
            

Structure des métadonnées du document

Vous définissez les métadonnées de votre document elles-mêmes dans un fichier JSON. Le fichier doit être un fichier texte UTF-8 sans marqueur BOM. Le nom du fichier JSON doit être <document>.<extension>.metadata.json. Dans cet exemple, document il s'agit du nom du document auquel s'appliquent les métadonnées et extension de l'extension de fichier du document. L’ID de document doit être unique dans <document>.<extension>.metadata.json.

Le contenu du fichier JSON utilise le modèle suivant :

{
    "DocumentId": "document ID",
    "Attributes": {
        "_authors": ["author of the document"],
        "_category": "document category",
        "_created_at": "ISO 8601 encoded string",
        "_last_updated_at": "ISO 8601 encoded string",
        "_source_uri": "document URI",
        "_version": "file version",
        "_view_count": number of times document has been viewed
    },
    "AccessControlList": [
        {
            "Name": "user1@example.com",
            "Type": "GROUP | USER",
            "Access": "ALLOW | DENY"
        }
    ],
    "Title": "document title",
    "ContentType": "PDF | HTML | MS_WORD | PLAIN_TEXT | PPT | RTF | XML | XSLT | MS_EXCEL | CSV | JSON | MD"
}
        

Si vous indiquez un chemin de métadonnées, assurez-vous que la structure du répertoire de métadonnées correspond exactement à celle du fichier de données.

Par exemple, si l’emplacement du fichier de données est dans s3://bucketName/documents/legal/file.txt, l’emplacement du fichier de métadonnées doit être à s3://bucketName/metadata/documents/legal/file.txt.metadata.json.

Tous les attributs et champs sont facultatifs, il n’est donc pas nécessaire d’inclure tous les attributs. Cependant, vous devez fournir une valeur pour chaque attribut que vous souhaitez inclure ; la valeur ne peut pas être vide.

Les champs de métadonnées _created_at et _last_updated_at sont des dates codées ISO 8601. Par exemple, 2012-03-25T12:30:10+01:00 est le format de date et d’heure ISO 8601 pour le 25 mars 2012 à 12 h 30 (plus 10 secondes) dans le fuseau horaire de l’heure d’Europe centrale.

Le AccessControlList champ est un tableau facultatif qui définit le contrôle d'accès au niveau du document. Chaque entrée du tableau contient les champs suivants :