nemo_microservices.types.intake.reviewer_annotation_event

Module Contents

Classes

ReviewerAnnotationEvent

API

class nemo_microservices.types.intake.reviewer_annotation_event.ReviewerAnnotationEvent(/, **data: typing.Any)

Bases: nemo_microservices._models.BaseModel

categories: Optional[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: Optional[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.

created_at: Optional[datetime.datetime]

None

UTC timestamp when the record was created.

created_by: Optional[Dict[str, str]]

None

Identifier of the user or system that generated the record.

Can be set of key-value pairs.

event_type: Optional[typing_extensions.Literal[reviewer_annotation]]

None

id: Optional[str]

None

Unique identifier for the event. Populated when retrieved from database.

opinion: Optional[str]

None

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

rating: Optional[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.

response_override: Optional[Dict[str, object]]

None

Complete JSON object that replaces the original model response when exporting data. Unlike the rewrite field (which is just text), this can include tool calls, function outputs, and all other response metadata. When an entry with response_override is exported, you can choose to use this corrected response instead of the original. Example: {‘choices’: [{‘message’: {‘role’: ‘assistant’, ‘content’: ‘Corrected text’, ‘tool_calls’: […]}}]}

rewrite: Optional[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: Optional[nemo_microservices.types.intake.thumb_direction.ThumbDirection]

None

Possible thumb feedback choices.