Skip to content

Commit 074e112

Browse files
authored
Resolve the BedrockEmbeddingClient region like the chat client (#9349)
1 parent b1c582e commit 074e112

2 files changed

Lines changed: 80 additions & 7 deletions

File tree

‎python/packages/bedrock/agent_framework_bedrock/_embedding_client.py‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,9 @@ class RawBedrockEmbeddingClient(
8585
model: The Bedrock embedding model ID (e.g. "amazon.titan-embed-text-v2:0").
8686
Can also be set via environment variable BEDROCK_EMBEDDING_MODEL.
8787
region: AWS region. Will try to load from BEDROCK_REGION env var,
88-
if not set, the regular Boto3 configuration/loading applies
89-
(which may include other env vars, config files, or instance metadata).
88+
if not set, the region of ``boto3_session`` is used, or without a session
89+
the regular Boto3 configuration/loading applies (which may include other
90+
env vars, config files, or instance metadata). Falls back to us-east-1.
9091
access_key: AWS access key for manual credential injection.
9192
secret_key: AWS secret key paired with access_key.
9293
session_token: AWS session token for temporary credentials.
@@ -138,10 +139,10 @@ def __init__(
138139
if session_token := settings.get("session_token"):
139140
session_kwargs["aws_session_token"] = session_token.get_secret_value()
140141
boto3_session = Boto3Session(**session_kwargs)
141-
region_name = boto3_session.region_name
142+
resolved_region = settings.get("region") or boto3_session.region_name or DEFAULT_REGION
142143
self._bedrock_client = boto3_session.client(
143144
"bedrock-runtime",
144-
region_name=region_name or resolved_region,
145+
region_name=resolved_region,
145146
config=BotoConfig(user_agent_extra=get_user_agent()),
146147
)
147148

@@ -239,8 +240,9 @@ class BedrockEmbeddingClient(
239240
Keyword Args:
240241
model: The Bedrock embedding model ID (e.g. "amazon.titan-embed-text-v2:0").
241242
Can also be set via environment variable BEDROCK_EMBEDDING_MODEL.
242-
region: AWS region. Defaults to "us-east-1".
243-
Can also be set via environment variable BEDROCK_REGION.
243+
region: AWS region. Can also be set via environment variable BEDROCK_REGION.
244+
If not set, the region of ``boto3_session`` is used, or without a session
245+
the regular Boto3 configuration. Defaults to "us-east-1".
244246
access_key: AWS access key for manual credential injection.
245247
secret_key: AWS secret key paired with access_key.
246248
session_token: AWS session token for temporary credentials.

‎python/packages/bedrock/tests/bedrock/test_bedrock_embedding_client.py‎

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@
44

55
import json
66
import os
7-
from typing import Any
7+
from typing import Any, cast
88
from unittest.mock import MagicMock
99

1010
import pytest
1111
from agent_framework import Embedding, GeneratedEmbeddings
12+
from boto3.session import Session as Boto3Session
1213

1314
from agent_framework_bedrock import BedrockEmbeddingClient, BedrockEmbeddingOptions
1415

@@ -143,6 +144,76 @@ async def test_bedrock_embedding_default_region() -> None:
143144
assert client.region == "us-east-1"
144145

145146

147+
class _FakeSession:
148+
def __init__(self, region_name: str | None = None) -> None:
149+
self.calls: list[dict[str, Any]] = []
150+
self.region_name = region_name
151+
152+
def client(self, service_name: str, *, region_name: str, config: Any) -> _StubBedrockEmbeddingRuntime:
153+
self.calls.append({"service_name": service_name, "region_name": region_name})
154+
return _StubBedrockEmbeddingRuntime()
155+
156+
157+
@pytest.mark.parametrize(
158+
("region", "env_region", "session_region", "expected_region"),
159+
[
160+
(None, None, "eu-west-1", "eu-west-1"),
161+
("us-west-2", None, "eu-west-1", "us-west-2"),
162+
(None, "ap-south-1", "eu-west-1", "ap-south-1"),
163+
(None, None, None, "us-east-1"),
164+
],
165+
ids=["session-region", "region-argument-wins", "env-region-wins", "default-region"],
166+
)
167+
async def test_bedrock_embedding_resolves_region_with_boto3_session(
168+
monkeypatch: pytest.MonkeyPatch,
169+
region: str | None,
170+
env_region: str | None,
171+
session_region: str | None,
172+
expected_region: str,
173+
) -> None:
174+
"""A configured region wins, then the provided session's region, then the default region."""
175+
if env_region:
176+
monkeypatch.setenv("BEDROCK_REGION", env_region)
177+
else:
178+
monkeypatch.delenv("BEDROCK_REGION", raising=False)
179+
session = _FakeSession(region_name=session_region)
180+
181+
client = BedrockEmbeddingClient(
182+
model="amazon.titan-embed-text-v2:0", region=region, boto3_session=cast(Boto3Session, session)
183+
)
184+
185+
assert session.calls == [{"service_name": "bedrock-runtime", "region_name": expected_region}]
186+
assert client.region == expected_region
187+
188+
189+
async def test_bedrock_embedding_reports_boto3_default_region(monkeypatch: pytest.MonkeyPatch) -> None:
190+
"""Without a region or session, the region boto3 resolves is used and reported."""
191+
monkeypatch.delenv("BEDROCK_REGION", raising=False)
192+
monkeypatch.setenv("AWS_DEFAULT_REGION", "eu-central-1")
193+
194+
client = BedrockEmbeddingClient(model="amazon.titan-embed-text-v2:0")
195+
196+
assert client.service_url() == "https://bedrock-runtime.eu-central-1.amazonaws.com"
197+
assert client.region == "eu-central-1"
198+
199+
200+
async def test_bedrock_embedding_ignores_boto3_session_when_runtime_client_supplied(
201+
monkeypatch: pytest.MonkeyPatch,
202+
) -> None:
203+
"""A preconfigured runtime client wins, so the unused session should not change the reported region."""
204+
monkeypatch.delenv("BEDROCK_REGION", raising=False)
205+
session = _FakeSession(region_name="eu-west-1")
206+
207+
client = BedrockEmbeddingClient(
208+
model="amazon.titan-embed-text-v2:0",
209+
client=_StubBedrockEmbeddingRuntime(), # pyrefly: ignore[bad-argument-type] # ty: ignore[invalid-argument-type] # pyright: ignore[reportArgumentType]
210+
boto3_session=cast(Boto3Session, session),
211+
)
212+
213+
assert session.calls == []
214+
assert client.region == "us-east-1"
215+
216+
146217
# region: Integration Tests
147218

148219
skip_if_bedrock_embedding_integration_tests_disabled = pytest.mark.skipif(

0 commit comments

Comments
 (0)