Added "function" capabilities #298

Eduardo-T · 2023-06-14T23:19:56Z

This fork adds the new function capabilities. Check it out.

AESIRZZW · 2023-06-15T07:32:31Z

@TheoKanning Help review this change when you have time, thanks in advance.

Andrewcpu

Not a full review, but the unnecessary changes stemming from the local maven repo tutorial should be removed..
edit: and that weird dependency is sus to me.

README.md

Andrewcpu · 2023-06-15T22:07:57Z

api/build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'java-library'
 apply plugin: "com.vanniktech.maven.publish"

 dependencies {
-    implementation 'com.fasterxml.jackson.core:jackson-annotations:2.9.0'
+    api 'com.fasterxml.jackson.core:jackson-annotations:2.9.0'


Why does this have to change?

It is also being used by the 'service' module.

applyLocalPublish.gradle

localPublish.gradle

Andrewcpu · 2023-06-15T22:10:31Z

service/build.gradle

@@ -5,7 +5,8 @@ dependencies {
    api project(":client")
    api 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:adapter-rxjava2:2.9.0'
-    implementation 'com.squareup.retrofit2:converter-jackson:2.9.0'
+    implementation 'com.squareup.retrofit2:converter-jackson:2.7.2'
+    implementation 'com.kjetland:mbknor-jackson-jsonschema_2.13:1.0.39'


This build of com.kjetland:mbknor-jackson-jsonschema_2.13:1.0.39 is very vulnerable and sus?
Why would you downgrade the jackson converter to 2.7.2?
https://mvnrepository.com/artifact/com.kjetland/mbknor-jackson-jsonschema_2.13/1.0.39

^ This package is unmaintained and vulnerable

publishToLocal.sh

publishToLocal.bat

Eduardo-T · 2023-06-16T06:21:47Z

Thanks @Andrewcpu,

The dependency downgrade was a mistake, I fixed it. And mbknor-jackson-jsonschema_2.13:1.0.39 was changed to mbknor-jackson-jsonschema_2.12:1.0.39 fixing its vulnerabilities. It is needed for the API to work (as seen here). But if we are going to talk about vulnerabilities, com.squareup.retrofit2:converter-jackson:2.9.0 already has some.

Feel free to update anything you need when doing the pull. I'm not a GitHub expert, but from what I know I think you can decide what to include and what not. I changed the .md and added the sections you commented with '?', so that people looking at my fork could install it on their own computer and use it instantly. You can leave only the necessary changes in the code.

If that's not possible, let me know, and I'll help, once again, with the necessary changes.

Eduardo-T · 2023-06-16T07:47:57Z

Hello again @Andrewcpu,

After doing some research, I found that you could indeed make some changes, but it was tedious. So I already made them myself.

I've also added information on how to use the new feature in the README. Tell me what you think.

Grogdunn · 2023-06-16T12:58:51Z

@Eduardo-T check this out optionfactory@024ecb9

on the documentation function_call (on top level) should be a string ["auto", "none"] ]or an object (containing a string 😮‍💨 )

Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via {"name":\ "my_function"} forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present.

… or a string

Eduardo-T · 2023-06-16T17:20:04Z

@Eduardo-T check this out optionfactory@024ecb9

on the documentation function_call (on top level) should be a string ["auto", "none"] ]or an object (containing a string 😮‍💨 )
Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via {"name":\ "my_function"} forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present.

Good eye! I have merged the changes. Thanks for noticing and fixing it.

Grogdunn · 2023-06-19T09:37:46Z

Thx @Eduardo-T ported your changes to my fork 👍

…ect mapper which is required when using the library in Kotlin

lumiseven · 2023-06-19T10:37:05Z

@Eduardo-T
Thank you for your pr, I tried it and it works very well.
But if I use Stream mode(Stream=True), the type of choices.0.delta.function_call.arguments is in plain text format, so it would be better to use StringSerializer and StringDeserializer for the getArguments method in ChatFunctionCallMixIn?

davidb-e4s · 2023-06-19T11:02:06Z

Just opened a PR to allow your changes to work with Kotlin @Eduardo-T

TheoKanning · 2023-06-19T16:56:06Z

@Eduardo-T Thanks for doing this! I merged another PR that created some small conflicts, and can you add a basic test for this? Thanks again

Eduardo-T · 2023-06-19T18:41:06Z

@Eduardo-T
Thank you for your pr, I tried it and it works very well.
But if I use Stream mode(Stream=True), the type of choices.0.delta.function_call.arguments is in plain text format, so it would be better to use StringSerializer and StringDeserializer for the getArguments method in ChatFunctionCallMixIn?

Thanks! Yes, I am currently working on an update that allows stream completions. I will be sharing it soon.

Allowing ObjectMapper to be overridden (for kotlin to work)

Eduardo-T · 2023-06-19T23:15:43Z

@Eduardo-T
Thank you for your pr, I tried it and it works very well.
But if I use Stream mode(Stream=True), the type of choices.0.delta.function_call.arguments is in plain text format, so it would be better to use StringSerializer and StringDeserializer for the getArguments method in ChatFunctionCallMixIn?

I implemented the solution. You can refer to "OpenAiApiFunctionsWIthStreamExample.java" for an example.

Basically, for practical purposes, the stream can be mapped to a "ChatMessageAccumulator" which will append the function's and message's chunks, bringing everything together without you having to deal with it manually.

The changes now also take care of the "plain text format" issue you mentioned, as each chunk is converted to a TextNode, and when finished, the accumulated version is converted to a JsonNode which is most likely an ObjectNode. In general, you shouldn't even care about this, unless you're creating your own executor or something.

So my general recommendation would be to have a FunctionExecutor, and let it do the dirty work for you. For example:

First, configure the executor of your function:

functionBuilder.executor(WeatherRequest.class, w -> new WeatherResponse(w.location, w.unit, 25, "sunny"));

Then, use FunctionExecutor to get the response:

WeatherResponse functionExecutionResponse = functionExecutor.execute(chatFunctionCall);

Or even better:

ChatMessage callResponse = functionExecutor.executeAndConvertToMessageHandlingExceptions(chatFunctionCall);

That way you can just add it to the conversation right away without even worrying about exceptions.

Eduardo-T · 2023-06-20T00:26:05Z

@Eduardo-T Thanks for doing this! I merged another PR that created some small conflicts, and can you add a basic test for this? Thanks again

No problem! It is done.

It now supports functions, functions with streaming, has tests and some documentation on some classes and also information in the README.md.

@TheoKanning

shaun-wild · 2023-06-20T11:49:54Z

I'm a fan of the function executing solution you've come up with here, but personally I don't feel like it fits within the premise of the openai-java wrapper, it feels to me like its doing too much and would be better suited as a separate library.

Eduardo-T · 2023-06-20T16:25:30Z

I'm a fan of the function executing solution you've come up with here, but personally I don't feel like it fits within the premise of the openai-java wrapper, it feels to me like its doing too much and would be better suited as a separate library.

Thank you!

I don't think it's much really, everything added is necessary for the optimal and easy working of the new functions feature, and it's inside the 'service' module.

I've seen other libraries where you have to manually write your schema objects for your functions, and it's horrible. I didn't want that to happen to this library, it is characterized by being nice and simple to use.

The only classes that could stand out, and I suppose they are the ones you mention being a fan of, would be FunctionExecutor and ChatMessageAccumulator, both optional but highly recommended, since they allow the new mechanics to be implemented quite well, with a similar simplicity to other programming languages. But really that's all.

So there aren't really any additions other than necessary changes, like api objects, serializers and deserializers, etc.

Adding one more module to the project I think would add complexity, although I am interested in your proposal, could you give more details?

aaronuu · 2023-06-21T03:22:04Z

I would like to know when it can be merged into the main line

@TheoKanning

Eduardo-T added 5 commits June 14, 2023 17:11

Initial commit

d315783

Updated Readme

dab34ca

Added the ability to publish to the local repository.

ced9cd1

Stylized the README a bit more.

58552ca

Fixed typo

4023f7d

Andrewcpu suggested changes Jun 15, 2023

View reviewed changes

Eduardo-T added 2 commits June 15, 2023 20:05

Fixed visibility of variables in example

0eb553e

Improved the usage of functions with an executor.

8f979be

Eduardo-T added 3 commits June 16, 2023 00:48

Reverted changes.

36d6f84

Added information about functions to the README.md

b9ba373

Change reversed.

3f6c9f5

Added some helper method and cleaned the example a little bit.

25eee8f

🐛 custom serialization of function_call parameter should be an object…

9b4313a

… or a string

Eduardo-T added 3 commits June 16, 2023 11:44

Fixed example and added static instantiation method

2715c55

Added null check

f300b17

Set project version to SNAPSHOT and fixed vulnerable dependency

fd91f5e

Allowing objectmapper to be overriden in order to supply a custom obj…

13e69c1

…ect mapper which is required when using the library in Kotlin

Updating the constructor to use the setter to be consistant

28c7af6

Eduardo-T added 2 commits June 19, 2023 12:45

Merge pull request #2 from davidb-e4s/main

de4bb85

Allowing ObjectMapper to be overridden (for kotlin to work)

Merged changes from upstream

6e44d11

Eduardo-T added 4 commits June 19, 2023 14:23

Merge remote-tracking branch 'origin/main'

be82bca

Added usage of streams with functions

69aa285

Removed .DS_Store files and updated .gitignore

1fd514c

Small fixes and improvements and added tests

b28d659

Simplified example a little and updated README

7b98dc6

TheoKanning merged commit c24e78b into TheoKanning:main Jun 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added "function" capabilities #298

Added "function" capabilities #298

Eduardo-T commented Jun 14, 2023

AESIRZZW commented Jun 15, 2023

Andrewcpu left a comment •

edited

Loading

Andrewcpu Jun 15, 2023

Eduardo-T Jun 16, 2023

Andrewcpu Jun 15, 2023

Andrewcpu Jun 15, 2023 •

edited

Loading

Eduardo-T commented Jun 16, 2023

Eduardo-T commented Jun 16, 2023

Grogdunn commented Jun 16, 2023

Eduardo-T commented Jun 16, 2023

Grogdunn commented Jun 19, 2023

lumiseven commented Jun 19, 2023

davidb-e4s commented Jun 19, 2023

TheoKanning commented Jun 19, 2023

Eduardo-T commented Jun 19, 2023

Eduardo-T commented Jun 19, 2023 •

edited

Loading

Eduardo-T commented Jun 20, 2023 •

edited

Loading

shaun-wild commented Jun 20, 2023

Eduardo-T commented Jun 20, 2023 •

edited

Loading

aaronuu commented Jun 21, 2023 •

edited

Loading

Added "function" capabilities #298

Added "function" capabilities #298

Conversation

Eduardo-T commented Jun 14, 2023

AESIRZZW commented Jun 15, 2023

Andrewcpu left a comment • edited Loading

Choose a reason for hiding this comment

Andrewcpu Jun 15, 2023

Choose a reason for hiding this comment

Eduardo-T Jun 16, 2023

Choose a reason for hiding this comment

Andrewcpu Jun 15, 2023

Choose a reason for hiding this comment

Andrewcpu Jun 15, 2023 • edited Loading

Choose a reason for hiding this comment

Eduardo-T commented Jun 16, 2023

Eduardo-T commented Jun 16, 2023

Grogdunn commented Jun 16, 2023

Eduardo-T commented Jun 16, 2023

Grogdunn commented Jun 19, 2023

lumiseven commented Jun 19, 2023

davidb-e4s commented Jun 19, 2023

TheoKanning commented Jun 19, 2023

Eduardo-T commented Jun 19, 2023

Eduardo-T commented Jun 19, 2023 • edited Loading

Eduardo-T commented Jun 20, 2023 • edited Loading

shaun-wild commented Jun 20, 2023

Eduardo-T commented Jun 20, 2023 • edited Loading

aaronuu commented Jun 21, 2023 • edited Loading

Andrewcpu left a comment •

edited

Loading

Andrewcpu Jun 15, 2023 •

edited

Loading

Eduardo-T commented Jun 19, 2023 •

edited

Loading

Eduardo-T commented Jun 20, 2023 •

edited

Loading

Eduardo-T commented Jun 20, 2023 •

edited

Loading

aaronuu commented Jun 21, 2023 •

edited

Loading