Skip to content

TopicNamedEntity

Source code in docs_src/capo_quicksight/types/topic_named_entity.py
class TopicNamedEntity(TypedDict, closed=True):
    entity_name: "capo_quicksight.types.limited_string.LimitedString"
    """<p>The name of the named entity.</p>"""
    entity_description: NotRequired[
        "capo_quicksight.types.description_sensitive_string.DescriptionSensitiveString"
    ]
    """<p>The description of the named entity.</p>"""
    entity_synonyms: NotRequired["capo_quicksight.types.synonyms.Synonyms"]
    """<p>The other names or aliases for the named entity.</p>"""
    semantic_entity_type: NotRequired[
        "capo_quicksight.types.semantic_entity_type.SemanticEntityType"
    ]
    """<p>The type of named entity that a topic represents.</p>"""
    definition: NotRequired[
        "capo_quicksight.types.named_entity_definitions.NamedEntityDefinitions"
    ]
    """<p>The definition of a named entity.</p>"""
    sort: NotRequired[
        "capo_quicksight.types.named_entity_sort_list.NamedEntitySortList"
    ]
    """<p>The sort configuration of the named entity.</p>"""
    rank_order: NotRequired["capo_quicksight.types.nullable_integer.NullableInteger"]
    """<p>The rank order of the named entity.</p>"""
    presentation_order: NotRequired[
        "capo_quicksight.types.nullable_integer.NullableInteger"
    ]
    """<p>The presentation order of the named entity.</p>"""

definition instance-attribute

definition: NotRequired[NamedEntityDefinitions]

The definition of a named entity.

entity_description instance-attribute

entity_description: NotRequired[DescriptionSensitiveString]

The description of the named entity.

entity_name instance-attribute

entity_name: LimitedString

The name of the named entity.

entity_synonyms instance-attribute

entity_synonyms: NotRequired[Synonyms]

The other names or aliases for the named entity.

presentation_order instance-attribute

presentation_order: NotRequired[NullableInteger]

The presentation order of the named entity.

rank_order instance-attribute

rank_order: NotRequired[NullableInteger]

The rank order of the named entity.

semantic_entity_type instance-attribute

semantic_entity_type: NotRequired[SemanticEntityType]

The type of named entity that a topic represents.

sort instance-attribute

sort: NotRequired[NamedEntitySortList]

The sort configuration of the named entity.