Skip to content

DocumentInfo

Source code in docs_src/capo_kendra/types/document_info.py 
14
15
16
17
18
19
20
class DocumentInfo(TypedDict, closed=True):
    document_id: "capo_kendra.types.document_id.DocumentId"
    """<p>The identifier of the document.</p>"""
    attributes: NotRequired[
        "capo_kendra.types.document_attribute_list.DocumentAttributeList"
    ]
    """<p>Attributes that identify a specific version of a document to check.</p> <p>The only valid attributes are:</p> <ul> <li> <p>version</p> </li> <li> <p>datasourceId</p> </li> <li> <p>jobExecutionId</p> </li> </ul> <p>The attributes follow these rules:</p> <ul> <li> <p> <code>dataSourceId</code> and <code>jobExecutionId</code> must be used together.</p> </li> <li> <p> <code>version</code> is ignored if <code>dataSourceId</code> and <code>jobExecutionId</code> are not provided.</p> </li> <li> <p>If <code>dataSourceId</code> and <code>jobExecutionId</code> are provided, but <code>version</code> is not, the version defaults to "0".</p> </li> </ul>"""

attributes instance-attribute 

attributes: NotRequired[DocumentAttributeList]

Attributes that identify a specific version of a document to check.

The only valid attributes are:

  • version

  • datasourceId

  • jobExecutionId

The attributes follow these rules:

  • dataSourceId and jobExecutionId must be used together.

  • version is ignored if dataSourceId and jobExecutionId are not provided.

  • If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

document_id instance-attribute 

document_id: DocumentId

The identifier of the document.