Class: Aws::QBusiness::Types::DocumentAttributeCondition

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

Overview

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with [ ‘DocumentAttributeTarget` ][1] 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.

[1]: docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#key ⇒ String

The identifier of the document attribute used for the condition.

For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently doesn’t support ‘_document_body` as an attribute key used for the condition.

Returns:

  • (String) 


3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3076

class DocumentAttributeCondition < Struct.new(
  :key,
  :operator,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#operator ⇒ String

The identifier of the document attribute used for the condition.

For example, ‘Source_URI’ could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.

Amazon Q Business currently does not support ‘_document_body` as an attribute key used for the condition.

Returns:

  • (String) 


3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3076

class DocumentAttributeCondition < Struct.new(
  :key,
  :operator,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Types::DocumentAttributeValue

The value of a document attribute. You can only provide one value for a document attribute.

Returns:



3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 3076

class DocumentAttributeCondition < Struct.new(
  :key,
  :operator,
  :value)
  SENSITIVE = []
  include Aws::Structure
end