File size: 2,925 Bytes
bcdf9fa |
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 |
# Copyright 2023-2024 SGLang Team
# Copyright 2025 ModelBest Inc. and/or its affiliates
#
# 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.
from typing import Any, Optional, Tuple
from uuid import uuid4
from .schemas import OpenAIFunctionToolSchema
class BaseTool:
"""Base class for tools.
A tool should support the following methods:
- `to_openai_function_tool_schema`: return the tool schema in OpenAI format.
- `create`: create a tool instance for a trajectory.
- `execute`: execute the tool.
- `calc_reward`: calculate the reward respect to tool state.
- `release`: release the tool instance.
"""
def __init__(self, config: dict, tool_schema: OpenAIFunctionToolSchema):
self.config = config
self.name = tool_schema.function.name
self.tool_schema = tool_schema
def get_openai_tool_schema(self) -> OpenAIFunctionToolSchema:
return self.tool_schema
async def create(self, instance_id: Optional[str] = None, **kwargs) -> str:
"""Create a tool instance.
Args:
instance_id: The instance id of the tool.
Returns:
The instance id of the tool.
"""
if instance_id is None:
return str(uuid4())
else:
return instance_id
async def execute(self, instance_id: str, parameters: dict[str, Any], **kwargs) -> Tuple[str, float, dict]:
"""Execute the tool.
Args:
instance_id: The instance id of the tool.
parameters: The json string of the parameters of the tool.
Returns: tool_response, tool_reward_score, tool_metrics
tool_response: The response str of the tool.
tool_reward_score: The step reward score of the tool.
tool_metrics: The metrics of the tool.
"""
return "Updated the tool state.", 0.0, {}
async def calc_reward(self, instance_id: str, **kwargs) -> float:
"""Calculate the reward of the tool.
Args:
instance_id: The instance id of the tool.
Returns:
The reward of the tool.
"""
return 0.0
async def release(self, instance_id: str, **kwargs) -> None:
"""Release the tool instance.
Args:
instance_id: The instance id of the tool.
"""
pass
|