SpecificToolChoice dataclass

The model must request a specific tool. For example, {"tool" : {"name" : "Your tool name"}}. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide

Note

This field is only supported by Anthropic Claude 3 models.

Source code in src/aws_sdk_bedrock_runtime/models.py

@dataclass(kw_only=True)
class SpecificToolChoice:
    """The model must request a specific tool. For example,
    `{"tool" : {"name" : "Your tool name"}}`. For more information, see
    [Call a tool with the Converse
    API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html)
    in the Amazon Bedrock User Guide

    Note:
        This field is only supported by Anthropic Claude 3 models.
    """

    name: str
    """The name of the tool that the model must request."""

    def serialize(self, serializer: ShapeSerializer):
        serializer.write_struct(_SCHEMA_SPECIFIC_TOOL_CHOICE, self)

    def serialize_members(self, serializer: ShapeSerializer):
        serializer.write_string(_SCHEMA_SPECIFIC_TOOL_CHOICE.members["name"], self.name)

    @classmethod
    def deserialize(cls, deserializer: ShapeDeserializer) -> Self:
        return cls(**cls.deserialize_kwargs(deserializer))

    @classmethod
    def deserialize_kwargs(cls, deserializer: ShapeDeserializer) -> dict[str, Any]:
        kwargs: dict[str, Any] = {}

        def _consumer(schema: Schema, de: ShapeDeserializer) -> None:
            match schema.expect_member_index():
                case 0:
                    kwargs["name"] = de.read_string(
                        _SCHEMA_SPECIFIC_TOOL_CHOICE.members["name"]
                    )

                case _:
                    logger.debug("Unexpected member schema: %s", schema)

        deserializer.read_struct(_SCHEMA_SPECIFIC_TOOL_CHOICE, consumer=_consumer)
        return kwargs

Attributes

name instance-attribute

name: str

The name of the tool that the model must request.