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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DocumentAttributeCondition

Includes:

Structure

Defined in:

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.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_DocumentAttributeTarget.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #condition_document_attribute_key ⇒ String

  The identifier of the document attribute used for the condition.

• #condition_on_value ⇒ Types::DocumentAttributeValue

  The value used by the operator.

• #operator ⇒ String

  The condition operator.

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)

# File 'lib/aws-sdk-kendra/types.rb', line 4578

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:

• (Types::DocumentAttributeValue)

# File 'lib/aws-sdk-kendra/types.rb', line 4578

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)

# File 'lib/aws-sdk-kendra/types.rb', line 4578

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