Struct DocumentAttributeCondition 

#[non_exhaustive]
pub struct DocumentAttributeCondition {
    pub condition_document_attribute_key: String,
    pub operator: ConditionOperator,
    pub condition_on_value: Option<DocumentAttributeValue>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

operator: ConditionOperator

The condition operator.

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

condition_on_value: Option<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.

Implementations

impl DocumentAttributeCondition

pub fn condition_document_attribute_key(&self) -> &str

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.

pub fn operator(&self) -> &ConditionOperator

The condition operator.

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

pub fn condition_on_value(&self) -> Option<&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.

impl DocumentAttributeCondition

pub fn builder() -> DocumentAttributeConditionBuilder

Creates a new builder-style object to manufacture DocumentAttributeCondition.

Trait Implementations

impl Clone for DocumentAttributeCondition

fn clone(&self) -> DocumentAttributeCondition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentAttributeCondition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DocumentAttributeCondition

fn eq(&self, other: &DocumentAttributeCondition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocumentAttributeCondition