Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding support for screenshots and video #55

Merged
merged 5 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions agentops/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,19 +245,22 @@ def start_session(self, tags: Optional[List[str]] = None):
self.worker.start_session(self.session)

def end_session(self, end_state: str = Field("Indeterminate",
description="End state of the session",
pattern="^(Success|Fail|Indeterminate)$"),
rating: Optional[str] = None):
description="End state of the session",
pattern="^(Success|Fail|Indeterminate)$"),
rating: Optional[str] = None,
video: Optional[str] = None):
"""
End the current session with the AgentOps service.

Args:
end_state (str, optional): The final state of the session.
rating (str, optional): The rating for the session.
video (str, optional): The video screen recording of the session
"""
if not self.session.has_ended:
self.session.end_session(end_state, rating)
self.worker.end_session(self.session)
self.session.video = video
else:
logging.info("Warning: The session has already been ended.")

Expand Down
10 changes: 6 additions & 4 deletions agentops/event.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
from typing import Optional, List
from pydantic import Field


class Event:
"""
Represents a discrete event to be recorded.
Expand All @@ -18,7 +17,7 @@ class Event:
params (str, optional): The parameters passed to the operation.
returns (str, optional): The output of the operation.
result (str, optional): Result of the operation, e.g., "Success", "Fail", "Indeterminate". Defaults to "Indeterminate".
action_type (str, optional): Type of action of the event e.g. 'action', 'llm', 'api'. Defaults to 'action'.
action_type (str, optional): Type of action of the event e.g. 'action', 'llm', 'api', 'screenshot'. Defaults to 'action'.
model (Models, optional): The model used during the event if an LLM is used (i.e. GPT-4).
For models, see the types available in the Models enum.
If a model is set but an action_type is not, the action_type will be coerced to 'llm'.
Expand All @@ -27,6 +26,7 @@ class Event:
tags (List[str], optional): Tags that can be used for grouping or sorting later. e.g. ["my_tag"]. Defaults to None.
init_timestamp (float, optional): The timestamp for when the event was initiated, represented as seconds since the epoch.
Defaults to the end timestamp.
screenshot (str, optional): A screenshot of the webpage at the time of the event. Base64 string or URL. Defaults to None.

Attributes:
event_type (str): Type of the event.
Expand All @@ -49,11 +49,12 @@ def __init__(self, event_type: str,
pattern="^(Success|Fail|Indeterminate)$"),
action_type: Optional[str] = Field("action",
description="Type of action that the user is recording",
pattern="^(action|api|llm)$"),
pattern="^(action|api|llm|screenshot)$"),
model: Optional[Models] = None,
prompt: Optional[str] = None,
tags: Optional[List[str]] = None,
init_timestamp: Optional[float] = None
init_timestamp: Optional[float] = None,
screenshot: Optional[str] = None
):
self.event_type = event_type
self.params = params
Expand All @@ -65,3 +66,4 @@ def __init__(self, event_type: str,
self.prompt = prompt
self.end_timestamp = get_ISO_time()
self.init_timestamp = init_timestamp if init_timestamp else self.end_timestamp
self.screenshot = screenshot