/AWS1/CL_QQBINLINEDOCENRICHM00

Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.

To apply advanced logic, to go beyond what you can do with basic logic, see HookConfiguration .

For more information, see Custom document enrichment.

CONSTRUCTOR

IMPORTING

Optional arguments:

io_condition TYPE REF TO /AWS1/CL_QQBDOCUMENTATTRCOND /AWS1/CL_QQBDOCUMENTATTRCOND

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

io_target TYPE REF TO /AWS1/CL_QQBDOCUMENTATTRTARGET /AWS1/CL_QQBDOCUMENTATTRTARGET

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

iv_documentcontentoperator TYPE /AWS1/QQBDOCCONTENTOPERATOR /AWS1/QQBDOCCONTENTOPERATOR

TRUE to delete content if the condition used for the target attribute is met.

---

Queryable Attributes

condition

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with DocumentAttributeTarget to apply the condition.

For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget. Amazon Q Business then will map your newly created metadata field to your index field.

Accessible with the following methods

Method	Description
GET_CONDITION()	Getter for CONDITION

target

The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.

For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to TRUE. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.

Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using DocumentAttributeTarget . Amazon Q Business will then map your newly created document attribute to your index field.

You can also use this with DocumentAttributeCondition .

Accessible with the following methods

Method	Description
GET_TARGET()	Getter for TARGET

documentContentOperator

TRUE to delete content if the condition used for the target attribute is met.

Accessible with the following methods

Method	Description
GET_DOCUMENTCONTENTOPERATOR()	Getter for DOCUMENTCONTENTOPERATOR, with configurable defaul
ASK_DOCUMENTCONTENTOPERATOR()	Getter for DOCUMENTCONTENTOPERATOR w/ exceptions if field ha
HAS_DOCUMENTCONTENTOPERATOR()	Determine if DOCUMENTCONTENTOPERATOR has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_INLINEDOCENRICHMENTCONFS

TYPES TT_INLINEDOCENRICHMENTCONFS TYPE STANDARD TABLE OF REF TO /AWS1/CL_QQBINLINEDOCENRICHM00 WITH DEFAULT KEY
.