New content format #122

rawnly · 2023-11-14T10:36:24Z

What

Includes changes from #115

content of ChatQuery is now ChatContent.

Missing

Some tests. tools / tool_calls / content_filter.

Problems

One thing I noticed is that even tho the available format for the content is Array<ChatContent>/String the response received from the api will always be a string.

I tested this branch on a real application and sometimes I have decoding errors, even tho analyzing the response I really can't tell what's wrong.

Affected Areas

Chat related models

Signed-off-by: rawnly <[email protected]>

…to new-content-format

rawnly · 2023-11-14T10:38:34Z

I'd love to hear some feedback about the ChatContent. Swift is not my main language so I might have done something dumb or over-engineered 😅

ingvarus-bc · 2023-11-14T11:09:46Z

Addressing the issue about decoding errors, can't it be the case with partial json receiving, the issue which was just recently solved here?

Additionally, what do you think about this OpenAI Chat Chunk Object? As it says in docs, it seems to be returning chat completion now, that is why it is just a string.

I may be wrong, but it seems intuitive to me that if we are about to receive mixed content, it should be done by streaming methods instead of completions. 🤔

rawnly · 2023-11-14T11:12:14Z

Addressing the issue about decoding errors, can't it be the case with partial json receiving, the issue which was just recently solved here?

Absolutely I missed that! I'll take another spin to check if this happens again

Sources/OpenAI/Public/Utilities/CodableUtilities.swift

Tests/OpenAITests/OpenAITestsDecoder.swift

Sources/OpenAI/Public/Models/ChatQuery.swift

ingvarus-bc · 2023-11-14T12:22:49Z

@rawnly I must really highlight your amazing work here, thank you, for your contribution and that you care about the project! ✨

There is a lot going on in code, will take me some time to get into it, what can tell as of now, we definitely need to break down everything that is going on inside ChatQuery.swift into separate files as OpenAI have a lot of things encapsulated in one another in their Chat API. And it is best to preserve everything that is already there as it is, just "deprecate" it upon release.

ps. Do you still have decoding errors after the fix?

rawnly · 2023-11-14T12:38:11Z

ps. Do you still have decoding errors after the fix?

looks like it's fixed now 🚀

Signed-off-by: rawnly <[email protected]>

rawnly · 2023-11-14T12:58:54Z

Btw one thing i noticed is that new models kind of ignore the functions passed to them, maybe it's worth support both for backwards compatibility and mark functions as deprecated(?)

ingvarus-bc · 2023-11-14T13:03:20Z

Btw one thing i noticed is that new models kind of ignore the functions passed to them, maybe it's worth support both for backwards compatibility and mark functions as deprecated(?)

Yes, totally agree, that what I was suggesting, here:

There is a lot going on in code, will take me some time to get into it, what can tell as of now, we definitely need to break down everything that is going on inside ChatQuery.swift into separate files as OpenAI have a lot of things encapsulated in one another in their Chat API. And it is best to preserve everything that is already there as it is, just "deprecate" it upon release.

Signed-off-by: rawnly <[email protected]>

rawnly · 2023-11-14T13:09:02Z

Now it should be more clear where things are and it should be easier to manage new models too

rawnly · 2023-11-14T13:37:32Z

Regarding tools etc, what do you think about smth like

    Tool(
        type: .function,
        value: .function(
            .init( // `Tool.Function`
                name: "get_weather",
                description: "Get the weather" 
            )
        )
    )

parameters is still JSONObject but now i added an .empty static let to allow no params (which is the default value in Tool.Function constructor

ingvarus-bc · 2023-11-14T13:42:36Z

Regarding tools etc, what do you think about smth like
    Tool(
        type: .function,
        value: .function(
            Tool.Function(
                name: "get_weather",
                description: "Get the weather" 
            )
        )
    )
parameters is still JSONObject but now i added an .empty static let to allow no params (which is the default value in Tool.Function constructor

Is this the one from message/tool_calls/ ?

Seems pretty nice and logical to me 👍

rawnly · 2023-11-14T13:43:21Z

nop it's the one from here https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools

ingvarus-bc · 2023-11-14T13:47:25Z

nop it's the one from here https://platform.openai.com/docs/api-reference/chat/create#chat-create-tools

Got you, yeah, cool. There is one additional field for parameters which function accepts 🤔
I am wondering if we can reuse the same tools in messages as well

rawnly · 2023-11-14T13:56:52Z

I am wondering if we can reuse the same tools in messages as well

let me push this code so you can look at the model code :)

still missing tests Signed-off-by: rawnly <[email protected]>

Sources/OpenAI/Public/Models/Chat/Chat.swift

ingvarus-bc · 2023-11-14T14:23:33Z

Sources/OpenAI/Public/Models/Chat/Chat.swift

+        case functionCall = "function_call"
+    }
+
+    public init(role: Role, content codable: Codable? = nil ,name: String? = nil, functionCall: ChatFunctionCall? = nil) {


What do you think about typealiasing this Codable? to something like StringOrChatContent(as a suggestion, maybe you'll come up with something better), because I am testing it now and it is not very clear what to pass there 🤔

absolutely nice idea!

maybe also throwing an error if passing the wrong codable?

yeah, that would be neat 🔥

Sources/OpenAI/Public/Models/Chat/Chat.swift

rawnly · 2023-11-17T09:38:51Z

What do you think of adding one more level of abstraction for chats method, it is the most complex and the most customisable one and there are a lot of cases when incorrect setting will cause an error for sure

what are you thinking about?

ingvarus-bc · 2023-11-17T09:47:10Z

what are you thinking about?

I have two things in mind:

A couple of protocol level methods which will build the Chat query according to the settings and properties provided, to be mindful about the errors which we can predict for sure.
Or we can add some error handling and fallbacks inside of ChatQuery constructor.

Why I think about it, is because OpenAI documentation for chats is clearly not very straightforward and doesn't cover most of the cases, so devs who will be just figuring it out may have a lot of struggle with these settings and properties.

What do you think?

ingvarus-bc · 2023-11-17T15:17:22Z

@rawnly, hey, we are on our way to make a release tag today, do you have some work in progress or is it okay if I push a couple of things here? ✨

rawnly · 2023-11-17T16:11:48Z

@rawnly, hey, we are on our way to make a release tag today, do you have some work in progress or is it okay if I push a couple of things here? ✨

Go! I don't have anything wip atm

rawnly · 2023-11-17T16:13:10Z

What do you think ?

makes sense

A couple of protocol level methods which will build the Chat query according to the settings and properties provided, to be mindful about the errors which we can predict for sure

you mean something like a builder?

ingvarus-bc · 2023-11-17T16:17:19Z

you mean something like a builder?

yep, sort of 👍
I am gonna push slight refactoring and will deprecate completions (as they're 'legacy' now and chats fully cover their functionality) and will merge the PR

And as of the builder, I think it will be a good addition in the next patch

may I be missing something? what do you think, have you encountered any issues in scope of this PR?🤔

rawnly · 2023-11-17T16:33:26Z

you mean something like a builder?

yep, sort of 👍 I am gonna push slight refactoring and will deprecate completions (as they're 'legacy' now and chats fully cover their functionality) and will merge the PR

And as of the builder, I think it will be a good addition in the next patch

may I be missing something? what do you think, have you encountered any issues in scope of this PR?🤔

lgtm can you test the tools in a real request? I didn't have the time and now i'm not at home 👀

Signed-off-by: rawnly <[email protected]>

sonarcloud · 2023-11-19T09:50:23Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
21 Code Smells

No Coverage information
3.6% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

rawnly · 2023-11-19T10:03:36Z

Current problem is that according to the api spec id and type are required. But when streaming they can be optional. But we need type to decode the function value :/

Below a stream response returned from the api:
pretty response here

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"role":"assistant","content":null,"tool_calls":[{"index":0,"id":"call_S1iPLro8pNoUH2WOqYvQt6aD","type":"function","function":{"name":"add_to_calendar","arguments":""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"{\n"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" "}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" \""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"start"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"\":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" \""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"202"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"3"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"-"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"11"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"-"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"20"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"T"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"00"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"00"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"00"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"Z"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"\",\n"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" "}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" \""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"title"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"\":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" \""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"F"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"eder"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"ico"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"'s"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" Birthday"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"\",\n"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" "}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" \""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"end"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"\":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":" \""}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"202"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"3"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"-"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"11"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"-"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"21"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"T"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"00"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"00"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":":"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"00"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"Z"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"\"\n"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{"tool_calls":[{"index":0,"function":{"arguments":"}"}}]},"finish_reason":null}]}

{"id":"chatcmpl-8MYjk8CJDQT2OhPpeaaTuUAoEFeBI","object":"chat.completion.chunk","created":1700387436,"model":"gpt-4-1106-preview","system_fingerprint":"fp_a24b4d720c","choices":[{"index":0,"delta":{},"finish_reason":"tool_calls"}]}

[DONE]

ingvarus-bc · 2023-11-20T10:05:55Z

Current problem is that according to the api spec id and type are required. But when streaming they can be optional. But we need type to decode the function value :/

First what comes to mind with this problem is trying to decode chunk and in case of decoding error to decode a completion result. I wonder if it is actually possible to ask gpt for what kind of result we want. There is stream parameter, isn't it responsible for that?

bcherry · 2023-12-18T20:04:24Z

I'm using this PR in a project and I found that if you pass a single instance of ChatContent, rather than array of [ChatContent], it will just set the content to nil and fail only at request time with a cryptic "content and role must not be nil" message. The ergonomics of this seem problematic to me, since the swift type checker is unable to help. Maybe at least allowing a single instance of ChatContent to be passed, and then converted to an array, would be good. Otherwise maybe best to not offer an initializer that accepts StringOrChatContent (aka any Codable), so the user isn't exposed to the API variability under the hood. They would either use the explicit string-based or explicit array-of-content-based initializer.

bcherry · 2023-12-18T20:31:02Z

Sources/OpenAI/Public/Models/Chat/Message.swift

+        self.content = content
+        self.name = name
+        self.functionCall = functionCall
+        self.toolCalls = []


this initializer is a trap for vision requests - you'll get an invalid request error from sending an empty array in toolCalls (which isn't supported for this model yet). You need to use the other initializer with explicit toolCalls: nil.

Would it be safe to default to nil here?

bcherry · 2023-12-18T22:04:43Z

Sources/OpenAI/Public/Models/Chat/Message.swift

+
+import Foundation
+
+public struct Message: Codable, Equatable {


This is a pretty generic name for a type - I found it to be a problem in my project that already had its own Message type defined, and OpenAI.Message didn't work because the OpenAI module also contains a class called OpenAI (see this discussion on this potential flaw in Swift)

The only thing that worked for me was renaming the type in my own project so Message was available for this package to use.

Good point, I think it would be a good idea to use some naming pattern, to avoid confusions, though this would mean that all projects using this package would need to update namings.

sroyaura · 2023-12-22T16:19:52Z

Sources/OpenAI/Public/Models/Chat/ChatTool.swift

+}
+
+public struct ToolCall: Codable, Equatable {
+    public let index: Int


I'm getting decoding errors because index is not present in the response.

▿ DecodingError ▿ keyNotFound : 2 elements - .0 : CodingKeys(stringValue: "index", intValue: nil) ▿ .1 : Context ▿ codingPath : 5 elements - 0 : CodingKeys(stringValue: "choices", intValue: nil) ▿ 1 : _JSONKey(stringValue: "Index 0", intValue: 0) ▿ rep : Rep - index : 0 - 2 : CodingKeys(stringValue: "message", intValue: nil) - 3 : CodingKeys(stringValue: "tool_calls", intValue: nil) ▿ 4 : _JSONKey(stringValue: "Index 0", intValue: 0) ▿ rep : Rep - index : 0 - debugDescription : "No value associated with key CodingKeys(stringValue: \"index\", intValue: nil) (\"index\")." - underlyingError : nil

oxy9en · 2024-01-31T18:45:59Z

Hi Guys. Do you have any updates about this PR?

kalafus · 2024-02-15T21:30:36Z

@oxy9en , main is in sync with api specification as of pull (excepting that Edits endpoint is obsolete, betas not implemented).

rawnly and others added 5 commits November 9, 2023 22:12

fix: added some utilities

43ff443

Signed-off-by: rawnly <[email protected]>

fix: updated Chat/content to conform the new API

be60845

Signed-off-by: rawnly <[email protected]>

Merge branch 'MacPaw:main' into new-content-format

06784ca

tests: added testChatCompletionStreamResult

250d0e4

Signed-off-by: rawnly <[email protected]>

Merge branch 'new-content-format' of github.com:rawnly/swiftopenai in…

2fe63b3

…to new-content-format

ingvarus-bc added the enhancement New feature or request label Nov 14, 2023

rawnly commented Nov 14, 2023

View reviewed changes

Sources/OpenAI/Public/Utilities/CodableUtilities.swift Show resolved Hide resolved

rawnly commented Nov 14, 2023

View reviewed changes

Tests/OpenAITests/OpenAITestsDecoder.swift Outdated Show resolved Hide resolved

ingvarus-bc reviewed Nov 14, 2023

View reviewed changes

Sources/OpenAI/Public/Models/ChatQuery.swift Outdated Show resolved Hide resolved

ingvarus-bc added the help wanted Extra attention is needed label Nov 14, 2023

rawnly added 2 commits November 14, 2023 13:45

fix: generic init for Chat

791484c

Signed-off-by: rawnly <[email protected]>

tests: updated test

bd9e723

Signed-off-by: rawnly <[email protected]>

refactor: moved chat related models into a separate folder

6aee2b6

Signed-off-by: rawnly <[email protected]>

rawnly requested a review from ingvarus-bc November 14, 2023 13:08

feat: introduced Tool

927d960

still missing tests Signed-off-by: rawnly <[email protected]>

ingvarus-bc reviewed Nov 14, 2023

View reviewed changes

Sources/OpenAI/Public/Models/Chat/Chat.swift Outdated Show resolved Hide resolved

Deprecations + cosmetic fix

4a258f4

Ihor Makhnyk and others added 12 commits November 17, 2023 19:25

Fix Demo App

9a7f1d1

Merge branch 'MacPaw:main' into new-content-format

b2b9358

fix: changed visibility

4380608

Signed-off-by: rawnly <[email protected]>

added shorthand initializers to JSONObject Item

378d985

Signed-off-by: rawnly <[email protected]>

feat: add tool_calls to message

098aeb7

Signed-off-by: rawnly <[email protected]>

fix: improved dx

25d2a49

Signed-off-by: rawnly <[email protected]>

fix: add tool_calls to stream result

d393a43

Signed-off-by: rawnly <[email protected]>

fix: add enum values

6228d63

Signed-off-by: rawnly <[email protected]>

fix: fixed encoding/decoding for tool

fc91863

Signed-off-by: rawnly <[email protected]>

fix: new init

723a688

Signed-off-by: rawnly <[email protected]>

test: added tests for tools

5e90958

Signed-off-by: rawnly <[email protected]>

fix: optional name

dabc66e

Signed-off-by: rawnly <[email protected]>

bcherry reviewed Dec 18, 2023

View reviewed changes

sroyaura reviewed Dec 22, 2023

View reviewed changes

rawnly closed this Feb 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New content format #122

New content format #122

rawnly commented Nov 14, 2023 •

edited

Loading

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

rawnly commented Nov 14, 2023 •

edited

Loading

ingvarus-bc commented Nov 14, 2023 •

edited

Loading

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

ingvarus-bc Nov 14, 2023 •

edited

Loading

rawnly Nov 14, 2023

rawnly Nov 14, 2023

ingvarus-bc Nov 14, 2023

rawnly commented Nov 17, 2023

ingvarus-bc commented Nov 17, 2023

ingvarus-bc commented Nov 17, 2023

rawnly commented Nov 17, 2023

rawnly commented Nov 17, 2023

ingvarus-bc commented Nov 17, 2023 •

edited

Loading

rawnly commented Nov 17, 2023

sonarcloud bot commented Nov 19, 2023

rawnly commented Nov 19, 2023 •

edited

Loading

ingvarus-bc commented Nov 20, 2023

bcherry commented Dec 18, 2023

bcherry Dec 18, 2023

bcherry Dec 18, 2023

ingvarus-bc Dec 21, 2023

sroyaura Dec 22, 2023

oxy9en commented Jan 31, 2024

kalafus commented Feb 15, 2024 •

edited

Loading


		import Foundation

		public struct Message: Codable, Equatable {

New content format #122

New content format #122

Conversation

rawnly commented Nov 14, 2023 • edited Loading

What

Missing

Problems

Affected Areas

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

rawnly commented Nov 14, 2023 • edited Loading

ingvarus-bc commented Nov 14, 2023 • edited Loading

rawnly commented Nov 14, 2023

ingvarus-bc commented Nov 14, 2023

rawnly commented Nov 14, 2023

ingvarus-bc Nov 14, 2023 • edited Loading

Choose a reason for hiding this comment

rawnly Nov 14, 2023

Choose a reason for hiding this comment

rawnly Nov 14, 2023

Choose a reason for hiding this comment

ingvarus-bc Nov 14, 2023

Choose a reason for hiding this comment

rawnly commented Nov 17, 2023

ingvarus-bc commented Nov 17, 2023

ingvarus-bc commented Nov 17, 2023

rawnly commented Nov 17, 2023

rawnly commented Nov 17, 2023

ingvarus-bc commented Nov 17, 2023 • edited Loading

rawnly commented Nov 17, 2023

sonarcloud bot commented Nov 19, 2023

rawnly commented Nov 19, 2023 • edited Loading

ingvarus-bc commented Nov 20, 2023

bcherry commented Dec 18, 2023

bcherry Dec 18, 2023

Choose a reason for hiding this comment

bcherry Dec 18, 2023

Choose a reason for hiding this comment

ingvarus-bc Dec 21, 2023

Choose a reason for hiding this comment

sroyaura Dec 22, 2023

Choose a reason for hiding this comment

oxy9en commented Jan 31, 2024

kalafus commented Feb 15, 2024 • edited Loading

rawnly commented Nov 14, 2023 •

edited

Loading

rawnly commented Nov 14, 2023 •

edited

Loading

ingvarus-bc commented Nov 14, 2023 •

edited

Loading

ingvarus-bc Nov 14, 2023 •

edited

Loading

ingvarus-bc commented Nov 17, 2023 •

edited

Loading

rawnly commented Nov 19, 2023 •

edited

Loading

kalafus commented Feb 15, 2024 •

edited

Loading