Metadatos del documento

Puede añadir metadatos a los documentos de su bucket de Amazon S3 para personalizar los resultados del chat y controlar el acceso a nivel de documento. Los metadatos son información adicional sobre un documento, como su título, fecha de creación y permisos de acceso.

Amazon Quick admite la atribución de fuentes con citas. Si especificas el campo de _source_uri metadatos, los enlaces de atribución de origen de los resultados del chat dirigen a los usuarios a la URL configurada. Si no especificas una_source_uri, los usuarios podrán seguir accediendo a los documentos fuente a través de enlaces de citas en los que se puede hacer clic y que descargan el archivo en el momento de la consulta.

Ubicación de los metadatos del documento

En Amazon S3, cada archivo de metadatos puede asociarse a un documento indexado. Los archivos de metadatos deben almacenarse en el mismo depósito de Amazon S3 que los archivos indexados. Puede especificar una ubicación dentro del bucket de Amazon S3 para sus archivos de metadatos al configurar la integración de Amazon S3 en Amazon Quick.

Si no especifica un prefijo de Amazon S3, los archivos de metadatos deben almacenarse en la misma ubicación que los documentos indexados. Si especifica un prefijo de Amazon S3 para sus archivos de metadatos, estos deben estar en una estructura de directorios paralela a los documentos indexados. Amazon Quick busca sus metadatos únicamente en el directorio especificado. Si no se leen los metadatos, compruebe que la ubicación del directorio coincide con la ubicación de los metadatos.

En los siguientes ejemplos se muestra cómo la ubicación del documento indexado se asigna a la ubicación del archivo de metadatos. La clave Amazon S3 del documento se adjunta al prefijo Amazon S3 de los metadatos y, a continuación, se añade el sufijo con .metadata.json para formar la ruta de Amazon S3 del archivo de metadatos.

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
            

Estructura de metadatos del documento

Los metadatos de su documento se definen en un archivo JSON. El archivo debe ser un archivo de texto UTF-8 sin un marcador BOM. El nombre del archivo JSON debe ser <document>.<extension>.metadata.json. En este ejemplo, document es el nombre del documento al que se aplican los metadatos y extension es la extensión de archivo del documento. El ID del documento debe ser único en <document>.<extension>.metadata.json.

El contenido del archivo JSON utiliza esta plantilla.

{
    "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 proporciona una ruta de metadatos, asegúrese de que la estructura de directorios dentro del directorio de metadatos coincida exactamente con la estructura de directorios del archivo de datos.

Por ejemplo, si la ubicación del archivo de datos es s3://bucketName/documents/legal/file.txt, la ubicación del archivo de metadatos debe ser s3://bucketName/metadata/documents/legal/file.txt.metadata.json.

Todos los atributos y campos son opcionales, por lo que no es necesario incluir todos los atributos. Sin embargo, debe proporcionar un valor para cada atributo que desee incluir; el valor no puede estar vacío.

Los campos de metadatos _created_at y _last_updated_at son fechas codificadas según la norma ISO 8601. Por ejemplo, 2012-03-25T12:30:10+01:00 es el formato de fecha y hora ISO 8601 para el 25 de marzo de 2012, a las 12.30 h (más 10 segundos) en la zona horaria de Europa Central.

El AccessControlList campo es una matriz opcional que define el control de acceso a nivel de documento. Cada entrada de la matriz contiene los siguientes campos: