DeepchecksLLMClient.update_interaction

DeepchecksLLMClient.update_interaction(app_name: str, version_name: str, user_interaction_id: str, annotation: AnnotationType | str | None = None, annotation_reason: str | None = None, user_value_properties: List[UserValueProperty] | None = None, steps: List[Step] = None, information_retrieval: List[str] | str = None, input: str | None = None, output: str | None = None, expected_output: str | None = None, action: str | None = None, tool_response: str | None = None, full_prompt: str = None, history: List[str] | str = None, is_completed: bool | None = None, started_at: datetime | float = None, finished_at: datetime | float = None, metadata: Dict[str, str] | None = None, tokens: int | None = None)

Update a specific interaction by its user_interaction_id.

Parameters:

app_namestr

Application name

version_name

Name of the version to which this interaction belongs

user_interaction_id

Unique id of the interaction to update

annotationAnnotationType or str

Could be one of AnnotationType or ‘good’, ‘bad’, ‘unknown’

annotation_reason: str

String that explains the reason for the annotation

user_value_properties: list of UserValueProperty

List of user value properties for interaction

steps: list of Step

List of steps taken during the interaction. New steps will be added to existing ones for previously incomplete interactions. Cannot be changed for completed interactions

information_retrievalstr or list of str

Information retrieval. New data will be added to existing ones for previously incomplete interactions. Cannot be changed for completed interactions

input: str or None

Input data. Old value will be overridden by the new value. Note that once interactions are marked as completed, this value cannot be changed.

output: str or None

Output data. Old value will be overridden by the new value. It cannot be modified for completed interactions.

expected_output: str or None

Expected output data. Old value will be overridden by the new value. It cannot be modified for completed interactions.

action: str or None

Action data. Old value will be overridden by the new value. It cannot be modified for completed interactions.

tool_response: str or None

Tool Response data. Old value will be overridden by the new value. It cannot be modified for completed interactions.

full_prompt: str or None

Full prompt data. Old value will be overridden by the new value. It cannot be modified for completed interactions.

history: str or list of str

History. New data will be added to existing ones for previously incomplete interactions. Cannot be changed for completed interactions

is_completed: bool or None.

Completed interactions will be shown in the system, and cannot be further modified except for annotations, topics and user value properties. Interaction completeness status will be not changed if None is sent

started_atdatetime or float

Timestamp the interaction started_at at. Datetime format is deprecated, use timestamp instead

finished_atdatetime or float

Timestamp the interaction finished at. Datetime format is deprecated, use timestamp instead

metadata: Dict[str, str], optional

Metdata for the interaction.

tokens: int, optional

Token count for the interaction.

Returns

——-

None