nemo_microservices.types.intake.user_rating_param#

Module Contents#

Classes#

API#

class nemo_microservices.types.intake.user_rating_param.UserRatingParam#

Bases: typing_extensions.TypedDict

categories: Dict[str, Union[float, str]]#

None

Application-specific category ratings as key-value pairs.

Use this for custom rating dimensions (e.g., {‘helpfulness’: 4, ‘accuracy’: 5, ‘tone’: ‘professional’}). Useful for radio buttons, dropdowns, or multi-dimensional rating systems.

chosen_index: int#

None

Zero-based index of the response option the user selected when multiple responses were returned. Use this when showing users multiple completion choices and tracking which one they picked.

opinion: str#

None

Free-text comment from the end user describing their opinion of the response.

rating: float#

None

Numeric rating (e.g., 1-5 stars) provided by the end user.

Mutually exclusive with thumb. Use this for star ratings or numeric scales.

rewrite: str#

None

End-user’s suggested text replacement for the generated response.

This is the user’s idea of what the response should have been.

thumb: nemo_microservices.types.intake.thumb_direction.ThumbDirection#

None

Possible thumb feedback choices.