@arizeai/openinference-instrumentation-openai 0.4.1 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/openinference-instrumentation-openai",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "OpenInference instrumentation for OpenAI",
   "private": false,
   "main": "dist/src/index.js",
@@ -15,7 +15,8 @@
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/core": "^1.25.1",
     "@opentelemetry/instrumentation": "^0.46.0",
-    "@arizeai/openinference-semantic-conventions": "0.10.0"
+    "@arizeai/openinference-core": "0.3.0",
+    "@arizeai/openinference-semantic-conventions": "0.11.0"
   },
   "keywords": [],
   "files": [
@@ -25,10 +26,12 @@
   "author": "oss-devs@arize.com",
   "license": "Apache-2.0",
   "devDependencies": {
+    "@opentelemetry/exporter-trace-otlp-proto": "^0.50.0",
     "@opentelemetry/resources": "^1.25.1",
     "@opentelemetry/sdk-trace-base": "^1.25.1",
     "@opentelemetry/sdk-trace-node": "^1.25.1",
     "@opentelemetry/semantic-conventions": "^1.25.1",
+    "jest": "^29.7.0",
     "openai": "^4.52.7"
   },
   "scripts": {

package/src/instrumentation.ts

@@ -20,6 +20,8 @@ import {
   SemanticConventions,
   OpenInferenceSpanKind,
   MimeType,
+  LLMSystem,
+  LLMProvider,
 } from "@arizeai/openinference-semantic-conventions";
 import {
   ChatCompletion,
@@ -38,6 +40,8 @@ import {
 import { assertUnreachable, isString } from "./typeUtils";
 import { isTracingSuppressed } from "@opentelemetry/core";
 
+import { safelyJSONStringify } from "@arizeai/openinference-core";
+
 const MODULE_NAME = "openai";
 
 /**
@@ -139,7 +143,10 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
                 [SemanticConventions.INPUT_MIME_TYPE]: MimeType.JSON,
                 [SemanticConventions.LLM_INVOCATION_PARAMETERS]:
                   JSON.stringify(invocationParameters),
+                [SemanticConventions.LLM_SYSTEM]: LLMSystem.OPENAI,
+                [SemanticConventions.LLM_PROVIDER]: LLMProvider.OPENAI,
                 ...getLLMInputMessagesAttributes(body),
+                ...getLLMToolsJSONSchema(body),
               },
             },
           );
@@ -217,6 +224,8 @@ export class OpenAIInstrumentation extends InstrumentationBase<typeof openai> {
               [SemanticConventions.LLM_MODEL_NAME]: body.model,
               [SemanticConventions.LLM_INVOCATION_PARAMETERS]:
                 JSON.stringify(invocationParameters),
+              [SemanticConventions.LLM_SYSTEM]: LLMSystem.OPENAI,
+              [SemanticConventions.LLM_PROVIDER]: LLMProvider.OPENAI,
               ...getCompletionInputValueAndMimeType(body),
             },
           });
@@ -409,6 +418,26 @@ function getLLMInputMessagesAttributes(
   }, {} as Attributes);
 }
 
+/**
+ * Converts each tool definition into a json schema
+ */
+function getLLMToolsJSONSchema(
+  body: ChatCompletionCreateParamsBase,
+): Attributes {
+  if (!body.tools) {
+    // If tools is undefined, return an empty object
+    return {};
+  }
+  return body.tools.reduce((acc: Attributes, tool, index) => {
+    const toolJsonSchema = safelyJSONStringify(tool);
+    const key = `${SemanticConventions.LLM_TOOLS}.${index}.${SemanticConventions.TOOL_JSON_SCHEMA}`;
+    if (toolJsonSchema) {
+      acc[key] = toolJsonSchema;
+    }
+    return acc;
+  }, {});
+}
+
 function getChatCompletionInputMessageAttributes(
   message: ChatCompletionMessageParam,
 ): Attributes {

package/src/version.ts

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