docs: add required id field to event payloads and update test examples

Co-Authored-By: Alex Reibman <[email protected]>
AgentOps-AI · Dec 19, 2024 · ad98c3b · ad98c3b
1 parent b708200
commit ad98c3b
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 3 deletions.
diff --git a/docs/v1/integrations/rest.mdx b/docs/v1/integrations/rest.mdx
@@ -297,6 +297,7 @@ curl -X POST https://api.agentops.ai/v2/create_events \
   -d '{
     "events": [
       {
+        "id": "550e8400-e29b-41d4-a716-446655440001",
         "event_type": "llm",
         "init_timestamp": "2024-03-14T12:01:00Z",
         "end_timestamp": "2024-03-14T12:01:02Z",
@@ -314,6 +315,7 @@ curl -X POST https://api.agentops.ai/v2/create_events \
         "completion_tokens": 80
       },
       {
+        "id": "550e8400-e29b-41d4-a716-446655440002",
         "event_type": "tool",
         "name": "database_query",
         "init_timestamp": "2024-03-14T12:01:03Z",
@@ -324,6 +326,7 @@ curl -X POST https://api.agentops.ai/v2/create_events \
     ]
   }'
 ```
+</CodeGroup>
 
 ```bash Request
 POST https://api.agentops.ai/v2/create_events
@@ -333,6 +336,7 @@ Authorization: Bearer your_jwt_token
 {
   "events": [
     {
+      "id": "550e8400-e29b-41d4-a716-446655440001",
       "event_type": "llm",
       "init_timestamp": "2024-03-14T12:01:00Z",
       "end_timestamp": "2024-03-14T12:01:02Z",
@@ -350,6 +354,7 @@ Authorization: Bearer your_jwt_token
       "completion_tokens": 80
     },
     {
+      "id": "550e8400-e29b-41d4-a716-446655440002",
       "event_type": "tool",
       "name": "database_query",
       "init_timestamp": "2024-03-14T12:01:03Z",
@@ -359,8 +364,6 @@ Authorization: Bearer your_jwt_token
     }
   ]
 }
-```
-</CodeGroup>
 
 ### Update Events
 
@@ -499,6 +502,7 @@ event_response = requests.post(
     headers=event_headers,
     json={
         "events": [{
+            "id": str(uuid.uuid4()),  # Required field for actions table
             "event_type": "llm",
             "init_timestamp": datetime.now(timezone.utc).isoformat(),
             "end_timestamp": datetime.now(timezone.utc).isoformat(),

diff --git a/tests/test_rest_api.py b/tests/test_rest_api.py
@@ -66,7 +66,34 @@ def test_create_events(self) -> bool:
 
         payload = {
             "events": [
-                {"event_type": "test", "session_id": self.session_id, "init_timestamp": now, "end_timestamp": now}
+                {
+                    "id": str(uuid.uuid4()),
+                    "event_type": "llm",
+                    "init_timestamp": now,
+                    "end_timestamp": now,
+                    "session_id": self.session_id,
+                    "model": "gpt-4",
+                    "prompt": [
+                        {"role": "system", "content": "You are a helpful assistant"},
+                        {"role": "user", "content": "Analyze this data..."}
+                    ],
+                    "completion": {
+                        "role": "assistant",
+                        "content": "Based on the data..."
+                    },
+                    "prompt_tokens": 150,
+                    "completion_tokens": 80
+                },
+                {
+                    "id": str(uuid.uuid4()),
+                    "event_type": "tool",
+                    "name": "database_query",
+                    "init_timestamp": now,
+                    "end_timestamp": now,
+                    "session_id": self.session_id,
+                    "input": "SELECT * FROM users",
+                    "output": "Retrieved 5 users"
+                }
             ]
         }