OpenAI: Added support for structured outputs in Chat action

Author: jcortes

components/openai/actions/chat/chat.mjs

@@ -5,7 +5,7 @@ import constants from "../../common/constants.mjs";
 export default {
   ...common,
   name: "Chat",
-  version: "0.1.11",
+  version: "0.1.12",
   key: "openai-chat",
   description: "The Chat API, using the `gpt-3.5-turbo` or `gpt-4` model. [See the documentation](https://platform.openai.com/docs/api-reference/chat)",
   type: "action",
@@ -43,13 +43,27 @@ export default {
     responseFormat: {
       type: "string",
       label: "Response Format",
-      description: "Specify the format that the model must output. [Setting to `json_object` guarantees the message the model generates is valid JSON](https://platform.openai.com/docs/api-reference/chat/create#chat-create-response_format). Defaults to `text`",
-      options: constants.CHAT_RESPONSE_FORMATS,
+      description: "Specify the format that the model must output. \n- **Text** (default): Returns unstructured text output.\n- **JSON Object**: Ensures the model's output is a valid JSON object.\n- **JSON Schema** (GPT-4o and later): Enables you to define a specific structure for the model's output using a JSON schema. Supported with models `gpt-4o-2024-08-06` and later, and `gpt-4o-mini-2024-07-18` and later.",
+      options: Object.values(constants.CHAT_RESPONSE_FORMAT),
       optional: true,
       default: "text",
+      reloadProps: true,
     },
     ...common.props,
   },
+  additionalProps() {
+    const { responseFormat } = this;
+    if (responseFormat !== constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value) {
+      return {};
+    }
+    return {
+      jsonSchema: {
+        type: "string",
+        label: "JSON Schema",
+        description: "Define the schema that the model's output must adhere to. [See the documentation here](https://platform.openai.com/docs/guides/structured-outputs/supported-schemas).",
+      },
+    };
+  },
   async run({ $ }) {
     const args = this._getChatArgs();
 

components/openai/actions/common/common.mjs

@@ -1,4 +1,6 @@
 import { ConfigurationError } from "@pipedream/platform";
+import constants from "../../common/constants.mjs";
+import { parse } from "../../common/helpers.mjs";
 
 const CHAT_DOCS_MESSAGE_FORMAT_URL = "https://platform.openai.com/docs/guides/chat/introduction";
 
@@ -148,9 +150,17 @@ export default {
 
       const responseFormat = {};
 
+      const jsonSchemaObj =
+        this.responseFormat === constants.CHAT_RESPONSE_FORMAT.JSON_SCHEMA.value
+          ? {
+            json_schema: parse(this.jsonSchema),
+          }
+          : {};
+
       if (this.modelId != "gpt-4-vision-preview") {
         responseFormat["response_format"] = {
           type: this.responseFormat,
+          ...jsonSchemaObj,
         };
       }
 

components/openai/common/constants.mjs

@@ -45,10 +45,20 @@ const AUDIO_RESPONSE_FORMATS = [
   "pcm",
 ];
 
-const CHAT_RESPONSE_FORMATS = [
-  "text",
-  "json_object",
-];
+const CHAT_RESPONSE_FORMAT = {
+  TEXT: {
+    label: "Text",
+    value: "text",
+  },
+  JSON_OBJECT: {
+    label: "JSON Object",
+    value: "json_object",
+  },
+  JSON_SCHEMA: {
+    label: "JSON Schema",
+    value: "json_schema",
+  },
+};
 
 const IMAGE_RESPONSE_FORMATS = [
   {
@@ -162,7 +172,7 @@ export default {
   IMAGE_MODELS,
   MODERATION_MODELS,
   AUDIO_RESPONSE_FORMATS,
-  CHAT_RESPONSE_FORMATS,
+  CHAT_RESPONSE_FORMAT,
   IMAGE_RESPONSE_FORMATS,
   USER_OPTIONS,
   ORDER_OPTIONS,

components/openai/common/helpers.mjs

@@ -1,3 +1,5 @@
+import { ConfigurationError } from "@pipedream/platform";
+
 export function parseToolsArray(arr) {
   if (!arr) return undefined;
   return arr.map((value) => {
@@ -16,3 +18,22 @@ export function parseToolsArray(arr) {
     }
   });
 }
+
+function emptyStrToUndefined(value) {
+  const trimmed = typeof(value) === "string" && value.trim();
+  return trimmed === ""
+    ? undefined
+    : value;
+}
+
+export function parse(value) {
+  const valueToParse = emptyStrToUndefined(value);
+  if (typeof(valueToParse) === "object" || valueToParse === undefined) {
+    return valueToParse;
+  }
+  try {
+    return JSON.parse(valueToParse);
+  } catch (e) {
+    throw new ConfigurationError("Make sure the schema contains a valid JSON object.");
+  }
+}

components/openai/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/openai",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "Pipedream OpenAI Components",
   "main": "openai.app.mjs",
   "keywords": [