Structured output improvements, tests and samples

Author: phartenfeller

src/packages/uc_ai_openai.pkb

@@ -530,8 +530,6 @@ create or replace package body uc_ai_openai as
   , p_model          in uc_ai.model_type
   , p_max_tool_calls in pls_integer
   , p_schema         in json_object_t default null
-  , p_schema_name    in varchar2 default 'structured_output'
-  , p_strict         in boolean default true
   ) return json_object_t
   as
     l_scope uc_ai_logger.scope := c_scope_prefix || 'generate_text_chat_api';
@@ -573,8 +571,7 @@ create or replace package body uc_ai_openai as
     if p_schema is not null then
       l_response_format := uc_ai_structured_output.to_openai_format(
         p_schema => p_schema,
-        p_name => p_schema_name,
-        p_strict => p_strict
+        p_strict => true
       );
       l_input_obj.put('response_format', l_response_format);
     end if;
@@ -648,8 +645,6 @@ create or replace package body uc_ai_openai as
   , p_model          in uc_ai.model_type
   , p_max_tool_calls in pls_integer
   , p_schema         in json_object_t default null
-  , p_schema_name    in varchar2 default 'structured_output'
-  , p_strict         in boolean default true
   ) return json_object_t
   as
   begin
@@ -663,17 +658,13 @@ create or replace package body uc_ai_openai as
       , p_model          => p_model
       , p_max_tool_calls => p_max_tool_calls
       , p_schema         => p_schema
-      , p_schema_name    => p_schema_name
-      , p_strict         => p_strict
       );
     else
       return generate_text_chat_api(
         p_messages       => p_messages
       , p_model          => p_model
       , p_max_tool_calls => p_max_tool_calls
       , p_schema         => p_schema
-      , p_schema_name    => p_schema_name
-      , p_strict         => p_strict
       );
     end if;
 

src/packages/uc_ai_openai.pks

@@ -63,8 +63,6 @@ create or replace package uc_ai_openai as
   , p_model          in uc_ai.model_type
   , p_max_tool_calls in pls_integer
   , p_schema         in json_object_t default null
-  , p_schema_name    in varchar2 default 'structured_output'
-  , p_strict         in boolean default true
   ) return json_object_t;
 
   /*

src/packages/uc_ai_responses_api.pkb

@@ -501,8 +501,6 @@ create or replace package body uc_ai_responses_api as
   , p_model          in uc_ai.model_type
   , p_max_tool_calls in pls_integer
   , p_schema         in json_object_t default null
-  , p_schema_name    in varchar2 default 'structured_output'
-  , p_strict         in boolean default true
   ) return json_object_t
   as
     l_scope uc_ai_logger.scope := c_scope_prefix || 'generate_text';
@@ -575,10 +573,9 @@ create or replace package body uc_ai_responses_api as
     if p_schema is not null then
       l_text_config := json_object_t();
 
-      l_response_format := uc_ai_structured_output.to_openai_format(
+      l_response_format := uc_ai_structured_output.to_responses_api_format(
         p_schema => p_schema,
-        p_name => p_schema_name,
-        p_strict => p_strict
+        p_strict => true
       );
 
       l_text_config.put('format', l_response_format);

src/packages/uc_ai_responses_api.pks

@@ -52,8 +52,6 @@ create or replace package uc_ai_responses_api as
    * p_model: Model to use for generation
    * p_max_tool_calls: Maximum number of tool calls to allow in one request
    * p_schema: Optional JSON schema for structured output
-   * p_schema_name: Name for the structured output schema
-   * p_strict: Whether to enforce strict schema validation
    * 
    * Returns: JSON object with response data including:
    *   - id: Unique response ID
@@ -67,8 +65,6 @@ create or replace package uc_ai_responses_api as
   , p_model          in uc_ai.model_type
   , p_max_tool_calls in pls_integer
   , p_schema         in json_object_t default null
-  , p_schema_name    in varchar2 default 'structured_output'
-  , p_strict         in boolean default true
   ) return json_object_t;
 
 end uc_ai_responses_api;

src/packages/uc_ai_structured_output.pkb

@@ -154,16 +154,23 @@ create or replace package body uc_ai_structured_output as
    */
   function to_openai_format(
     p_schema in json_object_t,
-    p_name in varchar2 default 'structured_output',
     p_strict in boolean default true
   ) return json_object_t
   as
     l_scope uc_ai_logger.scope := c_scope_prefix || 'to_openai_format';
     l_response_format json_object_t := json_object_t();
     l_schema_copy json_object_t;
     l_json_schema json_object_t;
+    l_name varchar2(4000 char) := 'structured_output';
   begin
-    uc_ai_logger.log('Converting schema to OpenAI format', l_scope, 'Name: ' || p_name || ', Strict: ' || case when p_strict then 'true' else 'false' end);
+    uc_ai_logger.log('Converting schema to OpenAI format', l_scope, ' Strict: ' || case when p_strict then 'true' else 'false' end);
+
+    if p_schema.has('title') then
+      l_name := replace(p_schema.get_string('title'), ' ', '_');
+      -- make it match [a-zA-Z0-9_-]+
+      l_name := regexp_replace(l_name, '[^a-zA-Z0-9_-]', null);
+      l_name := coalesce(l_name, 'structured_output');
+    end if;
 
     -- Create a copy of the input schema and process for strict mode
     if p_strict then
@@ -175,7 +182,7 @@ create or replace package body uc_ai_structured_output as
     l_response_format.put('type', 'json_schema');
 
     l_json_schema := json_object_t();
-    l_json_schema.put('name', p_name);
+    l_json_schema.put('name', l_name);
     l_json_schema.put('schema', l_schema_copy);
     l_json_schema.put('strict', p_strict);
 
@@ -221,13 +228,51 @@ create or replace package body uc_ai_structured_output as
     return l_schema_copy;
   end to_ollama_format;
 
+ /*
+   * Convert a standard JSON schema to Responses API format for structured output
+   */
+  function to_responses_api_format(
+    p_schema in json_object_t,
+    p_strict in boolean default true
+  ) return json_object_t
+  as
+    l_scope uc_ai_logger.scope := c_scope_prefix || 'to_responses_api_format';
+    l_response_format json_object_t := json_object_t();
+    l_schema_copy json_object_t;
+    l_name varchar2(4000 char) := 'structured_output';
+  begin
+    uc_ai_logger.log('Converting schema to Responses API format', l_scope, ' Strict: ' || case when p_strict then 'true' else 'false' end);
+
+    if p_schema.has('title') then
+      l_name := replace(p_schema.get_string('title'), ' ', '_');
+      -- make it match [a-zA-Z0-9_-]+
+      l_name := regexp_replace(l_name, '[^a-zA-Z0-9_-]', null);
+      l_name := coalesce(l_name, 'structured_output');
+    end if;
+
+    -- Create a copy of the input schema and process for strict mode
+    if p_strict then
+      l_schema_copy := process_openai_strict_schema(p_schema);
+    else
+      l_schema_copy := json_object_t(p_schema.to_clob);
+    end if;
+
+    l_response_format.put('type', 'json_schema');
+    l_response_format.put('name', l_name);
+    l_response_format.put('strict', p_strict);
+    l_response_format.put('schema', l_schema_copy);
+
+    uc_ai_logger.log('Responses API format conversion complete', l_scope, l_response_format.to_clob);
+    return l_response_format;
+  end to_responses_api_format;
+
+
   /*
    * Generic function to convert schema based on provider
    */
   function format_schema(
     p_schema in json_object_t,
     p_provider in uc_ai.provider_type,
-    p_name in varchar2 default 'structured_output',
     p_strict in boolean default true
   ) return json_object_t
   as
@@ -238,7 +283,7 @@ create or replace package body uc_ai_structured_output as
 
     case p_provider
       when uc_ai.c_provider_openai then
-        l_result := to_openai_format(p_schema, p_name, p_strict);
+        l_result := to_openai_format(p_schema, p_strict);
       when uc_ai.c_provider_google then
         l_result := to_google_format(p_schema);
       when uc_ai.c_provider_ollama then

src/packages/uc_ai_structured_output.pks

@@ -13,14 +13,12 @@ create or replace package uc_ai_structured_output as
    * Convert a standard JSON schema to OpenAI format for structured output
    * 
    * p_schema: Standard JSON schema as json_object_t
-   * p_name: Optional name for the schema (required for OpenAI)
    * p_strict: Whether to use strict mode (OpenAI-specific)
    * 
    * Returns: OpenAI-formatted response_format object
    */
   function to_openai_format(
     p_schema in json_object_t,
-    p_name in varchar2 default 'structured_output',
     p_strict in boolean default true
   ) return json_object_t;
 
@@ -46,20 +44,32 @@ create or replace package uc_ai_structured_output as
     p_schema in json_object_t
   ) return json_object_t;
 
+  /*
+   * Convert a standard JSON schema to Responses API format for structured output
+   * 
+   * p_schema: Standard JSON schema as json_object_t
+   * p_strict: Whether to use strict mode (OpenAI-specific)
+   * 
+   * Returns: Responses API-formatted response_format object
+   */
+  function to_responses_api_format(
+    p_schema in json_object_t,
+    p_strict in boolean default true
+  ) return json_object_t;
+
+
   /*
    * Generic function to convert schema based on provider
    * 
    * p_schema: Standard JSON schema as json_object_t
    * p_provider: AI provider ('openai', 'google', 'ollama')
-   * p_name: Optional name for the schema (used by OpenAI)
    * p_strict: Whether to use strict mode (OpenAI-specific)
    * 
    * Returns: Provider-specific formatted schema
    */
   function format_schema(
     p_schema in json_object_t,
     p_provider in uc_ai.provider_type,
-    p_name in varchar2 default 'structured_output',
     p_strict in boolean default true
   ) return json_object_t;
 

test/samples/openai/chat/4-structured-output-request.json

@@ -1,45 +1,44 @@
 {
   "model": "gpt-4o-mini",
-  "response_format": {
-    "type": "json_schema",
-    "json_schema": {
-      "name": "structured_output",
+  "input": [
+    {
+      "type": "message",
+      "role": "user",
+      "content": [
+        {
+          "text": "What is the capital of France? Please respond with confidence.",
+          "type": "input_text"
+        }
+      ]
+    }
+  ],
+  "instructions": "You are a helpful assistant that provides accurate information.",
+  "text": {
+    "format": {
+      "type": "json_schema",
+      "name": "Response_with_confidence_score",
+      "strict": true,
       "schema": {
         "type": "object",
+        "additionalProperties": false,
         "properties": {
           "response": {
-            "type": "string",
-            "description": "The generated response text"
+            "type": "string"
           },
           "confidence": {
             "type": "number",
-            "description": "Confidence score between 0 and 1",
             "minimum": 0,
             "maximum": 1
           }
         },
         "required": [
           "response",
           "confidence"
-        ],
-        "additionalProperties": false
-      },
-      "strict": true
-    }
-  },
-  "messages": [
-    {
-      "role": "system",
-      "content": "You are a helpful assistant that provides accurate information."
+        ]
+      }
     },
-    {
-      "role": "user",
-      "content": [
-        {
-          "type": "text",
-          "text": "What is the capital of France? Please respond with confidence."
-        }
-      ]
-    }
-  ]
+    "verbosity": "medium"
+  },
+  "max_tool_calls": 10,
+  "store": true
 }

test/samples/openai/chat/4-structured-output-response.json

@@ -1,7 +1,7 @@
 {
   "id": "chatcmpl-CAwhAgRBJ7oatXs6KSlwbTYoiMLgH",
   "object": "chat.completion",
-  "created": 1756724940,
+  "created": 1768840409,
   "model": "gpt-4o-mini-2024-07-18",
   "choices": [
     {
@@ -17,9 +17,9 @@
     }
   ],
   "usage": {
-    "prompt_tokens": 84,
+    "prompt_tokens": 72,
     "completion_tokens": 16,
-    "total_tokens": 100,
+    "total_tokens": 88,
     "prompt_tokens_details": {
       "cached_tokens": 0,
       "audio_tokens": 0

test/samples/openai/responses/4-structured-output-request.json

@@ -0,0 +1,43 @@
+{
+  "model": "gpt-4o-mini",
+  "response_format": {
+    "type": "json_schema",
+    "json_schema": {
+      "name": "Response_with_confidence_score",
+      "schema": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "response": {
+            "type": "string"
+          },
+          "confidence": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          }
+        },
+        "required": [
+          "response",
+          "confidence"
+        ]
+      },
+      "strict": true
+    }
+  },
+  "messages": [
+    {
+      "role": "system",
+      "content": "You are a helpful assistant that provides accurate information."
+    },
+    {
+      "role": "user",
+      "content": [
+        {
+          "type": "text",
+          "text": "What is the capital of France? Please respond with confidence."
+        }
+      ]
+    }
+  ]
+}