Class: Aws::Kendra::Types::DocumentAttributeCondition

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

Overview

The condition used for the target document attribute or metadata field when ingesting documents into Amazon Kendra. 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 Kendra cannot 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 Kendra then will map your newly created metadata field to your index field.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#condition_document_attribute_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 Kendra currently does not support _document_body as an attribute key used for the condition.

Returns:

  • (String) 


4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4612

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

#condition_on_value ⇒ Types::DocumentAttributeValue

The value used by the operator.

For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.

Returns:



4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4612

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

#operator ⇒ String

The condition operator.

For example, you can use 'Contains' to partially match a string.

Returns:

  • (String) 


4612
4613
4614
4615
4616
4617
4618
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4612

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