Metadaten des Dokuments

Sie können Metadaten zu Dokumenten in Ihrem Amazon S3 S3-Bucket hinzufügen, um die Chat-Ergebnisse anzupassen und den Zugriff auf Dokumentebene zu kontrollieren. Metadaten sind zusätzliche Informationen zu einem Dokument, wie Titel, Erstellungsdatum und Zugriffsberechtigungen.

Amazon Quick unterstützt die Quellenzuweisung mit Zitaten. Wenn Sie das _source_uri Metadatenfeld angeben, leiten die Links zur Quellenzuweisung in den Chat-Ergebnissen die Benutzer zur konfigurierten URL weiter. Wenn Sie kein angeben_source_uri, können Benutzer trotzdem über anklickbare Zitationslinks, die die Datei bei der Abfrage herunterladen, auf Quelldokumente zugreifen.

Speicherort der Dokumentmetadaten

In Amazon S3 kann jede Metadatendatei einem indexierten Dokument zugeordnet werden. Ihre Metadatendateien müssen in demselben Amazon S3 S3-Bucket wie Ihre indizierten Dateien gespeichert werden. Sie können einen Speicherort innerhalb des Amazon S3 S3-Buckets für Ihre Metadatendateien angeben, wenn Sie Ihre Amazon S3 S3-Integration in Amazon Quick konfigurieren.

Wenn Sie kein Amazon S3 S3-Präfix angeben, müssen Ihre Metadatendateien am selben Ort wie Ihre indizierten Dokumente gespeichert werden. Wenn Sie ein Amazon S3 S3-Präfix für Ihre Metadatendateien angeben, müssen sich diese in einer Verzeichnisstruktur parallel zu Ihren indizierten Dokumenten befinden. Amazon Quick sucht nur im angegebenen Verzeichnis nach Ihren Metadaten. Wenn die Metadaten nicht gelesen werden, überprüfen Sie, ob der Speicherort des Verzeichnisses mit dem Speicherort Ihrer Metadaten übereinstimmt.

Die folgenden Beispiele zeigen, wie der Speicherort des indexierten Dokuments dem Speicherort der Metadatendatei zugeordnet wird. Der Amazon S3 S3-Schlüssel des Dokuments wird an das Amazon S3 S3-Präfix der Metadaten angehängt und dann mit einem Suffix versehen, .metadata.json um den Amazon S3 S3-Pfad der Metadatendatei zu bilden.

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 der Dokumentmetadaten

Sie definieren Ihre Dokumentmetadaten selbst in einer JSON-Datei. Die Datei muss eine UTF-8-Textdatei ohne BOM-Markierung sein. Der Dateiname der JSON-Datei muss <document>.<extension>.metadata.json sein. In diesem Beispiel document ist dies der Name des Dokuments, für das extension sich die Metadaten beziehen, und die Dateierweiterung für das Dokument. Die Dokument-ID muss in <document>.<extension>.metadata.json eindeutig sein.

Für den Inhalt der JSON-Datei wird die folgende Vorlage verwendet:

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

Wenn Sie einen Metadatenpfad angeben, stellen Sie sicher, dass die Verzeichnisstruktur innerhalb des Metadatenverzeichnisses genau der Verzeichnisstruktur der Datendatei entspricht.

Wenn sich die Datendatei beispielsweise im Speicherort s3://bucketName/documents/legal/file.txt befindet, sollte der Speicherort der Metadatendatei s3://bucketName/metadata/documents/legal/file.txt.metadata.json sein.

Alle Attribute und Felder sind optional, sodass es nicht notwendig ist, alle Attribute einzubeziehen. Sie müssen jedoch für jedes Attribut, das Sie einbeziehen möchten, einen Wert angeben. Der Wert darf nicht leer sein.

Die Metadatenfelder _created_at und _last_updated_at sind nach ISO 8601 kodierte Datumsangaben. Beispiel: 2012-03-25T12:30:10+01:00 ist das ISO-8601-Datums-/Uhrzeitformat für den 25. März 2012 um 12:30 Uhr (plus 10 Sekunden) in mitteleuropäischer Zeit (CET).

Das AccessControlList Feld ist ein optionales Array, das die Zugriffskontrolle auf Dokumentebene definiert. Jeder Eintrag im Array enthält die folgenden Felder: