🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org
Python agentai-societiesartificial-intelligencecommunicative-aicooperative-aideep-learninglarge-language-modelsmulti-agent-systemsnatural-language-processing
feat: support openai structured output (#1198)
Wendong-Fan146af248fb79
diff --git a/camel/agents/chat_agent.py b/camel/agents/chat_agent.pyindex 125466923..e1ed9fcf6 100644--- a/camel/agents/chat_agent.py+++ b/camel/agents/chat_agent.py@@ -476,6 +476,15 @@ class ChatAgent(BaseAgent):a boolean indicating whether the chat session has terminated,and information about the chat session."""+ if (+ self.model_backend.model_config_dict.get("response_format")+ and response_format+ ):+ raise ValueError(+ "The `response_format` parameter cannot be set both in "+ "the model configuration and in the ChatAgent step."+ )+if isinstance(input_message, str):input_message = BaseMessage.make_user_message(role_name='User', content=input_messagediff --git a/camel/configs/openai_config.py b/camel/configs/openai_config.pyindex 8919d3e53..63ebd7a18 100644--- a/camel/configs/openai_config.py+++ b/camel/configs/openai_config.py@@ -13,9 +13,9 @@# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========from __future__ import annotations-from typing import Optional, Sequence, Union+from typing import Any, Optional, Sequence, Type, Union-from pydantic import Field+from pydantic import BaseModel, Fieldfrom camel.configs.base_config import BaseConfigfrom camel.types import NOT_GIVEN, NotGiven@@ -104,11 +104,36 @@ class ChatGPTConfig(BaseConfig):stop: Union[str, Sequence[str], NotGiven] = NOT_GIVENmax_tokens: Union[int, NotGiven] = NOT_GIVENpresence_penalty: float = 0.0- response_format: Union[dict, NotGiven] = NOT_GIVEN+ response_format: Union[Type[BaseModel], dict, NotGiven] = NOT_GIVENfrequency_penalty: float = 0.0logit_bias: dict = Field(default_factory=dict)user: str = ""tool_choice: Optional[Union[dict[str, str], str]] = None+ def as_dict(self) -> dict[str, Any]:+ r"""Convert the current configuration to a dictionary.++ This method converts the current configuration object to a dictionary+ representation, which can be used for serialization or other purposes.++ Returns:+ dict[str, Any]: A dictionary representation of the current+ configuration.+ """+ config_dict = self.model_dump()+ if self.tools:+ from camel.toolkits import FunctionTool++ tools_schema = []+ for tool in self.tools:+ if not isinstance(tool, FunctionTool):+ raise ValueError(+ f"The tool {tool} should "+ "be an instance of `FunctionTool`."+ )+ tools_schema.append(tool.get_openai_tool_schema())+ config_dict["tools"] = NOT_GIVEN+ return config_dict+OPENAI_API_PARAMS = {param for param in ChatGPTConfig.model_fields.keys()}diff --git a/camel/models/openai_model.py b/camel/models/openai_model.pyindex 4ba5e8f78..9e8e2d9b3 100644--- a/camel/models/openai_model.py+++ b/camel/models/openai_model.py@@ -24,6 +24,7 @@ from camel.types import (ChatCompletion,ChatCompletionChunk,ModelType,+ ParsedChatCompletion,)from camel.utils import (BaseTokenCounter,@@ -127,6 +128,19 @@ class OpenAIModel(BaseModelBackend):self.model_config_dict["presence_penalty"] = 0.0self.model_config_dict["frequency_penalty"] = 0.0+ if self.model_config_dict.get("response_format"):+ # stream is not supported in beta.chat.completions.parse+ if "stream" in self.model_config_dict:+ del self.model_config_dict["stream"]++ response = self._client.beta.chat.completions.parse(+ messages=messages,+ model=self.model_type,+ **self.model_config_dict,+ )++ return self._to_chat_completion(response)+response = self._client.chat.completions.create(messages=messages,model=self.model_type,@@ -134,6 +148,30 @@ class OpenAIModel(BaseModelBackend):)return response+ def _to_chat_completion(+ self, response: "ParsedChatCompletion"+ ) -> ChatCompletion:+ # TODO: Handle n > 1 or warn consumers it's not supported+ choice = dict(+ index=response.choices[0].index,+ message={+ "role": response.choices[0].message.role,+ "content": response.choices[0].message.content,+ "tool_calls": response.choices[0].message.tool_calls,+ },+ finish_reason=response.choices[0].finish_reason,+ )++ obj = ChatCompletion.construct(+ id=response.id,+ choices=[choice],+ created=response.created,+ model=response.model,+ object="chat.completion",+ usage=response.usage,+ )+ return obj+def check_model_config(self):r"""Check whether the model configuration contains anyunexpected arguments to OpenAI API.diff --git a/camel/types/__init__.py b/camel/types/__init__.pyindex 9918574e8..9294d1ef9 100644--- a/camel/types/__init__.py+++ b/camel/types/__init__.py@@ -40,6 +40,7 @@ from .openai_types import (Choice,CompletionUsage,NotGiven,+ ParsedChatCompletion,)from .unified_model_type import UnifiedModelType@@ -71,4 +72,5 @@ __all__ = ['UnifiedModelType','NOT_GIVEN','NotGiven',+ 'ParsedChatCompletion',]diff --git a/camel/types/openai_types.py b/camel/types/openai_types.pyindex e60af44ad..468504ecd 100644--- a/camel/types/openai_types.py+++ b/camel/types/openai_types.py@@ -31,6 +31,7 @@ from openai.types.chat.chat_completion_user_message_param import (ChatCompletionUserMessageParam,)from openai.types.completion_usage import CompletionUsage+from openai.types.chat import ParsedChatCompletionfrom openai._types import NOT_GIVEN, NotGivenChoice = Choice@@ -45,3 +46,4 @@ ChatCompletionFunctionMessageParam = ChatCompletionFunctionMessageParamCompletionUsage = CompletionUsageNOT_GIVEN = NOT_GIVENNotGiven = NotGiven+ParsedChatCompletion = ParsedChatCompletiondiff --git a/examples/models/openai_structured_output_example.py b/examples/models/openai_structured_output_example.pynew file mode 100644index 000000000..0dcf96b9a--- /dev/null+++ b/examples/models/openai_structured_output_example.py@@ -0,0 +1,54 @@+# =========== Copyright 2023 @ 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 @ CAMEL-AI.org. All Rights Reserved. ===========+from pydantic import BaseModel++from camel.agents import ChatAgent+from camel.configs import ChatGPTConfig+from camel.models import ModelFactory+from camel.types import ModelPlatformType, ModelType+++class Student(BaseModel):+ name: str+ age: str+++class StudentList(BaseModel):+ studentLlst: list[Student]+++openai_model = ModelFactory.create(+ model_platform=ModelPlatformType.OPENAI,+ model_type=ModelType.GPT_4O_MINI,+ model_config_dict=ChatGPTConfig(+ temperature=0.0, response_format=StudentList+ ).as_dict(),+)++# Set agent+camel_agent = ChatAgent(model=openai_model)++# Set user message+user_msg = """give me some student infos."""++# Get response information+response = camel_agent.step(user_msg)+print(response.msgs[0].content)+'''+===============================================================================+{"studentLlst":[{"name":"Alice Johnson","age":"20"},{"name":"Brian Smith",+"age":"22"},{"name":"Catherine Lee","age":"19"},{"name":"David Brown",+"age":"21"},{"name":"Eva White","age":"20"}]}+===============================================================================+'''