Return raw response from schema

[leuchtdiode]

Hi,

I have a question. I have a json schema, which I'm sending via parameter "responseModel" like:

$instructor->request(
    input: $prompt,
    responseModel: $schema,
    model: $model
)

As my schema is dynamic from the database, I cannot map it to a certain class. I just want to have the chat response as array and store it as JSON. I'm using enum's in the schema. I always get the Exception:

Exception: Enum must have x-php-class field with the target class name

Does anyone know how I can handle this? I just want to have the JSON response as array :)

Thx & BR,
Alex

[krotname]

For a dynamic schema you should not need to map every enum to a PHP enum class.

In current main, array schemas go through ResponseModelFactory::fromJsonSchema(). If the root schema has no x-php-class, it falls back to Cognesy\Dynamic\Structure. Also, JsonSchemaParser::makeEnumOrOptionProperty() treats an enum with values but without x-php-class as a scalar schema, not as a PHP enum.

So a plain JSON Schema enum should look like this:

$schema = [
    'type' => 'object',
    'properties' => [
        'status' => [
            'type' => 'string',
            'enum' => ['draft', 'published'],
        ],
    ],
    'required' => ['status'],
    'additionalProperties' => false,
];

$result = $instructor->request(
    input: $prompt,
    responseModel: $schema,
    model: $model,
);

$array = $result instanceof \Cognesy\Dynamic\Structure
    ? $result->toArray()
    : (array) $result;

I would check two things:

1. remove any generated x-php-class from enum fields unless it really points to a PHP enum class
2. make sure you are on a version that contains the newer JsonSchemaParser behavior; older versions may have treated every enum as a PHP enum

If you actually want PHP enum hydration, then x-php-class has to point to the enum class. If you only want JSON/array output, keep it as a plain JSON Schema type + enum.

[leuchtdiode]

Thank you for clarification. Now i saw that composer installed 0.10.6, because of other dependency issues, so I wasn't (nearly) using the newest version. I will try resolve the issues and try again with v2.3.1 :)

BR,
Alex

[leuchtdiode]

@krotname Now I have the newest version, but I get exception: RuntimeException: Twig is not installed. Run 'composer require twig/twig'

Is a template engine mandatory when I only want to get the raw array response?

[krotname]

For the current code, Twig is not mandatory conceptually for "I want an array back", but it is required by the default template path.

twig/twig is listed as a Composer suggest, not a hard require, but TemplateProvider defaults to TemplateEngineConfig::twig() and then throws exactly this error if Twig\Environment is not available. The built-in instructor prompt templates are also .twig files.

So the simplest fix is:

composer require twig/twig

If you want to avoid Twig entirely, you would need to configure a different template engine/provider, for example the Arrowpipe driver, but the default out-of-the-box request path currently expects Twig even if your response model itself is just a JSON schema / dynamic structure.

[leuchtdiode]

Alright, thank you :)

[ddebowczyk]

2.5.0 will be released today - it makes things even simpler and cleaner