Class: Aws::QBusiness::Types::InlineDocumentEnrichmentConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#condition ⇒ Types::DocumentAttributeCondition

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.

Returns:



3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3812

class InlineDocumentEnrichmentConfiguration < Struct.new(
  :condition,
  :target,
  :document_content_operator)
  SENSITIVE = []
  include Aws::Structure
end

#document_content_operator ⇒ String

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

Returns:

  • (String) 


3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3812

class InlineDocumentEnrichmentConfiguration < Struct.new(
  :condition,
  :target,
  :document_content_operator)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ Types::DocumentAttributeTarget

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 .

Returns:



3812
3813
3814
3815
3816
3817
3818
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3812

class InlineDocumentEnrichmentConfiguration < Struct.new(
  :condition,
  :target,
  :document_content_operator)
  SENSITIVE = []
  include Aws::Structure
end