minimaxir / simpleaichat

Python package for easily interfacing with chat apps, with robust features and minimal code complexity.
MIT License
3.43k stars 224 forks source link

Improve documentation on tools a bit #48

Open skorokithakis opened 11 months ago

skorokithakis commented 11 months ago

The documentation on tools is currently a bit too obtuse for me. I'm left with some questions:

What happens when the model decides to use a tool? Does that function get called? With what, the entire query, or something else? Is this process repeated multiple times, or is it just a once-off? What does the second call have as inputs? Just the context?

Maybe I need a better example, but what I'm thinking of is a sort of functiony "smart home" helper, where you tell the AI to return a function to be called, such as toggle_lights("bedroom", "on").

Are these tools meant to enhance the context of the AI instead? Maybe that should be mentioned in the docs. I just can't grok it at all right now, because I'm not sure of the intended use case that tools are looking to solve.