Toolkits/issue949 generate openai tool schema #1070
Conversation
This commit refactors the `FunctionTool` class in the `function_tool.py` file. It adds a new method `generate_openai_tool_schema` that uses an optional assistant model to generate the OpenAI tool schema for the specified function. If no assistant model is provided, it defaults to creating a GPT_4O_MINI model. The function's source code is used to generate a docstring and schema, which are validated before returning the final schema. If schema generation or validation fails, the process retries up to two times. This refactor improves the functionality and flexibility of the `FunctionTool` class.
"Adjusted the code to comply with PEP 8 line length standards. Added the `use_schema_assistant` parameter in `FunctionTool` to control whether to use LLM to generate the schema, with a default value of `False`."
|
My thought is that for direct calling (e.g. from another project that has camel as a dependency) the retries isn't appropriate because it is surprising and it would be better to throw an exception for the caller to handle as they like. An idea for the future is that we can have these tool implementations written in a way that is appropriate to expose as APIs, with wrappers that will do things like auto retry certain types of exceptions which will be used when given to AI agents For now of course the AI agent use's needs should be prioritised I think |
There was a problem hiding this comment.
Thanks @Zhangzeyu97. The PR looks great!!
I left some minor comments and change the validation of tool schema in which I remove the validation of the descriptiom: #1085.
| ) -> None: | ||
| self.func = func | ||
| self.openai_tool_schema = openai_tool_schema or get_openai_tool_schema( | ||
| func | ||
| ) | ||
|
|
||
| if use_schema_assistant: | ||
| try: | ||
| self.validate_openai_tool_schema(self.openai_tool_schema) |
There was a problem hiding this comment.
openai tool call actually support descriptions as optional. I remove it from the validation: #1085. So maybe we should remove the try and except and generate the schema directly if use_schema_assistant
Sorry I do not fully get the point. Here the retries are for the docstring generation instead of tool calling. What would be the issue? |
Yeah you're right this is fine actually |
This commit refactors the
FunctionToolclass and add a new functiongenerate_docstringin thefunction_tool.pyfile.Description
It adds a new method
generate_openai_tool_schemathat uses an optional assistant model to generate the OpenAI tool schema for the specified function. If no assistant model is provided, it defaults to creating a GPT_4O_MINI model. The function's source code is used to generate a docstring and schema, which are validated before returning the final schema.generate_docstringis used to generate a docstring. If schema generation or validation fails, the process retries up to two times. This refactor improves the functionality and flexibility of theFunctionToolclass.Motivation and Context
[Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
https://github.com//issues/949
Types of changes
What types of changes does your code introduce? Put an
xin all the boxes that apply:Implemented Tasks
Checklist
Go over all the following points, and put an
xin all the boxes that apply.If you are unsure about any of these, don't hesitate to ask. We are here to help!