nemo_microservices.types.intake.user_action_event_param#
Module Contents#
Classes#
API#
- class nemo_microservices.types.intake.user_action_event_param.UserActionEventParam#
Bases:
typing_extensions.TypedDict- action: typing_extensions.Required[str]#
None
Descriptive name for the action taken by the user (e.g., ‘share_clicked’, ‘code_copied’, ‘link_followed’). Use snake-case or kebab-case. This is a label, not a unique identifier—multiple events can have the same action name.
- created_at: typing_extensions.Annotated[Union[str, datetime.datetime], PropertyInfo(format='iso8601')]#
None
UTC timestamp when the record was created.
- created_by: Dict[str, str]#
None
Identifier of the user or system that generated the record.
Can be set of key-value pairs.
- event_type: typing_extensions.Literal[user_action]#
None
- id: str#
None
Unique identifier for the event. Populated when retrieved from database.
- metadata: Dict[str, Union[str, nemo_microservices._types.SequenceNotStr[str], bool, float]]#
None
Optional key-value pairs with additional context about the action (max 16 entries). Use this for details like user IDs, item IDs, timestamps, A/B test variants, or any other information useful for downstream training or evaluation pipelines. Example: {‘user_id’: ‘12345’, ‘experiment’: ‘variant_b’, ‘item_purchased’: ‘product_456’}.