Support the new "Structured Outputs"

[andehr]

First check

• I added a descriptive title to this issue.
• I used the GitHub search to look for a similar issue and didn't find it.
• I searched the Marvin documentation for this feature.

Describe the current behavior

Not yet released, but as of the merge of PR #957 we can specify the response format of messages returned from Open AI as a JSON object.

But as of August 6th, Open AI have extended the possible values of the the response_format. You can now specify any Pydantic base model, and they guarantee responses that conform to its schema.

See the Open AI guide here.

Describe the proposed behavior

Therefore, it would be very useful to extend marvin support such that we could now do:

Assistant(instructions=some_instructions, response_format=SomePydanticModel)

Example Use

No response

Additional context

No response

[zzstoatzz]

hi @andehr I agree we could leverage this pretty nicely, not only in assistants but pretty much everywhere

do you have any interest in making a contribution to this effect? I'd be happy to work with you on it

[andehr]

Great! I'm interested, but on hols for August, if you haven't had a start before I'm back, I'll have a go at perhaps a work-in-progress PR as soon as I can!

Main caveat I noticed after posting the above is that the model must be gpt-4o-2024-08-06 or later to work with this stuff - so might be worth bumping up the default version again.