Skip to content

CustomVocabularyItem

Source code in docs_src/capo_lex_models_v2/types/custom_vocabulary_item.py
class CustomVocabularyItem(TypedDict, closed=True):
    item_id: "capo_lex_models_v2.types.item_id.ItemId"
    """<p>The unique item identifer for the custom vocabulary item from the custom vocabulary list.</p>"""
    phrase: "capo_lex_models_v2.types.phrase.Phrase"
    """<p>The unique phrase for the custom vocabulary item from the custom vocabulary list.</p>"""
    weight: NotRequired["capo_lex_models_v2.types.weight.Weight"]
    """<p>The weight assigned for the custom vocabulary item from the custom vocabulary list.</p>"""
    display_as: NotRequired["capo_lex_models_v2.types.phrase.Phrase"]
    """<p>The DisplayAs value for the custom vocabulary item from the custom vocabulary list.</p>"""

display_as instance-attribute

display_as: NotRequired[Phrase]

The DisplayAs value for the custom vocabulary item from the custom vocabulary list.

item_id instance-attribute

item_id: ItemId

The unique item identifer for the custom vocabulary item from the custom vocabulary list.

phrase instance-attribute

phrase: Phrase

The unique phrase for the custom vocabulary item from the custom vocabulary list.

weight instance-attribute

weight: NotRequired[Weight]

The weight assigned for the custom vocabulary item from the custom vocabulary list.