ドキュメントメタデータ

Amazon S3 バケット内のドキュメントにメタデータを追加して、チャット結果をカスタマイズし、ドキュメントレベルのアクセスを制御できます。メタデータは、タイトル、作成日、アクセス許可など、ドキュメントに関する追加情報です。

Amazon Quick は、引用を含むソース属性をサポートしています。_source_uri メタデータフィールドを指定した場合、チャット結果のソース属性リンクは、設定された URL にユーザーを誘導します。を指定しない場合でも_source_uri、ユーザーは、クエリ時にファイルをダウンロードするクリック可能な引用リンクからソースドキュメントにアクセスできます。

ドキュメントメタデータの場所

Amazon S3 では、各メタデータファイルをインデックス付きドキュメントに関連付けることができます。メタデータファイルは、インデックス付きファイルと同じ Amazon S3 バケットに保存する必要があります。Amazon Quick で Amazon S3 統合を設定するときに、メタデータファイルの Amazon S3 バケット内の場所を指定できます。

Amazon S3 プレフィックスを指定しない場合、メタデータファイルはインデックス付きドキュメントと同じ場所に保存する必要があります。メタデータファイルに Amazon S3 プレフィックスを指定する場合は、インデックス付きドキュメントと並行するディレクトリ構造である必要があります。Amazon Quick は、指定されたディレクトリでのみメタデータを検索します。メタデータが読み込まれない場合は、ディレクトリの場所がメタデータの場所と一致していることをチェックします。

次の例は、インデックス作成されたドキュメントの場所がメタデータファイルの場所にどのようにマッピングされるかを示しています。ドキュメントの Amazon S3 キーがメタデータの Amazon S3 プレフィックスに追加され、 にサフィックスを付けてメタデータファイルの Amazon S3 パス.metadata.jsonを形成します。

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
            

ドキュメントのメタデータの構造

ドキュメントのメタデータ自体は JSON ファイル内で定義します。ファイルは、BOM マーカーの無い UTF-8 テキストファイルである必要があります。JSON ファイルのファイル名は <document>.<extension>.metadata.json である必要があります。この例では、 documentはメタデータが適用されるドキュメントの名前で、 extensionはドキュメントのファイル拡張子です。ドキュメント ID は <document>.<extension>.metadata.json 内で一意である必要があります。

JSON ファイルの内容では次のテンプレートを使用します。

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

メタデータパスを指定する場合は、メタデータディレクトリ内のディレクトリ構造がデータファイルのディレクトリ構造と正確に一致していることを確認してください。

例えば、データファイルの場所が s3://bucketName/documents/legal/file.txt の場合、メタデータファイルの場所は s3://bucketName/metadata/documents/legal/file.txt.metadata.json である必要があります。

すべての属性とフィールドが必須ではないため、すべての属性を含める必要はありません。ただし、含める属性ごとに値を指定する必要があります。値を空にすることはできません。

_created_at および _last_updated_at メタデータフィールドは ISO 8601 でエンコードされた日付です。例えば、2012-03-25T12:30:10+01:00 は、中央ヨーロッパ時間の 2012 年 3 月 25 日午後 12 時 30 分 (プラス 10 秒) の ISO 8601 の日付/時刻形式です。

AccessControlList フィールドは、ドキュメントレベルのアクセスコントロールを定義するオプションの配列です。配列の各エントリには、次のフィールドが含まれます。