Function calls

[MQahawish]

is there an example how to use function calling ? , I see the FunctionMessage class , but i'm a bit lost on how to use it.

[tzolov]

@MQahawish we are working on providing a generic function calling support. It is still a WIP, but if you are interested, here is the spike branch.

The (OpenAI) function calling looks like this:

You can, already, use the low-level OpenAiApi to implement the this flow: OpenAiApiToolFunction.

But this is too involving and breaks the portability. In the spike we’ve mange to generalise the approach and hide the complexity within the ChatClient implementation.

Now you can call a functions that are registered as Beans like in OpenAiChatClientToolFunction3IT or dynamically passed through the prompt call: OpenAiChatClientToolFunction4IT.

NOTE: This is still a WIP, but hopefully will have something stable soon.

Let me know if you have some Function calling experience examples, other models … that I can use to validate the suggested approach.

[pankajtandon]

Hi tzolov!

Thanks for the work in this area!
I love what you already built in OpenAiApi class but did not see a working example of a function calling flow.
I've been interested in this feature since it was announced so I took a shot at implementing it by slightly modifying the OpenAiChatClient and writing a test. I think I've kept the client pretty generic and buried all the function(s) specific behavior in a separate class. As far as I can tell, it implements the flow you've described above and works flawlessly!
Please review this PR for consideration to add to the codebase:

#293

Thanks!
Pankaj

[tzolov]

For you information the #299 will bring initial function calling support for OpenAI.
Here is the docs part of this PR:
Function Calling Spring AI Reference.pdf

[tzolov]

@MQahawish , about

is there an example how to use function calling ? , I see the FunctionMessage class , but i'm a bit lost on how to use it.

There is a PR that is to close to be merged. It would provide samples and documentation as explained here -> #193 (comment)

[tzolov]

Initial support for Function calling is provided with: ffd8222
Follow the related documentation: https://docs.spring.io/spring-ai/reference/api/clients/functions/openai-chat-functions.html
Further improvements, extensions and simplifications will come with next (0.9.0) release.