Move Automators to Structured Output (#3577170) · Issues · project / ai

Move Automators to Structured Output

>>> [!note] Migrated issue   Reported by: [marcus_johansson](https://www.drupal.org/user/385947) Related to !1291 >>> [Tracker] Update Summary: [One-line status update for stakeholders] Short Description: [One-line issue summary for stakeholders] Check-in Date: MM/DD/YYYY Metadata is used by the <a href="https://www.drupalstarforge.ai/" title="AI Tracker">AI Tracker.</a> Docs and additional fields <a href="https://www.drupalstarforge.ai/ai-dashboard/docs" title="AI Issue Tracker Documentation">here</a>. [/Tracker] <h3 id="summary-problem-motivation">Problem/Motivation</h3> Currently Automators is using pseudo json to create the output that is required when calling AI. This has historical reasons that are all explained here: <a href="https://www.drupal.org/project/ai/issues/3565806" title="Status: Closed (fixed)">#3565806: [Discuss] Move Automators to Structured Output</a>. The main reason was that structured output only existed in OpenAI when the Automators was built and that it was faster inference with pseudo json. Both are not issues anymore. Since 2.0.0 will be breaking, this also means that we can change behaviour, in this case for the better, but still changed behaviour. As example for the office hours, this means that instead of appending this to the prompt: <pre>\n\n\n\nDo not include any explanations, only provide a RFC8259 compliant JSON response following this format without deviation.\n[{"value": {"day": "1 for monday, 2 for tuesday and so on", "starthours": "opening hour in hi format, so 16:00 would be 1600", "endhours": "closing hour in hi format, so 20:00 would be 2000"}].\n\nOnly give back the days they are open.</pre>We should add this in the structured output: <pre>{   "schema": {     "type": "array",     "title": "OpeningHours",     "items": {       "type": "object",       "additionalProperties": false,       "required": [         "value"       ],       "properties": {         "value": {           "type": "object",           "additionalProperties": false,           "required": [             "day",             "starthours",             "endhours"           ],           "properties": {             "day": {               "type": "string",               "title": "Day",               "pattern": "^[1-7]$"             },             "starthours": {               "type": "string",               "title": "Start Hours",               "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$"             },             "endhours": {               "type": "string",               "title": "End Hours",               "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$"             }           }         }       }     }   },   "name": "opening_hours",   "strict": true }</pre>With possible an extra append for one shot learning reasons. We should before we start, check if we can derive this from the field type, meaning we have in the base class something that produces json correctly, and only in exceptions will this be needed to be overriden. <h3 id="summary-proposed-resolution">Proposed resolution</h3> <ul> <li>Check if we can produce json schema for each field in a consistent manner. Assume that Drupal 11+ will be used.</li> <li>Add a method in the base class that produces the schema if so, otherwise add it abstract.</li> <li>This method should produce an json schema array.</li> <li>This should be added into base class for inference.</li> <li>Write tests that have a correct result tested against each json schema.</li> <li>This is needed for all Automator plugins in the AI module.</li> </ul> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <h3>Optional: Other details as applicable (e.g., User interface changes, API changes, Data model changes)</h3> <h3 id="summary-ai-usage">AI usage (if applicable)</h3> [ ] AI Assisted Issue This issue was generated with AI assistance, but was reviewed and refined by the creator. [ ] AI Assisted Code This code was mainly generated by a human, with AI autocompleting or parts AI generated, but under full human supervision. [ ] AI Generated Code This code was mainly generated by an AI with human guidance, and reviewed, tested, and refined by a human. [ ] Vibe Coded This code was generated by an AI and has only been functionally tested. > Related issue: [Issue #3565806](https://www.drupal.org/node/3565806)

issue