@arizeai/openinference-instrumentation-openai 3.2.4 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/openinference-instrumentation-openai",
-  "version": "3.2.4",
+  "version": "4.0.0",
   "description": "OpenInference instrumentation for OpenAI",
   "private": false,
   "main": "dist/src/index.js",
@@ -21,7 +21,7 @@
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^1.25.1",
     "@opentelemetry/instrumentation": "^0.46.0",
-    "@arizeai/openinference-core": "1.0.8",
+    "@arizeai/openinference-core": "2.0.0",
     "@arizeai/openinference-semantic-conventions": "2.1.2"
   },
   "keywords": [],
@@ -37,9 +37,10 @@
     "@opentelemetry/sdk-trace-base": "^1.25.1",
     "@opentelemetry/sdk-trace-node": "^1.25.1",
     "@opentelemetry/semantic-conventions": "^1.25.1",
+    "openai": "^6.7.0",
     "vitest": "^2.1.8",
-    "openai": "^5.7.0",
-    "zod": "^3.24.3"
+    "zod": "^3.24.3",
+    "typescript": "^5.5.4"
   },
   "scripts": {
     "prebuild": "rimraf dist && pnpm run version:update",

package/src/instrumentation.ts

@@ -208,7 +208,8 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
   protected init(): InstrumentationModuleDefinition<typeof openai> {
     const module = new InstrumentationNodeModuleDefinition<typeof openai>(
       "openai",
-      ["^5.0.0"],
+      // 5.x is best effort
+      ["^6.0.0", "^5.0.0"],
       this.patch.bind(this),
       this.unpatch.bind(this),
     );
@@ -754,6 +755,9 @@ function getChatCompletionInputMessageAttributes(
             attributes[
               `${toolCallIndexPrefix}${SemanticConventions.TOOL_CALL_FUNCTION_ARGUMENTS_JSON}`
             ] = toolCall.function.arguments;
+          } else {
+            // TODO: add exhaustive checks
+            diag.warn(`Unsupported tool type: ${toolCall.type}`);
           }
         });
       }
@@ -874,8 +878,6 @@ function getChatCompletionOutputMessageAttributes(
           `${toolCallIndexPrefix}${SemanticConventions.TOOL_CALL_ID}`
         ] = toolCall.id;
       }
-      // Double check that the tool call has a function
-      // NB: OpenAI only supports tool calls with functions right now but this may change
       if (toolCall.type === "function") {
         attributes[
           toolCallIndexPrefix + SemanticConventions.TOOL_CALL_FUNCTION_NAME
@@ -884,6 +886,9 @@ function getChatCompletionOutputMessageAttributes(
           toolCallIndexPrefix +
             SemanticConventions.TOOL_CALL_FUNCTION_ARGUMENTS_JSON
         ] = toolCall.function.arguments;
+      } else {
+        // TODO: switch to exhaustive checks
+        diag.warn(`Unsupported tool type: ${toolCall.type}`);
       }
     });
   }

package/src/responsesAttributes.ts

@@ -1,3 +1,4 @@
+import { safelyJSONStringify } from "@arizeai/openinference-core";
 import { SemanticConventions } from "@arizeai/openinference-semantic-conventions";
 
 import { Attributes } from "@opentelemetry/api";
@@ -44,8 +45,15 @@ function getResponseItemAttributes(
       attributes[`${prefix}${SemanticConventions.MESSAGE_ROLE}`] = "tool";
       attributes[`${prefix}${SemanticConventions.MESSAGE_TOOL_CALL_ID}`] =
         item.call_id;
-      attributes[`${prefix}${SemanticConventions.MESSAGE_CONTENT}`] =
-        item.output;
+      if (typeof item.output === "string") {
+        attributes[`${prefix}${SemanticConventions.MESSAGE_CONTENT}`] =
+          item.output;
+      } else {
+        // TODO(2410): figure out how to serialize the list of tools
+        attributes[`${prefix}${SemanticConventions.MESSAGE_CONTENT}`] =
+          safelyJSONStringify(item.output) || undefined;
+      }
+
       break;
     }
     case "reasoning": {

package/src/version.ts

@@ -1,2 +1,2 @@
 // this is an auto-generated file. see js/scripts/version-update.js
-export const VERSION = "3.2.4";
+export const VERSION = "4.0.0";