Skip to content

Relationship

Source code in docs_src/capo_textract/types/relationship.py
class Relationship(TypedDict, closed=True):
    type: NotRequired["capo_textract.types.relationship_type.RelationshipType"]
    """<p>The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned. </p> <ul> <li> <p> <i>VALUE</i> - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.</p> </li> <li> <p> <i>CHILD</i> - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.</p> </li> <li> <p> <i>MERGED_CELL</i> - A list of IDs that identify each of the MERGED_CELL block types in a table.</p> </li> <li> <p> <i>ANSWER</i> - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block. </p> </li> <li> <p> <i>TABLE</i> - A list of IDs that identify associated TABLE block types. </p> </li> <li> <p> <i>TABLE_TITLE</i> - A list that contains the ID for the TABLE_TITLE block type in a table. </p> </li> <li> <p> <i>TABLE_FOOTER</i> - A list of IDs that identify the TABLE_FOOTER block types in a table. </p> </li> </ul>"""
    ids: NotRequired["capo_textract.types.id_list.IdList"]
    """<p>An array of IDs for related blocks. You can get the type of the relationship from the <code>Type</code> element.</p>"""

ids instance-attribute

ids: NotRequired[IdList]

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

type instance-attribute

type: NotRequired[RelationshipType]

The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned.

  • VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair.

  • CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type.

  • MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table.

  • ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with the corresponding QUERY block.

  • TABLE - A list of IDs that identify associated TABLE block types.

  • TABLE_TITLE - A list that contains the ID for the TABLE_TITLE block type in a table.

  • TABLE_FOOTER - A list of IDs that identify the TABLE_FOOTER block types in a table.