Skip to content

DocumentAttributeTarget

Source code in docs_src/capo_kendra/types/document_attribute_target.py 
13
14
15
16
17
18
19
20
21
22
23
class DocumentAttributeTarget(TypedDict, closed=True):
    target_document_attribute_key: NotRequired[
        "capo_kendra.types.document_attribute_key.DocumentAttributeKey"
    ]
    """<p>The identifier of the target document attribute or metadata field.</p> <p>For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.</p>"""
    target_document_attribute_value_deletion: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to <code>TRUE</code>. To create a target value (<code>TargetDocumentAttributeValue</code>), set this to <code>FALSE</code>.</p>"""
    target_document_attribute_value: NotRequired[
        "capo_kendra.types.document_attribute_value.DocumentAttributeValue"
    ]
    """<p>The target value you want to create for the target attribute.</p> <p>For example, 'Finance' could be the target value for the target attribute key 'Department'.</p>"""

target_document_attribute_key instance-attribute 

target_document_attribute_key: NotRequired[DocumentAttributeKey]

The identifier of the target document attribute or metadata field.

For example, 'Department' could be an identifier for the target attribute or metadata field that includes the department names associated with the documents.

target_document_attribute_value instance-attribute 

target_document_attribute_value: NotRequired[DocumentAttributeValue]

The target value you want to create for the target attribute.

For example, 'Finance' could be the target value for the target attribute key 'Department'.

target_document_attribute_value_deletion instance-attribute 

target_document_attribute_value_deletion: Boolean

TRUE to delete the existing target value for your specified target attribute key. You cannot create a target value and set this to TRUE. To create a target value (TargetDocumentAttributeValue), set this to FALSE.