Metadati del documento

Puoi aggiungere metadati ai documenti nel tuo bucket Amazon S3 per personalizzare i risultati della chat e controllare l'accesso a livello di documento. I metadati sono informazioni aggiuntive su un documento, come il titolo, la data di creazione e le autorizzazioni di accesso.

Amazon Quick supporta l'attribuzione della fonte con citazioni. Se specifichi il campo _source_uri dei metadati, i link di attribuzione della fonte nei risultati della chat indirizzano gli utenti all'URL configurato. Se non specifichi a_source_uri, gli utenti possono comunque accedere ai documenti di origine tramite link di citazione cliccabili che scaricano il file al momento della query.

Posizione dei metadati nei documenti

In Amazon S3, ogni file di metadati può essere associato a un documento indicizzato. I file di metadati devono essere archiviati nello stesso bucket Amazon S3 dei file indicizzati. Puoi specificare una posizione all'interno del bucket Amazon S3 per i tuoi file di metadati durante la configurazione dell'integrazione Amazon S3 in Amazon Quick.

Se non specifichi un prefisso Amazon S3, i file di metadati devono essere archiviati nella stessa posizione dei documenti indicizzati. Se specifichi un prefisso Amazon S3 per i tuoi file di metadati, questi devono trovarsi in una struttura di directory parallela ai documenti indicizzati. Amazon Quick cerca i metadati solo nella directory specificata. Se i metadati non vengono letti, verifica che la posizione della directory corrisponda alla posizione dei metadati.

Gli esempi seguenti mostrano come la posizione del documento indicizzato è mappata sulla posizione del file dei metadati. La chiave Amazon S3 del documento viene aggiunta al prefisso Amazon S3 dei metadati e quindi dotata del suffisso per formare il percorso Amazon S3 .metadata.json del file di metadati.

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
            

Struttura dei metadati del documento

I metadati del documento vengono definiti da soli in un file JSON. Il file deve essere un file di testo UTF-8 senza un marcatore BOM. Il nome del file JSON deve essere <document>.<extension>.metadata.json. In questo esempio, document è il nome del documento a cui si applicano i metadati e extension l'estensione del file del documento. L’ID del documento deve essere univoco in <document>.<extension>.metadata.json.

Il contenuto del file JSON utilizza il seguente modello:

{
    "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"
}
        

Se fornite un percorso di metadati, assicuratevi che la struttura della directory all'interno della directory dei metadati corrisponda esattamente alla struttura di directory del file di dati.

Ad esempio, se la posizione del file di dati è in s3://bucketName/documents/legal/file.txt, la posizione del file di metadati dovrebbe essere in s3://bucketName/metadata/documents/legal/file.txt.metadata.json.

Tutti gli attributi e i campi sono facoltativi, quindi non è necessario includere tutti gli attributi. Tuttavia, è necessario fornire un valore per ogni attributo che si desidera includere; il valore non può essere vuoto.

I campi dei metadati _created_at e _last_updated_at sono date con codifica ISO 8601. Ad esempio, 2012-03-25T12:30:10+01:00 è il formato data/ora ISO 8601 per il 25 marzo 2012 alle 12:30 (più 10 secondi) nel fuso orario dell’Europa centrale (CET).

Il AccessControlList campo è un array opzionale che definisce il controllo degli accessi a livello di documento. Ogni voce dell'array contiene i seguenti campi: