feat: retriever cookbook and utils change #472
Conversation
|
Important Auto Review SkippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the To trigger a single review, invoke the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
Wendong-Fan
requested review from
zechengz,
lightaime,
dandansamax and
Appointat
There was a problem hiding this comment.
I've reviewed the code and left some simple modification suggestions (some regarding formatting). Well, I'm not sure if I missed anything in the dev meeting. Could you please explain to me why you're moving the role_playing... function into commons.py? Thanks
Co-authored-by: Appointat <[email protected]>
Co-authored-by: Appointat <[email protected]>
Co-authored-by: Appointat <[email protected]>
Hey @Appointat , thanks for the review, in the cookbook I used |
Co-authored-by: Zecheng Zhang <[email protected]>
…retriever into feature/auto_retriever
| def role_playing_with_function( | ||
| task_prompt: str = ("Assume now is 2024 in the Gregorian calendar, " | ||
| "estimate the current age of University of Oxford " | ||
| "and then add 10 more years to this age, " | ||
| "and get the current weather of the city where " | ||
| "the University is located."), | ||
| function_list: Optional[List] = None, | ||
| model_type=None, | ||
| chat_turn_limit=10, | ||
| assistant_role_name: str = "Searcher", | ||
| user_role_name: str = "Professor", | ||
| ) -> None: | ||
| r"""Initializes and conducts a `RolePlaying` with `FunctionCallingConfig` | ||
| session. The function creates an interactive and dynamic role-play session | ||
| where the AI Assistant and User engage based on the given task, roles, and | ||
| available functions. It demonstrates the versatility of AI in handling | ||
| diverse tasks and user interactions within a structured `RolePlaying` | ||
| framework. | ||
|
|
||
| Args: | ||
| task_prompt (str): The initial task or scenario description to start | ||
| the `RolePlaying` session. Defaults to a prompt involving the | ||
| estimation of KAUST's age and weather information. | ||
| function_list (list): A list of functions that the agent can utilize | ||
| during the session. Defaults to a combination of math, search, and | ||
| weather functions. | ||
| model_type (ModelType): The type of chatbot model used for both the | ||
| assistant and the user. Defaults to `GPT-4 Turbo`. | ||
| chat_turn_limit (int): The maximum number of turns (exchanges) in the | ||
| chat session. Defaults to 10. | ||
| assistant_role_name (str): The role name assigned to the AI Assistant. | ||
| Defaults to 'Searcher'. | ||
| user_role_name (str): The role name assigned to the User. Defaults to | ||
| 'Professor'. | ||
|
|
||
| Returns: | ||
| None: This function does not return any value but prints out the | ||
| session's dialogues and outputs. | ||
| """ |
There was a problem hiding this comment.
Why the role_playing_with_function example is moved to utils?
There was a problem hiding this comment.
Let's not put hard coded example into utils.
There was a problem hiding this comment.
Why the
role_playing_with_functionexample is moved toutils?
Hey @lightaime , in the RAG cookbook I used role_playing_with_function as example,
from camel.utils import role_playing_with_function
from camel.functions import MATH_FUNCS # import another function from camel
role_playing_with_function(
task_prompt=(
"What is the main termination reasons for AI Society dataset, how many number of messages did camel decided to limit, what's the value plus 100?"
),
function_list=[*RETRIEVER_FUNCS, *MATH_FUNCS],
)
I think this function will be regularly used as a common example function to show how to implement tasks by using different functions with multi-agents, so I moved this function into utils, even this function has set default values, it still allows the user to input their own parameters including task_prompt, function_list,model_type, chat_turn_limit, assistant_role_name,user_role_name to adjust the behavior of this function with flexibility.
There was a problem hiding this comment.
Also for later integrated tools/function, we can use this role_playing_with_function to easily test/show how it works, WDYT?
Description
This this a sub PR of #410 only containing retriever cookbook and utils change based on auto retriever, with a small typo fix
Motivation and Context
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!