|
| 1 | +"""EvaluationClient for collecting spans and running evaluations.""" |
| 2 | + |
| 3 | +import logging |
| 4 | +from datetime import datetime, timedelta, timezone |
| 5 | +from typing import Any, Dict, List, Optional |
| 6 | + |
| 7 | +import boto3 |
| 8 | +from botocore.config import Config |
| 9 | + |
| 10 | +from bedrock_agentcore._utils.user_agent import build_user_agent_suffix |
| 11 | +from bedrock_agentcore.evaluation._agent_span_collector import CloudWatchAgentSpanCollector |
| 12 | + |
| 13 | +logger = logging.getLogger(__name__) |
| 14 | + |
| 15 | +MAX_TARGET_IDS_PER_REQUEST = 10 |
| 16 | +QUERY_TIMEOUT_SECONDS = 60 |
| 17 | +POLL_INTERVAL_SECONDS = 2 |
| 18 | + |
| 19 | + |
| 20 | +class EvaluationClient: |
| 21 | + """Client for evaluating agent sessions. |
| 22 | +
|
| 23 | + Collects spans from CloudWatch and calls the evaluation API with |
| 24 | + level-aware batching. |
| 25 | +
|
| 26 | + Example:: |
| 27 | +
|
| 28 | + client = EvaluationClient(region_name="us-west-2") |
| 29 | +
|
| 30 | + # Using agent_id (log group derived automatically) |
| 31 | + results = client.run( |
| 32 | + evaluator_ids=["accuracy", "toxicity"], |
| 33 | + session_id="sess-123", |
| 34 | + agent_id="my-agent", |
| 35 | + ) |
| 36 | +
|
| 37 | + # Using log_group_name directly |
| 38 | + results = client.run( |
| 39 | + evaluator_ids=["accuracy", "toxicity"], |
| 40 | + session_id="sess-123", |
| 41 | + log_group_name="/custom/my-log-group", |
| 42 | + ) |
| 43 | +
|
| 44 | + for r in results: |
| 45 | + print(f"{r['evaluatorId']}: {r.get('value')} - {r.get('explanation')}") |
| 46 | + """ |
| 47 | + |
| 48 | + def __init__( |
| 49 | + self, |
| 50 | + region_name: Optional[str] = None, |
| 51 | + integration_source: Optional[str] = None, |
| 52 | + ): |
| 53 | + """Initialize the EvaluationClient. |
| 54 | +
|
| 55 | + Args: |
| 56 | + region_name: AWS region. Falls back to boto3 session region or us-west-2. |
| 57 | + integration_source: Optional integration framework identifier for telemetry. |
| 58 | + """ |
| 59 | + self.region_name = region_name or boto3.Session().region_name or "us-west-2" |
| 60 | + self.integration_source = integration_source |
| 61 | + |
| 62 | + user_agent_extra = build_user_agent_suffix(integration_source) |
| 63 | + client_config = Config(user_agent_extra=user_agent_extra) |
| 64 | + |
| 65 | + self._dp_client = boto3.client( |
| 66 | + "bedrock-agentcore", |
| 67 | + region_name=self.region_name, |
| 68 | + config=client_config, |
| 69 | + ) |
| 70 | + self._cp_client = boto3.client( |
| 71 | + "bedrock-agentcore-control", |
| 72 | + region_name=self.region_name, |
| 73 | + config=client_config, |
| 74 | + ) |
| 75 | + self._evaluator_level_cache: Dict[str, str] = {} |
| 76 | + |
| 77 | + logger.info("Initialized EvaluationClient in region %s", self.region_name) |
| 78 | + |
| 79 | + def run( |
| 80 | + self, |
| 81 | + evaluator_ids: List[str], |
| 82 | + session_id: str, |
| 83 | + agent_id: Optional[str] = None, |
| 84 | + look_back_time: timedelta = timedelta(days=7), |
| 85 | + log_group_name: Optional[str] = None, |
| 86 | + ) -> List[Dict[str, Any]]: |
| 87 | + """Evaluate an agent session end-to-end. |
| 88 | +
|
| 89 | + 1. Collects spans from CloudWatch. |
| 90 | + 2. For each evaluator, looks up its level (SESSION/TRACE/TOOL_CALL). |
| 91 | + 3. Builds the appropriate evaluationTarget based on level. |
| 92 | + 4. Calls evaluate() with auto-batching (max 10 target IDs per request). |
| 93 | + 5. Returns combined evaluationResults from all evaluators. |
| 94 | +
|
| 95 | + Either ``agent_id`` or ``log_group_name`` must be provided. |
| 96 | + When only ``agent_id`` is given, the log group name is derived as |
| 97 | + ``/aws/bedrock-agentcore/runtimes/{agent_id}-DEFAULT``. |
| 98 | +
|
| 99 | + Args: |
| 100 | + evaluator_ids: List of evaluator IDs (built-in or custom ARNs). |
| 101 | + session_id: The session ID to evaluate. |
| 102 | + agent_id: The agent ID. Used to derive the log group when |
| 103 | + ``log_group_name`` is not provided. |
| 104 | + look_back_time: How far back to search for spans (default: 7 days). |
| 105 | + log_group_name: CloudWatch log group name. If provided, ``agent_id`` |
| 106 | + is not required. |
| 107 | +
|
| 108 | + Returns: |
| 109 | + List of evaluation result dicts from all evaluators. |
| 110 | +
|
| 111 | + Raises: |
| 112 | + ValueError: If neither ``agent_id`` nor ``log_group_name`` is provided. |
| 113 | + """ |
| 114 | + if not agent_id and not log_group_name: |
| 115 | + raise ValueError("Provide either agent_id or log_group_name.") |
| 116 | + |
| 117 | + if not log_group_name: |
| 118 | + log_group_name = f"/aws/bedrock-agentcore/runtimes/{agent_id}-DEFAULT" |
| 119 | + logger.debug("Derived log_group_name=%s from agent_id=%s", log_group_name, agent_id) |
| 120 | + |
| 121 | + end_time = datetime.now(timezone.utc) |
| 122 | + start_time = end_time - look_back_time |
| 123 | + |
| 124 | + logger.info( |
| 125 | + "Running evaluation for session=%s, log_group=%s, time_range=[%s, %s]", |
| 126 | + session_id, |
| 127 | + log_group_name, |
| 128 | + start_time, |
| 129 | + end_time, |
| 130 | + ) |
| 131 | + |
| 132 | + # Step 1: Collect spans |
| 133 | + collector = CloudWatchAgentSpanCollector( |
| 134 | + log_group_name=log_group_name, |
| 135 | + region=self.region_name, |
| 136 | + max_wait_seconds=QUERY_TIMEOUT_SECONDS, |
| 137 | + poll_interval_seconds=POLL_INTERVAL_SECONDS, |
| 138 | + ) |
| 139 | + spans = collector.collect( |
| 140 | + session_id=session_id, |
| 141 | + start_time=start_time, |
| 142 | + end_time=end_time, |
| 143 | + ) |
| 144 | + |
| 145 | + if not spans: |
| 146 | + logger.warning("No spans found for session %s", session_id) |
| 147 | + return [] |
| 148 | + |
| 149 | + base_input = {"evaluationInput": {"sessionSpans": spans}} |
| 150 | + |
| 151 | + # Steps 2-4: For each evaluator, look up level, build targets, call API |
| 152 | + all_results = [] |
| 153 | + for evaluator_id in evaluator_ids: |
| 154 | + level = self._get_evaluator_level(evaluator_id) |
| 155 | + logger.info("Evaluating with %s (level=%s)", evaluator_id, level) |
| 156 | + requests = self._build_requests_for_level(evaluator_id, level, base_input, spans) |
| 157 | + if len(requests) > 1: |
| 158 | + logger.debug("Split into %d batched request(s) for evaluator %s", len(requests), evaluator_id) |
| 159 | + for request in requests: |
| 160 | + response = self._dp_client.evaluate(evaluatorId=evaluator_id, **request) |
| 161 | + all_results.extend(response.get("evaluationResults", [])) |
| 162 | + |
| 163 | + logger.info( |
| 164 | + "Evaluation complete: %d result(s) from %d evaluator(s)", |
| 165 | + len(all_results), |
| 166 | + len(evaluator_ids), |
| 167 | + ) |
| 168 | + return all_results |
| 169 | + |
| 170 | + def _get_evaluator_level(self, evaluator_id: str) -> str: |
| 171 | + """Look up evaluator level with caching. Falls back to SESSION.""" |
| 172 | + if evaluator_id not in self._evaluator_level_cache: |
| 173 | + try: |
| 174 | + response = self._cp_client.get_evaluator(evaluatorId=evaluator_id) |
| 175 | + self._evaluator_level_cache[evaluator_id] = response["level"] |
| 176 | + except Exception as e: |
| 177 | + logger.warning( |
| 178 | + "Failed to get level for %s, defaulting to SESSION: %s", |
| 179 | + evaluator_id, |
| 180 | + e, |
| 181 | + ) |
| 182 | + self._evaluator_level_cache[evaluator_id] = "SESSION" |
| 183 | + return self._evaluator_level_cache[evaluator_id] |
| 184 | + |
| 185 | + def _build_requests_for_level( |
| 186 | + self, |
| 187 | + evaluator_id: str, |
| 188 | + level: str, |
| 189 | + base_input: dict, |
| 190 | + spans: list, |
| 191 | + ) -> List[dict]: |
| 192 | + """Build one or more evaluate request payloads based on evaluator level.""" |
| 193 | + if level == "SESSION": |
| 194 | + return [base_input] |
| 195 | + |
| 196 | + if level == "TRACE": |
| 197 | + trace_ids = self._extract_trace_ids(spans) |
| 198 | + logger.debug("Extracted %d unique trace ID(s) for evaluator %s", len(trace_ids), evaluator_id) |
| 199 | + if not trace_ids: |
| 200 | + raise ValueError(f"No trace IDs found for trace-level evaluator {evaluator_id}") |
| 201 | + return [ |
| 202 | + {**base_input, "evaluationTarget": {"traceIds": trace_ids[i : i + MAX_TARGET_IDS_PER_REQUEST]}} |
| 203 | + for i in range(0, len(trace_ids), MAX_TARGET_IDS_PER_REQUEST) |
| 204 | + ] |
| 205 | + |
| 206 | + if level == "TOOL_CALL": |
| 207 | + tool_span_ids = self._extract_tool_span_ids(spans) |
| 208 | + logger.debug("Extracted %d tool span ID(s) for evaluator %s", len(tool_span_ids), evaluator_id) |
| 209 | + if not tool_span_ids: |
| 210 | + raise ValueError(f"No tool span IDs found for tool-level evaluator {evaluator_id}") |
| 211 | + return [ |
| 212 | + {**base_input, "evaluationTarget": {"spanIds": tool_span_ids[i : i + MAX_TARGET_IDS_PER_REQUEST]}} |
| 213 | + for i in range(0, len(tool_span_ids), MAX_TARGET_IDS_PER_REQUEST) |
| 214 | + ] |
| 215 | + |
| 216 | + raise ValueError(f"Unknown evaluator level: {level}") |
| 217 | + |
| 218 | + @staticmethod |
| 219 | + def _extract_trace_ids(spans: list) -> List[str]: |
| 220 | + """Extract unique trace IDs from spans, ordered by appearance.""" |
| 221 | + return list(dict.fromkeys(span.get("traceId") for span in spans if span.get("traceId"))) |
| 222 | + |
| 223 | + @staticmethod |
| 224 | + def _extract_tool_span_ids(spans: list) -> List[str]: |
| 225 | + """Extract span IDs for tool execution spans.""" |
| 226 | + tool_span_ids: List[str] = [] |
| 227 | + for span in spans: |
| 228 | + name = span.get("name", "") |
| 229 | + kind = span.get("kind") |
| 230 | + if kind == "SPAN_KIND_INTERNAL" and name.startswith("Tool:"): |
| 231 | + span_id = span.get("spanId") |
| 232 | + if span_id: |
| 233 | + tool_span_ids.append(span_id) |
| 234 | + return tool_span_ids |
0 commit comments