Metadados do documento

Você pode adicionar metadados aos documentos em seu bucket do Amazon S3 para personalizar os resultados do chat e controlar o acesso em nível de documento. Metadados são informações adicionais sobre um documento, como título, data de criação e permissões de acesso.

O Amazon Quick suporta a atribuição de fontes com citações. Se você especificar o campo de _source_uri metadados, os links de atribuição de origem nos resultados do chat direcionarão os usuários para a URL configurada. Se você não especificar um_source_uri, os usuários ainda poderão acessar os documentos de origem por meio de links de citação clicáveis que baixam o arquivo no momento da consulta.

Localização dos metadados do documento

No Amazon S3, cada arquivo de metadados pode ser associado a um documento indexado. Seus arquivos de metadados devem ser armazenados no mesmo bucket do Amazon S3 que seus arquivos indexados. Você pode especificar um local dentro do bucket do Amazon S3 para seus arquivos de metadados ao configurar sua integração com o Amazon S3 no Amazon Quick.

Se você não especificar um prefixo do Amazon S3, seus arquivos de metadados devem ser armazenados no mesmo local que seus documentos indexados. Se você especificar um prefixo do Amazon S3 para seus arquivos de metadados, eles devem estar em uma estrutura de diretórios paralela aos seus documentos indexados. O Amazon Quick procura seus metadados somente no diretório especificado. Se os metadados não forem lidos, verifique se a localização do diretório corresponde à localização dos metadados.

Os seguintes exemplos mostram como a localização do documento indexado é mapeada para a localização do arquivo de metadados: A chave Amazon S3 do documento é anexada ao prefixo Amazon S3 dos metadados e, em seguida, sufixada com para formar o caminho do Amazon S3 .metadata.json do arquivo de metadados.

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
            

Estrutura de metadados do documento

Defina os metadados do documento em um arquivo JSON. O arquivo deve ser um arquivo de texto UTF-8 sem um marcador BOM. O nome do arquivo JSON deve ser <document>.<extension>.metadata.json. Neste exemplo, document é o nome do documento ao qual os metadados se aplicam e extension é a extensão do arquivo do documento. O ID do documento deve ser exclusivo na <document>.<extension>.metadata.json.

O conteúdo do arquivo JSON usa o seguinte modelo:

{
    "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 você fornecer um caminho de metadados, certifique-se de que a estrutura do diretório dentro do diretório de metadados corresponda exatamente à estrutura do diretório do arquivo de dados.

Por exemplo, se o local do arquivo de dados for em s3://bucketName/documents/legal/file.txt, o local do arquivo de metadados deverá estar em s3://bucketName/metadata/documents/legal/file.txt.metadata.json.

Todos os atributos e campos são opcionais, portanto, não é necessário incluir todos os atributos. No entanto, você deve fornecer um valor para cada atributo que deseja incluir; o valor não pode estar em branco.

Os campos de metadados _created_at e _last_updated_at são datas codificadas no ISO 8601. Por exemplo, 2012-03-25T12:30:10+01:00 é o formato de data e hora do ISO 8601 para 25 de março de 2012 às 12h30 (mais 10 segundos) no horário da Europa Central.

O AccessControlList campo é uma matriz opcional que define o controle de acesso em nível de documento. Cada entrada na matriz contém os seguintes campos: