camel/messages/conversion/sharegpt/function_call_formatter.py

# ========= Copyright 2023-2024 @ 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-2024 @ CAMEL-AI.org. All Rights Reserved. =========
from abc import ABC, abstractmethod
from typing import Any, Dict, Generic, List, Optional, TypeVar

from camel.messages.conversion import (
    ToolCall,
    ToolResponse,
)

CallT = TypeVar('CallT', bound=ToolCall, covariant=True)
ResponseT = TypeVar('ResponseT', bound=ToolResponse, covariant=True)


class FunctionCallFormatter(ABC, Generic[CallT, ResponseT]):
    r"""Abstract base class for function calling formats"""

    @abstractmethod
    def extract_tool_calls(self, message: str) -> List[CallT]:
        r"""Extract function call info from a message string"""
        pass

    @abstractmethod
    def extract_tool_response(self, message: str) -> Optional[ResponseT]:
        r"""Extract function response info from a message string"""
        pass

    @abstractmethod
    def format_tool_call(
        self, content: str, func_name: str, args: Dict[str, Any]
    ) -> str:
        r"""Format a function call into a message string"""
        pass

    @abstractmethod
    def format_tool_response(self, func_name: str, result: Any) -> str:
        r"""Format a function response into a message string"""
        pass