Skip to content

DocumentAttributeCondition

Source code in docs_src/capo_kendra/types/document_attribute_condition.py
class DocumentAttributeCondition(TypedDict, closed=True):
    condition_document_attribute_key: (
        "capo_kendra.types.document_attribute_key.DocumentAttributeKey"
    )
    """<p>The identifier of the document attribute used for the condition.</p> <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field that contains source URIs associated with the documents.</p> <p>Amazon Kendra currently does not support <code>_document_body</code> as an attribute key used for the condition.</p>"""
    operator: "capo_kendra.types.condition_operator.ConditionOperator"
    """<p>The condition operator.</p> <p>For example, you can use 'Contains' to partially match a string.</p>"""
    condition_on_value: NotRequired[
        "capo_kendra.types.document_attribute_value.DocumentAttributeValue"
    ]
    """<p>The value used by the operator.</p> <p>For example, you can specify the value 'financial' for strings in the 'Source_URI' field that partially match or contain this value.</p>"""

condition_document_attribute_key instance-attribute

condition_document_attribute_key: DocumentAttributeKey

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.

condition_on_value instance-attribute

condition_on_value: NotRequired[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.

operator instance-attribute

The condition operator.

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