Amazon Q BusinessQuip data source connector field mappings

To improve retrieved results and customize the end user chat experience, Amazon Q Business enables you to map document attributes from your data sources to fields in your Amazon Q index.

Amazon Q offers two kinds of attributes to map to index fields:

• Reserved or default – Reserved attributes are based on document attributes that commonly occur in most data. You can use reserved attributes to map commonly occurring document attributes in your data source to Amazon Q index fields.

• Custom – You can create custom attributes to map document attributes that are unique to your data to Amazon Q index fields.

When you connect Amazon Q to a data source, Amazon Q automatically maps specific data source document attributes to fields within an Amazon Q index. If a document attribute in your data source doesn't have a attribute mapping already available, or if you want to map additional document attributes to index fields, use the custom field mappings to specify how a data source attribute maps to an Amazon Q index field. You create field mappings by editing your data source after your application and retriever are created.

To learn more about document attributes and how they work in Amazon Q, see Document attributes and types in Amazon Q.

Important

Filtering using document attributes in chat is only supported through the API.

The Amazon Q Quip connector supports the following entities and the associated reserved and custom attributes.

Note

You can map any Quip field to the document title or document body Amazon Q reserved/default index fields.

Thread

Amazon Q supports crawling Quip Threads and offers the following thread field mappings.

Quip field name	Index field name	Description	Data type
qp_authors	_authors	Default	String list
qp_category	_category	Default	String
qp_file_type	qp_file_type	Custom	String
qp_document_title	qp_document_title	Custom	String
qp_source_uri	_source_uri	Default	String
qp_created_at	_created_at	Default	Date
qp_updated_at	_last_updated_at	Default	Date

Message

Amazon Q supports crawling Quip Messages and offers the following message field mappings.

Quip field name	Index field name	Description	Data type
qp_authors	_authors	Default	String list
qp_category	_category	Default	String
qp_source_uri	_source_uri	Default	String
qp_parent_file	qp_parent_file	Custom	String
qp_created_at	_created_at	Default	Date
qp_updated_at	_last_updated_at	Default	Date

Attachment

Amazon Q supports crawling Quip attachments and offers the following attachment field mappings.

Quip field name	Index field name	Description	Data type
qp_authors	_authors	Default	String list
qp_category	_category	Default	String
qp_source_uri	_source_uri	Default	String
qp_file_type	qp_file_type	Custom	String
qp_parent_file	qp_parent_file	Custom	String
qp_blob_id	qp_blob_id	Custom	String
qp_created_at	_created_at	Default	Date
qp_updated_at	_last_updated_at	Default	Date