json_schema/Structured Outputs about client

[ericthornton88]

I did not try this with structured outputs, but this worked for me when setting the response format to json

'model' => 'gpt-4o',
'response_format' => [
     'type' => 'json_object'
],

Cross reference to this post

[jrmgx]

Does this package support the new response_format = 'json_schema' option (Structured Outputs).

Would you be able to send the schema in via the $client->chat()->create method as an array?

https://platform.openai.com/docs/guides/structured-outputs

As today, it does not.

The OpenAI announce is quite new, and this library has not been updated yet.
See OpenAI blog post for details: https://openai.com/index/introducing-structured-outputs-in-the-api/

Note that type: json_object is a different thing, here we are talking about the new type: json_schema

[monsieurbab]

+1 to add support for this feature

[thijndehaas]

This can be resolved by passing the json schema as parameter:

'model' => 'gpt-4o',
'response_format' => [
    'type' => 'json_schema',
    'json_schema' => $jsonSchema,
]

For example:

[
    'model' => 'gpt-4o',
    'message' => 'what is 1 + 1?',
    'response_format' => [
        'type' => 'json_schema',
        'json_schema' => [
            "name" => "math_response",
            "strict" => true,
            "schema" => [
                "type" => "object",
                "properties" => [
                    "steps" => [
                        "type" => "array",
                        "items" => [
                            "type" => "object",
                            "properties" => [
                                "explanation" => [
                                    "type" => "string"
                                ],
                                "output" => [
                                    "type" => "string"
                                ]
                            ],
                            "required" => [
                                "explanation",
                                "output"
                            ],
                            "additionalProperties" => false
                        ]
                    ],
                    "final_answer" => [
                        "type" => "string"
                    ]
                ],
                "required" => [
                    "steps",
                    "final_answer"
                ],
                "additionalProperties" => false
            ],
        ]
    ]
];