Class: Aws::QBusiness::Types::DocumentAttributeTarget
- Inherits:
-
Struct
- Object
- Struct
- Aws::QBusiness::Types::DocumentAttributeTarget
- Defined in:
- gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb
Overview
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
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#attribute_value_operator ⇒ String
TRUE
to delete the existing target value for your specified target attribute key. -
#key ⇒ String
The identifier of the target document attribute or metadata field.
-
#value ⇒ Types::DocumentAttributeValue
The value of a document attribute.
Instance Attribute Details
#attribute_value_operator ⇒ String
TRUE
to delete the existing target value for your specified target
attribute key. You cannot create a target value and set this to
TRUE
.
2598 2599 2600 2601 2602 2603 2604 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2598 class DocumentAttributeTarget < Struct.new( :key, :value, :attribute_value_operator) SENSITIVE = [] include Aws::Structure end |
#key ⇒ String
The identifier of the target document attribute or metadata field. For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.
2598 2599 2600 2601 2602 2603 2604 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2598 class DocumentAttributeTarget < Struct.new( :key, :value, :attribute_value_operator) SENSITIVE = [] include Aws::Structure end |
#value ⇒ Types::DocumentAttributeValue
The value of a document attribute. You can only provide one value for a document attribute.
2598 2599 2600 2601 2602 2603 2604 |
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 2598 class DocumentAttributeTarget < Struct.new( :key, :value, :attribute_value_operator) SENSITIVE = [] include Aws::Structure end |