Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

13.4 KB
Raw Blame
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2026 @ CAMEL-AI.org. All Rights Reserved. =========

import base64
import sys
import types

import pytest

from camel.configs import BedrockConfig
from camel.models import AWSBedrockConverseModel
from camel.types import ModelType


def _make_model(
    model_config_dict=None,
    **kwargs,
) -> AWSBedrockConverseModel:
    if model_config_dict is None:
        model_config_dict = BedrockConfig().as_dict()
    return AWSBedrockConverseModel(
        ModelType.AWS_CLAUDE_3_HAIKU,
        model_config_dict=model_config_dict,
        api_key="dummy_key",
        region_name="us-west-2",
        **kwargs,
    )


@pytest.mark.model_backend
def test_converse_cache_checkpoints_not_shared_object():
    model = _make_model(
        BedrockConfig(
            cache_control="5m",
        ).as_dict(),
        bedrock_client=object(),
    )

    system, messages = model._convert_openai_to_bedrock_messages(
        [
            {"role": "system", "content": "sys"},
            {"role": "user", "content": "hello"},
        ]
    )
    assert system[-1] == {"cachePoint": {"type": "default"}}
    assert messages[-1]["content"][-1] == {"cachePoint": {"type": "default"}}
    assert system[-1] is not messages[-1]["content"][-1]


@pytest.mark.model_backend
def test_converse_builds_tool_config_and_tool_messages():
    model = _make_model(
        BedrockConfig(
            cache_control="5m",
            tool_choice="auto",
        ).as_dict(),
        bedrock_client=object(),
    )

    request = model._build_converse_request(
        messages=[
            {"role": "system", "content": "sys"},
            {"role": "user", "content": "question"},
            {
                "role": "assistant",
                "content": "",
                "tool_calls": [
                    {
                        "id": "call_1",
                        "type": "function",
                        "function": {
                            "name": "search_docs",
                            "arguments": '{"q":"camel"}',
                        },
                    }
                ],
            },
            {
                "role": "tool",
                "tool_call_id": "call_1",
                "content": '{"answer":"ok"}',
            },
        ],
        tools=[
            {
                "type": "function",
                "function": {
                    "name": "search_docs",
                    "description": "Search docs",
                    "parameters": {
                        "type": "object",
                        "properties": {"q": {"type": "string"}},
                        "required": ["q"],
                    },
                },
            }
        ],
    )

    assert request["toolConfig"]["toolChoice"] == {"auto": {}}
    assert (
        request["toolConfig"]["tools"][0]["toolSpec"]["name"] == "search_docs"
    )
    assert request["messages"][1]["role"] == "assistant"
    assert any(
        isinstance(block, dict) and "toolUse" in block
        for block in request["messages"][1]["content"]
    )
    assert request["messages"][2]["role"] == "user"
    assert "toolResult" in request["messages"][2]["content"][0]


@pytest.mark.model_backend
def test_converse_tool_choice_none_disables_tools():
    model = _make_model(
        BedrockConfig(tool_choice="none").as_dict(),
        bedrock_client=object(),
    )
    request = model._build_converse_request(
        messages=[{"role": "user", "content": "hello"}],
        tools=[
            {
                "type": "function",
                "function": {
                    "name": "search_docs",
                    "parameters": {"type": "object"},
                },
            }
        ],
    )
    assert "toolConfig" not in request


@pytest.mark.model_backend
def test_converse_supports_data_url_image_conversion():
    image_bytes = b"test-image"
    data_url = (
        "data:image/png;base64," + base64.b64encode(image_bytes).decode()
    )
    model = _make_model(bedrock_client=object())

    blocks = model._to_bedrock_content_blocks(
        [{"type": "image_url", "image_url": {"url": data_url}}]
    )
    assert blocks[0]["image"]["format"] == "png"
    assert blocks[0]["image"]["source"]["bytes"] == image_bytes


@pytest.mark.model_backend
def test_parse_json_or_text_scalar_json_is_text():
    model = _make_model(bedrock_client=object())
    assert model._parse_json_or_text("42") == {"text": "42"}
    assert model._parse_json_or_text("true") == {"text": "true"}


@pytest.mark.model_backend
def test_parse_json_or_text_top_level_list_is_wrapped_in_object():
    """Bedrock Converse requires an object at `toolResult.content[].json`."""
    model = _make_model(bedrock_client=object())

    assert model._parse_json_or_text([]) == {
        "json": {"__camel_tool_result__": []}
    }
    assert model._parse_json_or_text("[]") == {
        "json": {"__camel_tool_result__": []}
    }
    assert model._parse_json_or_text([{"id": 1}, {"id": 2}]) == {
        "json": {"__camel_tool_result__": [{"id": 1}, {"id": 2}]}
    }


@pytest.mark.model_backend
def test_converse_tool_message_with_list_payload_produces_object():
    """End-to-end check: a `tool` message whose content is a JSON list
    must produce a Bedrock `toolResult.content[0].json` whose value is a
    JSON object (not a list). See issue #3962.
    """
    model = _make_model(bedrock_client=object())

    request = model._build_converse_request(
        messages=[
            {"role": "user", "content": "find papers"},
            {
                "role": "assistant",
                "content": "",
                "tool_calls": [
                    {
                        "id": "call_1",
                        "type": "function",
                        "function": {
                            "name": "search_papers",
                            "arguments": "{}",
                        },
                    }
                ],
            },
            {
                "role": "tool",
                "tool_call_id": "call_1",
                "content": "[]",
            },
        ],
        tools=[
            {
                "type": "function",
                "function": {
                    "name": "search_papers",
                    "parameters": {"type": "object"},
                },
            }
        ],
    )

    tool_result_block = request["messages"][2]["content"][0]
    assert "toolResult" in tool_result_block
    payload = tool_result_block["toolResult"]["content"][0]
    assert payload == {"json": {"__camel_tool_result__": []}}


@pytest.mark.model_backend
def test_converse_stream_is_supported():
    class DummyEventStream:
        def __init__(self, events):
            self._events = events

        def __iter__(self):
            return iter(self._events)

    class DummyClient:
        def converse_stream(self, **kwargs):
            return {
                "stream": DummyEventStream(
                    [
                        {"messageStart": {"role": "assistant"}},
                        {"contentBlockDelta": {"delta": {"text": "hello"}}},
                        {"messageStop": {"stopReason": "end_turn"}},
                    ]
                )
            }

    model = _make_model(
        BedrockConfig(stream=True).as_dict(),
        bedrock_client=DummyClient(),
    )
    chunks = list(model._run([{"role": "user", "content": "hi"}]))
    assert len(chunks) >= 2
    assert chunks[-1].choices[0].finish_reason == "stop"


@pytest.mark.model_backend
@pytest.mark.asyncio
async def test_converse_async_non_stream():
    class DummyClient:
        def converse(self, **kwargs):
            return {
                "output": {
                    "message": {
                        "role": "assistant",
                        "content": [{"text": "hello async"}],
                    }
                },
                "stopReason": "end_turn",
                "usage": {
                    "inputTokens": 10,
                    "outputTokens": 5,
                },
                "ResponseMetadata": {
                    "RequestId": "req-async-123",
                },
            }

    model = _make_model(bedrock_client=DummyClient())
    result = await model._arun(
        [{"role": "user", "content": "hi"}],
    )
    assert result.id == "req-async-123"
    assert result.choices[0].message.content == "hello async"
    assert result.usage.prompt_tokens == 10
    assert result.usage.completion_tokens == 5


@pytest.mark.model_backend
@pytest.mark.asyncio
async def test_converse_async_stream():
    class DummyEventStream:
        def __init__(self, events):
            self._events = events

        def __iter__(self):
            return iter(self._events)

    class DummyClient:
        def converse_stream(self, **kwargs):
            return {
                "stream": DummyEventStream(
                    [
                        {"messageStart": {"role": "assistant"}},
                        {
                            "contentBlockDelta": {
                                "delta": {"text": "hi async"},
                            }
                        },
                        {
                            "messageStop": {
                                "stopReason": "end_turn",
                            }
                        },
                    ]
                )
            }

    model = _make_model(
        BedrockConfig(stream=True).as_dict(),
        bedrock_client=DummyClient(),
    )
    result = await model._arun(
        [{"role": "user", "content": "hi"}],
    )
    chunks = [chunk async for chunk in result]
    assert len(chunks) >= 2
    assert chunks[-1].choices[0].finish_reason == "stop"


@pytest.mark.model_backend
def test_bedrock_client_supports_api_key_and_region_name(monkeypatch):
    def _fake_boto3_client(service_name, **kwargs):
        return {"service_name": service_name, "kwargs": kwargs}

    fake_boto3 = types.SimpleNamespace(client=_fake_boto3_client)
    monkeypatch.setitem(sys.modules, "boto3", fake_boto3)
    monkeypatch.delenv("AWS_BEARER_TOKEN_BEDROCK", raising=False)

    model = AWSBedrockConverseModel(
        ModelType.AWS_CLAUDE_3_HAIKU,
        model_config_dict=BedrockConfig().as_dict(),
        api_key="AKIA_TEST_KEY",
        region_name="us-east-1",
    )

    client = model.bedrock_client
    assert client["service_name"] == "bedrock-runtime"
    assert client["kwargs"]["region_name"] == "us-east-1"
    assert "aws_access_key_id" not in client["kwargs"]


@pytest.mark.model_backend
@pytest.mark.parametrize(
    "stop_reason,expected",
    [
        ("content_filtered", "content_filter"),
        ("guardrail_intervened", "content_filter"),
        ("model_context_window_exceeded", "length"),
    ],
)
def test_converse_maps_non_default_stop_reasons(stop_reason, expected):
    r"""Non-streaming: a filtered, guardrailed or context-exceeded turn
    must not be reported as a normal completion."""

    class DummyClient:
        def converse(self, **kwargs):
            return {
                "output": {
                    "message": {
                        "role": "assistant",
                        "content": [{"text": "partial"}],
                    }
                },
                "stopReason": stop_reason,
            }

    model = _make_model(bedrock_client=DummyClient())
    response = model._run([{"role": "user", "content": "hi"}])
    assert response.choices[0].finish_reason == expected


@pytest.mark.model_backend
@pytest.mark.parametrize(
    "stop_reason,expected",
    [
        ("content_filtered", "content_filter"),
        ("guardrail_intervened", "content_filter"),
        ("model_context_window_exceeded", "length"),
    ],
)
def test_converse_stream_maps_non_default_stop_reasons(stop_reason, expected):
    r"""Streaming path reports the same finish_reason as non-streaming."""

    class DummyEventStream:
        def __init__(self, events):
            self._events = events

        def __iter__(self):
            return iter(self._events)

    class DummyClient:
        def converse_stream(self, **kwargs):
            return {
                "stream": DummyEventStream(
                    [
                        {"messageStart": {"role": "assistant"}},
                        {"contentBlockDelta": {"delta": {"text": "partial"}}},
                        {"messageStop": {"stopReason": stop_reason}},
                    ]
                )
            }

    model = _make_model(
        BedrockConfig(stream=True).as_dict(),
        bedrock_client=DummyClient(),
    )
    chunks = list(model._run([{"role": "user", "content": "hi"}]))
    assert chunks[-1].choices[0].finish_reason == expected


@pytest.mark.model_backend
def test_converse_unknown_stop_reason_still_defaults_to_stop():
    r"""Values with no OpenAI equivalent keep the generic default."""
    for stop_reason in ("malformed_model_output", "malformed_tool_use"):
        assert AWSBedrockConverseModel._map_stop_reason(stop_reason) == "stop"