DeepchecksLLMClient.data_iterator#
- DeepchecksLLMClient.data_iterator(app_name: str, version_name: str, env_type: EnvType | str, start_time: datetime | int | None = None, end_time: datetime | int | None = None, user_interaction_ids: List[str] | None = None, include_incomplete: bool = False) Iterable[Interaction]#
Fetch all interactions from the specified environment type (PROD/EVAL) as an iterable.
Supports pagination, so this API is suitable for iterating over large amounts of data.
- Parameters:
- app_namestr
Application name
- version_namestr
Name of application version
- env_typeEnvType | str
The environment type from which to fetch interactions. This can be either “PROD” or “EVAL”.
- start_timedatetime | int | None, optional
The start time from which to fetch interactions. This can be a datetime object or an integer. If not provided, interactions will be fetched from the beginning.
- end_timedatetime | int | None, optional
The end time until which to fetch interactions. This can be a datetime object or an integer. If not provided, interactions will be fetched up to the most recent.
- user_interaction_ids: list | None, optional
user interactions ids to include into the list of interactions.annotation_reason
- include_incompletebool
Return only interactions with completed status or not. Only completed are returned by default.
- Returns:
- Iterable[Interaction]
An iterable collection of interactions.