forked from strands-agents/sdk-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbedrock.py
More file actions
805 lines (682 loc) · 33.3 KB
/
bedrock.py
File metadata and controls
805 lines (682 loc) · 33.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
"""AWS Bedrock model provider.
- Docs: https://aws.amazon.com/bedrock/
"""
import asyncio
import json
import logging
import os
import warnings
from typing import Any, AsyncGenerator, Callable, Iterable, Literal, Optional, Type, TypeVar, Union, cast
import boto3
from botocore.config import Config as BotocoreConfig
from botocore.exceptions import ClientError
from pydantic import BaseModel
from typing_extensions import TypedDict, Unpack, override
from ..event_loop import streaming
from ..tools import convert_pydantic_to_tool_spec
from ..types.content import ContentBlock, Message, Messages
from ..types.exceptions import (
ContextWindowOverflowException,
ModelThrottledException,
)
from ..types.streaming import CitationsDelta, StreamEvent
from ..types.tools import ToolResult, ToolSpec
from ._config_validation import validate_config_keys
from .model import Model
logger = logging.getLogger(__name__)
DEFAULT_BEDROCK_MODEL_ID = "{}.anthropic.claude-sonnet-4-20250514-v1:0"
DEFAULT_BEDROCK_REGION = "us-west-2"
BEDROCK_CONTEXT_WINDOW_OVERFLOW_MESSAGES = [
"Input is too long for requested model",
"input length and `max_tokens` exceed context limit",
"too many total text bytes",
]
# Models that should include tool result status (include_tool_result_status = True)
_MODELS_INCLUDE_STATUS = [
"anthropic.claude",
]
T = TypeVar("T", bound=BaseModel)
DEFAULT_READ_TIMEOUT = 120
class BedrockModel(Model):
"""AWS Bedrock model provider implementation.
The implementation handles Bedrock-specific features such as:
- Tool configuration for function calling
- Guardrails integration
- Caching points for system prompts and tools
- Streaming responses
- Context window overflow detection
"""
class BedrockConfig(TypedDict, total=False):
"""Configuration options for Bedrock models.
Attributes:
additional_args: Any additional arguments to include in the request
additional_request_fields: Additional fields to include in the Bedrock request
additional_response_field_paths: Additional response field paths to extract
cache_prompt: Cache point type for the system prompt
cache_tools: Cache point type for tools
guardrail_id: ID of the guardrail to apply
guardrail_trace: Guardrail trace mode. Defaults to enabled.
guardrail_version: Version of the guardrail to apply
guardrail_stream_processing_mode: The guardrail processing mode
guardrail_redact_input: Flag to redact input if a guardrail is triggered. Defaults to True.
guardrail_redact_input_message: If a Bedrock Input guardrail triggers, replace the input with this message.
guardrail_redact_output: Flag to redact output if guardrail is triggered. Defaults to False.
guardrail_redact_output_message: If a Bedrock Output guardrail triggers, replace output with this message.
max_tokens: Maximum number of tokens to generate in the response
model_id: The Bedrock model ID (e.g., "us.anthropic.claude-sonnet-4-20250514-v1:0")
include_tool_result_status: Flag to include status field in tool results.
True includes status, False removes status, "auto" determines based on model_id. Defaults to "auto".
stop_sequences: List of sequences that will stop generation when encountered
streaming: Flag to enable/disable streaming. Defaults to True.
temperature: Controls randomness in generation (higher = more random)
top_p: Controls diversity via nucleus sampling (alternative to temperature)
"""
additional_args: Optional[dict[str, Any]]
additional_request_fields: Optional[dict[str, Any]]
additional_response_field_paths: Optional[list[str]]
cache_prompt: Optional[str]
cache_tools: Optional[str]
guardrail_id: Optional[str]
guardrail_trace: Optional[Literal["enabled", "disabled", "enabled_full"]]
guardrail_stream_processing_mode: Optional[Literal["sync", "async"]]
guardrail_version: Optional[str]
guardrail_redact_input: Optional[bool]
guardrail_redact_input_message: Optional[str]
guardrail_redact_output: Optional[bool]
guardrail_redact_output_message: Optional[str]
max_tokens: Optional[int]
model_id: str
include_tool_result_status: Optional[Literal["auto"] | bool]
stop_sequences: Optional[list[str]]
streaming: Optional[bool]
temperature: Optional[float]
top_p: Optional[float]
def __init__(
self,
*,
boto_session: Optional[boto3.Session] = None,
boto_client_config: Optional[BotocoreConfig] = None,
region_name: Optional[str] = None,
endpoint_url: Optional[str] = None,
**model_config: Unpack[BedrockConfig],
):
"""Initialize provider instance.
Args:
boto_session: Boto Session to use when calling the Bedrock Model.
boto_client_config: Configuration to use when creating the Bedrock-Runtime Boto Client.
region_name: AWS region to use for the Bedrock service.
Defaults to the AWS_REGION environment variable if set, or "us-west-2" if not set.
endpoint_url: Custom endpoint URL for VPC endpoints (PrivateLink)
**model_config: Configuration options for the Bedrock model.
"""
if region_name and boto_session:
raise ValueError("Cannot specify both `region_name` and `boto_session`.")
session = boto_session or boto3.Session()
resolved_region = region_name or session.region_name or os.environ.get("AWS_REGION") or DEFAULT_BEDROCK_REGION
self.config = BedrockModel.BedrockConfig(
model_id=DEFAULT_BEDROCK_MODEL_ID.format(
BedrockModel.get_model_prefix_with_warning(resolved_region, model_config)
),
include_tool_result_status="auto",
)
self.update_config(**model_config)
logger.debug("config=<%s> | initializing", self.config)
# Add strands-agents to the request user agent
if boto_client_config:
existing_user_agent = getattr(boto_client_config, "user_agent_extra", None)
# Append 'strands-agents' to existing user_agent_extra or set it if not present
if existing_user_agent:
new_user_agent = f"{existing_user_agent} strands-agents"
else:
new_user_agent = "strands-agents"
client_config = boto_client_config.merge(BotocoreConfig(user_agent_extra=new_user_agent))
else:
client_config = BotocoreConfig(user_agent_extra="strands-agents", read_timeout=DEFAULT_READ_TIMEOUT)
self.client = session.client(
service_name="bedrock-runtime",
config=client_config,
endpoint_url=endpoint_url,
region_name=resolved_region,
)
logger.debug("region=<%s> | bedrock client created", self.client.meta.region_name)
@override
def update_config(self, **model_config: Unpack[BedrockConfig]) -> None: # type: ignore
"""Update the Bedrock Model configuration with the provided arguments.
Args:
**model_config: Configuration overrides.
"""
validate_config_keys(model_config, self.BedrockConfig)
self.config.update(model_config)
@override
def get_config(self) -> BedrockConfig:
"""Get the current Bedrock Model configuration.
Returns:
The Bedrock model configuration.
"""
return self.config
def _should_include_tool_result_status(self) -> bool:
"""Determine whether to include tool result status based on current config."""
include_status = self.config.get("include_tool_result_status", "auto")
if include_status is True:
return True
elif include_status is False:
return False
else: # "auto"
return any(model in self.config["model_id"] for model in _MODELS_INCLUDE_STATUS)
def format_request(
self,
messages: Messages,
tool_specs: Optional[list[ToolSpec]] = None,
system_prompt: Optional[str] = None,
) -> dict[str, Any]:
"""Format a Bedrock converse stream request.
Args:
messages: List of message objects to be processed by the model.
tool_specs: List of tool specifications to make available to the model.
system_prompt: System prompt to provide context to the model.
Returns:
A Bedrock converse stream request.
"""
return {
"modelId": self.config["model_id"],
"messages": self._format_bedrock_messages(messages),
"system": [
*([{"text": system_prompt}] if system_prompt else []),
*([{"cachePoint": {"type": self.config["cache_prompt"]}}] if self.config.get("cache_prompt") else []),
],
**(
{
"toolConfig": {
"tools": [
*[{"toolSpec": tool_spec} for tool_spec in tool_specs],
*(
[{"cachePoint": {"type": self.config["cache_tools"]}}]
if self.config.get("cache_tools")
else []
),
],
"toolChoice": {"auto": {}},
}
}
if tool_specs
else {}
),
**(
{"additionalModelRequestFields": self.config["additional_request_fields"]}
if self.config.get("additional_request_fields")
else {}
),
**(
{"additionalModelResponseFieldPaths": self.config["additional_response_field_paths"]}
if self.config.get("additional_response_field_paths")
else {}
),
**(
{
"guardrailConfig": {
"guardrailIdentifier": self.config["guardrail_id"],
"guardrailVersion": self.config["guardrail_version"],
"trace": self.config.get("guardrail_trace", "enabled"),
**(
{"streamProcessingMode": self.config.get("guardrail_stream_processing_mode")}
if self.config.get("guardrail_stream_processing_mode")
else {}
),
}
}
if self.config.get("guardrail_id") and self.config.get("guardrail_version")
else {}
),
"inferenceConfig": {
key: value
for key, value in [
("maxTokens", self.config.get("max_tokens")),
("temperature", self.config.get("temperature")),
("topP", self.config.get("top_p")),
("stopSequences", self.config.get("stop_sequences")),
]
if value is not None
},
**(
self.config["additional_args"]
if "additional_args" in self.config and self.config["additional_args"] is not None
else {}
),
}
def _format_bedrock_messages(self, messages: Messages) -> Messages:
"""Format messages for Bedrock API compatibility.
This function ensures messages conform to Bedrock's expected format by:
- Filtering out SDK_UNKNOWN_MEMBER content blocks
- Cleaning tool result content blocks by removing additional fields that may be
useful for retaining information in hooks but would cause Bedrock validation
exceptions when presented with unexpected fields
- Ensuring all message content blocks are properly formatted for the Bedrock API
Args:
messages: List of messages to format
Returns:
Messages formatted for Bedrock API compatibility
Note:
Bedrock will throw validation exceptions when presented with additional
unexpected fields in tool result blocks.
https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ToolResultBlock.html
"""
cleaned_messages = []
filtered_unknown_members = False
dropped_deepseek_reasoning_content = False
for message in messages:
cleaned_content: list[ContentBlock] = []
for content_block in message["content"]:
# Filter out SDK_UNKNOWN_MEMBER content blocks
if "SDK_UNKNOWN_MEMBER" in content_block:
filtered_unknown_members = True
continue
# DeepSeek models have issues with reasoningContent
# TODO: Replace with systematic model configuration registry (https://github.com/strands-agents/sdk-python/issues/780)
if "deepseek" in self.config["model_id"].lower() and "reasoningContent" in content_block:
dropped_deepseek_reasoning_content = True
continue
if "toolResult" in content_block:
# Create a new content block with only the cleaned toolResult
tool_result: ToolResult = content_block["toolResult"]
if self._should_include_tool_result_status():
# Include status field
cleaned_tool_result = ToolResult(
content=tool_result["content"],
toolUseId=tool_result["toolUseId"],
status=tool_result["status"],
)
else:
# Remove status field
cleaned_tool_result = ToolResult( # type: ignore[typeddict-item]
toolUseId=tool_result["toolUseId"], content=tool_result["content"]
)
cleaned_block: ContentBlock = {"toolResult": cleaned_tool_result}
cleaned_content.append(cleaned_block)
else:
# Keep other content blocks as-is
cleaned_content.append(content_block)
# Create new message with cleaned content (skip if empty for DeepSeek)
if cleaned_content:
cleaned_message: Message = Message(content=cleaned_content, role=message["role"])
cleaned_messages.append(cleaned_message)
if filtered_unknown_members:
logger.warning(
"Filtered out SDK_UNKNOWN_MEMBER content blocks from messages, consider upgrading boto3 version"
)
if dropped_deepseek_reasoning_content:
logger.debug(
"Filtered DeepSeek reasoningContent content blocks from messages - https://api-docs.deepseek.com/guides/reasoning_model#multi-round-conversation"
)
return cleaned_messages
def _has_blocked_guardrail(self, guardrail_data: dict[str, Any]) -> bool:
"""Check if guardrail data contains any blocked policies.
Args:
guardrail_data: Guardrail data from trace information.
Returns:
True if any blocked guardrail is detected, False otherwise.
"""
input_assessment = guardrail_data.get("inputAssessment", {})
output_assessments = guardrail_data.get("outputAssessments", {})
# Check input assessments
if any(self._find_detected_and_blocked_policy(assessment) for assessment in input_assessment.values()):
return True
# Check output assessments
if any(self._find_detected_and_blocked_policy(assessment) for assessment in output_assessments.values()):
return True
return False
def _generate_redaction_events(self) -> list[StreamEvent]:
"""Generate redaction events based on configuration.
Returns:
List of redaction events to yield.
"""
events: list[StreamEvent] = []
if self.config.get("guardrail_redact_input", True):
logger.debug("Redacting user input due to guardrail.")
events.append(
{
"redactContent": {
"redactUserContentMessage": self.config.get(
"guardrail_redact_input_message", "[User input redacted.]"
)
}
}
)
if self.config.get("guardrail_redact_output", False):
logger.debug("Redacting assistant output due to guardrail.")
events.append(
{
"redactContent": {
"redactAssistantContentMessage": self.config.get(
"guardrail_redact_output_message",
"[Assistant output redacted.]",
)
}
}
)
return events
@override
async def stream(
self,
messages: Messages,
tool_specs: Optional[list[ToolSpec]] = None,
system_prompt: Optional[str] = None,
**kwargs: Any,
) -> AsyncGenerator[StreamEvent, None]:
"""Stream conversation with the Bedrock model.
This method calls either the Bedrock converse_stream API or the converse API
based on the streaming parameter in the configuration.
Args:
messages: List of message objects to be processed by the model.
tool_specs: List of tool specifications to make available to the model.
system_prompt: System prompt to provide context to the model.
**kwargs: Additional keyword arguments for future extensibility.
Yields:
Model events.
Raises:
ContextWindowOverflowException: If the input exceeds the model's context window.
ModelThrottledException: If the model service is throttling requests.
"""
def callback(event: Optional[StreamEvent] = None) -> None:
loop.call_soon_threadsafe(queue.put_nowait, event)
if event is None:
return
loop = asyncio.get_event_loop()
queue: asyncio.Queue[Optional[StreamEvent]] = asyncio.Queue()
thread = asyncio.to_thread(self._stream, callback, messages, tool_specs, system_prompt)
task = asyncio.create_task(thread)
while True:
event = await queue.get()
if event is None:
break
yield event
await task
def _stream(
self,
callback: Callable[..., None],
messages: Messages,
tool_specs: Optional[list[ToolSpec]] = None,
system_prompt: Optional[str] = None,
) -> None:
"""Stream conversation with the Bedrock model.
This method operates in a separate thread to avoid blocking the async event loop with the call to
Bedrock's converse_stream.
Args:
callback: Function to send events to the main thread.
messages: List of message objects to be processed by the model.
tool_specs: List of tool specifications to make available to the model.
system_prompt: System prompt to provide context to the model.
Raises:
ContextWindowOverflowException: If the input exceeds the model's context window.
ModelThrottledException: If the model service is throttling requests.
"""
try:
logger.debug("formatting request")
request = self.format_request(messages, tool_specs, system_prompt)
logger.debug("request=<%s>", request)
logger.debug("invoking model")
streaming = self.config.get("streaming", True)
logger.debug("got response from model")
if streaming:
response = self.client.converse_stream(**request)
# Track tool use events to fix stopReason for streaming responses
has_tool_use = False
for chunk in response["stream"]:
if (
"metadata" in chunk
and "trace" in chunk["metadata"]
and "guardrail" in chunk["metadata"]["trace"]
):
guardrail_data = chunk["metadata"]["trace"]["guardrail"]
if self._has_blocked_guardrail(guardrail_data):
for event in self._generate_redaction_events():
callback(event)
# Track if we see tool use events
if "contentBlockStart" in chunk and chunk["contentBlockStart"].get("start", {}).get("toolUse"):
has_tool_use = True
# Fix stopReason for streaming responses that contain tool use
if (
has_tool_use
and "messageStop" in chunk
and (message_stop := chunk["messageStop"]).get("stopReason") == "end_turn"
):
# Create corrected chunk with tool_use stopReason
modified_chunk = chunk.copy()
modified_chunk["messageStop"] = message_stop.copy()
modified_chunk["messageStop"]["stopReason"] = "tool_use"
logger.warning("Override stop reason from end_turn to tool_use")
callback(modified_chunk)
else:
callback(chunk)
else:
response = self.client.converse(**request)
for event in self._convert_non_streaming_to_streaming(response):
callback(event)
if (
"trace" in response
and "guardrail" in response["trace"]
and self._has_blocked_guardrail(response["trace"]["guardrail"])
):
for event in self._generate_redaction_events():
callback(event)
except ClientError as e:
error_message = str(e)
if e.response["Error"]["Code"] == "ThrottlingException":
raise ModelThrottledException(error_message) from e
if any(overflow_message in error_message for overflow_message in BEDROCK_CONTEXT_WINDOW_OVERFLOW_MESSAGES):
logger.warning("bedrock threw context window overflow error")
raise ContextWindowOverflowException(e) from e
region = self.client.meta.region_name
# add_note added in Python 3.11
if hasattr(e, "add_note"):
# Aid in debugging by adding more information
e.add_note(f"└ Bedrock region: {region}")
e.add_note(f"└ Model id: {self.config.get('model_id')}")
if (
e.response["Error"]["Code"] == "AccessDeniedException"
and "You don't have access to the model" in error_message
):
e.add_note(
"└ For more information see "
"https://strandsagents.com/latest/user-guide/concepts/model-providers/amazon-bedrock/#model-access-issue"
)
if (
e.response["Error"]["Code"] == "ValidationException"
and "with on-demand throughput isn’t supported" in error_message
):
e.add_note(
"└ For more information see "
"https://strandsagents.com/latest/user-guide/concepts/model-providers/amazon-bedrock/#on-demand-throughput-isnt-supported"
)
raise e
finally:
callback()
logger.debug("finished streaming response from model")
def _convert_non_streaming_to_streaming(self, response: dict[str, Any]) -> Iterable[StreamEvent]:
"""Convert a non-streaming response to the streaming format.
Args:
response: The non-streaming response from the Bedrock model.
Returns:
An iterable of response events in the streaming format.
"""
# Yield messageStart event
yield {"messageStart": {"role": response["output"]["message"]["role"]}}
# Process content blocks
for content in cast(list[ContentBlock], response["output"]["message"]["content"]):
# Yield contentBlockStart event if needed
if "toolUse" in content:
yield {
"contentBlockStart": {
"start": {
"toolUse": {
"toolUseId": content["toolUse"]["toolUseId"],
"name": content["toolUse"]["name"],
}
},
}
}
# For tool use, we need to yield the input as a delta
input_value = json.dumps(content["toolUse"]["input"])
yield {"contentBlockDelta": {"delta": {"toolUse": {"input": input_value}}}}
elif "text" in content:
# Then yield the text as a delta
yield {
"contentBlockDelta": {
"delta": {"text": content["text"]},
}
}
elif "reasoningContent" in content:
# Then yield the reasoning content as a delta
yield {
"contentBlockDelta": {
"delta": {"reasoningContent": {"text": content["reasoningContent"]["reasoningText"]["text"]}}
}
}
if "signature" in content["reasoningContent"]["reasoningText"]:
yield {
"contentBlockDelta": {
"delta": {
"reasoningContent": {
"signature": content["reasoningContent"]["reasoningText"]["signature"]
}
}
}
}
elif "citationsContent" in content:
# For non-streaming citations, emit text and metadata deltas in sequence
# to match streaming behavior where they flow naturally
if "content" in content["citationsContent"]:
text_content = "".join([content["text"] for content in content["citationsContent"]["content"]])
yield {
"contentBlockDelta": {"delta": {"text": text_content}},
}
for citation in content["citationsContent"]["citations"]:
# Then emit citation metadata (for structure)
citation_metadata: CitationsDelta = {
"title": citation["title"],
"location": citation["location"],
"sourceContent": citation["sourceContent"],
}
yield {"contentBlockDelta": {"delta": {"citation": citation_metadata}}}
# Yield contentBlockStop event
yield {"contentBlockStop": {}}
# Yield messageStop event
# Fix stopReason for models that return end_turn when they should return tool_use on non-streaming side
current_stop_reason = response["stopReason"]
if current_stop_reason == "end_turn":
message_content = response["output"]["message"]["content"]
if any("toolUse" in content for content in message_content):
current_stop_reason = "tool_use"
logger.warning("Override stop reason from end_turn to tool_use")
yield {
"messageStop": {
"stopReason": current_stop_reason,
"additionalModelResponseFields": response.get("additionalModelResponseFields"),
}
}
# Yield metadata event
if "usage" in response or "metrics" in response or "trace" in response:
metadata: StreamEvent = {"metadata": {}}
if "usage" in response:
metadata["metadata"]["usage"] = response["usage"]
if "metrics" in response:
metadata["metadata"]["metrics"] = response["metrics"]
if "trace" in response:
metadata["metadata"]["trace"] = response["trace"]
yield metadata
def _find_detected_and_blocked_policy(self, input: Any) -> bool:
"""Recursively checks if the assessment contains a detected and blocked guardrail.
Args:
input: The assessment to check.
Returns:
True if the input contains a detected and blocked guardrail, False otherwise.
"""
# Check if input is a dictionary
if isinstance(input, dict):
# Check if current dictionary has action: BLOCKED and detected: true
if input.get("action") == "BLOCKED" and input.get("detected") and isinstance(input.get("detected"), bool):
return True
# Recursively check all values in the dictionary
for value in input.values():
if isinstance(value, dict):
return self._find_detected_and_blocked_policy(value)
# Handle case where value is a list of dictionaries
elif isinstance(value, list):
for item in value:
return self._find_detected_and_blocked_policy(item)
elif isinstance(input, list):
# Handle case where input is a list of dictionaries
for item in input:
return self._find_detected_and_blocked_policy(item)
# Otherwise return False
return False
@override
async def structured_output(
self,
output_model: Type[T],
prompt: Messages,
system_prompt: Optional[str] = None,
**kwargs: Any,
) -> AsyncGenerator[dict[str, Union[T, Any]], None]:
"""Get structured output from the model.
Args:
output_model: The output model to use for the agent.
prompt: The prompt messages to use for the agent.
system_prompt: System prompt to provide context to the model.
**kwargs: Additional keyword arguments for future extensibility.
Yields:
Model events with the last being the structured output.
"""
tool_spec = convert_pydantic_to_tool_spec(output_model)
response = self.stream(
messages=prompt,
tool_specs=[tool_spec],
system_prompt=system_prompt,
**kwargs,
)
async for event in streaming.process_stream(response):
yield event
stop_reason, messages, _, _ = event["stop"]
if stop_reason != "tool_use":
raise ValueError(f'Model returned stop_reason: {stop_reason} instead of "tool_use".')
content = messages["content"]
output_response: dict[str, Any] | None = None
for block in content:
# if the tool use name doesn't match the tool spec name, skip, and if the block is not a tool use, skip.
# if the tool use name never matches, raise an error.
if block.get("toolUse") and block["toolUse"]["name"] == tool_spec["name"]:
output_response = block["toolUse"]["input"]
else:
continue
if output_response is None:
raise ValueError("No valid tool use or tool use input was found in the Bedrock response.")
yield {"output": output_model(**output_response)}
@staticmethod
def get_model_prefix_with_warning(region_name: str, model_config: Optional[BedrockConfig] = None) -> str:
"""Get model prefix for bedrock model based on region.
If the region is not **known** to support inference then we show a helpful warning
that compliments the exception that Bedrock will throw.
If the customer provided a model_id in their config then we should not
show any warnings as this is only for the **default** model we provide.
Args:
region_name (str): region for bedrock model
model_config (Optional[dict[str, Any]]): Model Config that caller passes in on init
"""
prefix_infr_map = {"ap": "apac"} # some inference endpoints can be a bit different then the region prefix
model_config = model_config or {}
prefix = "-".join(region_name.split("-")[:-2]).lower() # handles `us-east-1` or `us-gov-east-1`
if prefix not in {"us", "eu", "ap"} and not model_config.get("model_id"):
warnings.warn(
f"""
================== WARNING ==================
This region {region_name} does not support
our default inference endpoint: {DEFAULT_BEDROCK_MODEL_ID.format(prefix)}.
Update the agent to pass in a 'model_id' like so:
```
Agent(..., model='valid_model_id', ...)
````
Documentation: https://docs.aws.amazon.com/bedrock/latest/userguide/inference-profiles-support.html
==================================================
""",
stacklevel=2,
)
return prefix_infr_map.get(prefix, prefix)