Metadata dokumen

Anda dapat menambahkan metadata ke dokumen di bucket Amazon S3 untuk menyesuaikan hasil obrolan dan mengontrol akses tingkat dokumen. Metadata adalah informasi tambahan tentang dokumen, seperti judul, tanggal pembuatan, dan izin akses.

Amazon Quick mendukung atribusi sumber dengan kutipan. Jika Anda menentukan bidang _source_uri metadata, tautan atribusi sumber dalam hasil obrolan mengarahkan pengguna ke URL yang dikonfigurasi. Jika Anda tidak menentukan_source_uri, pengguna masih dapat mengakses dokumen sumber melalui tautan kutipan yang dapat diklik yang mengunduh file pada waktu kueri.

Lokasi metadata dokumen

Di Amazon S3, setiap file metadata dapat dikaitkan dengan dokumen yang diindeks. File metadata Anda harus disimpan dalam bucket Amazon S3 yang sama dengan file yang diindeks. Anda dapat menentukan lokasi dalam bucket Amazon S3 untuk file metadata saat mengonfigurasi integrasi Amazon S3 di Amazon Quick.

Jika Anda tidak menentukan awalan Amazon S3, file metadata Anda harus disimpan di lokasi yang sama dengan dokumen yang diindeks. Jika Anda menentukan awalan Amazon S3 untuk file metadata Anda, mereka harus dalam struktur direktori paralel dengan dokumen yang diindeks. Amazon Quick hanya terlihat di direktori yang ditentukan untuk metadata Anda. Jika metadata tidak terbaca, periksa apakah lokasi direktori sesuai dengan lokasi metadata.

Contoh berikut menunjukkan bagaimana lokasi dokumen yang diindeks dipetakan ke lokasi file metadata. Kunci Amazon S3 dokumen ditambahkan ke awalan Amazon S3 metadata dan kemudian diakhiran untuk .metadata.json membentuk jalur Amazon S3 file metadata.

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
            

Struktur metadata dokumen

Anda mendefinisikan metadata dokumen Anda sendiri dalam file JSON. File harus berupa file teks UTF-8 tanpa penanda BOM. Nama file dari file JSON harus<document>.<extension>.metadata.json. Dalam contoh ini, document adalah nama dokumen yang metadata berlaku dan extension merupakan ekstensi file untuk dokumen tersebut. ID dokumen harus unik di<document>.<extension>.metadata.json.

Isi file JSON menggunakan template berikut:

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

Jika Anda menyediakan jalur metadata, pastikan bahwa struktur direktori di dalam direktori metadata sama persis dengan struktur direktori file data.

Misalnya, jika lokasi file data berada dis3://bucketName/documents/legal/file.txt, lokasi file metadata harus berada di. s3://bucketName/metadata/documents/legal/file.txt.metadata.json

Semua atribut dan bidang bersifat opsional, jadi tidak perlu menyertakan semua atribut. Namun, Anda harus memberikan nilai untuk setiap atribut yang ingin Anda sertakan; nilainya tidak bisa kosong.

Bidang metadata _created_at dan _last_updated_at adalah tanggal yang dikodekan dengan ISO 8601. Misalnya, 2012-03-25T 12:30:10 +01:00 adalah format tanggal-waktu ISO 8601 untuk 25 Maret 2012, pukul 12:30 (ditambah 10 detik) di zona waktu Eropa Tengah.

AccessControlListBidang adalah array opsional yang mendefinisikan kontrol akses tingkat dokumen. Setiap entri dalam array berisi bidang-bidang berikut: