Support openai-java v3.0.0+ only because of breaking changes in tool call classes: ChatCompletionMessageFunctionToolCall and ChatCompletionMessageToolCall

Author: ygree

dd-java-agent/instrumentation/openai-java/openai-java-1.0/build.gradle

@@ -1,23 +1,25 @@
 apply from: "$rootDir/gradle/java.gradle"
 apply plugin: 'idea'
 
+// ChatCompletionMessageFunctionToolCall introduced in v3.0.0
+def minVer = '3.0.0'
+
 muzzle {
   pass {
     group = "com.openai"
     module = "openai-java"
-    versions = "[0.45.0,3)"
-    // TODO com.openai.models.chat.completions.ChatCompletionMessageToolCall changes in v3
-    // assertInverse = true
+    versions = "[$minVer,)"
+    assertInverse = true
   }
 }
 
 addTestSuiteForDir('latestDepTest', 'test')
 
 dependencies {
-  compileOnly group: 'com.openai', name: 'openai-java', version: '0.45.0'
+  compileOnly group: 'com.openai', name: 'openai-java', version: minVer
   implementation project(':internal-api')
 
-  testImplementation group: 'com.openai', name: 'openai-java', version: '0.45.0'
+  testImplementation group: 'com.openai', name: 'openai-java', version: minVer
   latestDepTestImplementation group: 'com.openai', name: 'openai-java', version: '+'
 
   testImplementation project(':dd-java-agent:instrumentation:okhttp:okhttp-3.0')

dd-java-agent/instrumentation/openai-java/openai-java-1.0/src/main/java/datadog/trace/instrumentation/openai_java/ToolCallExtractor.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.openai.models.chat.completions.ChatCompletionMessageFunctionToolCall;
 import com.openai.models.chat.completions.ChatCompletionMessageToolCall;
 import datadog.trace.api.llmobs.LLMObs;
 import java.util.Collections;
@@ -16,11 +17,15 @@ public class ToolCallExtractor {
   private static final TypeReference<Map<String, Object>> MAP_TYPE_REF =
       new TypeReference<Map<String, Object>>() {};
 
-  // TODO add support for v3+
   public static LLMObs.ToolCall getToolCall(ChatCompletionMessageToolCall toolCall) {
+    Optional<ChatCompletionMessageFunctionToolCall> functionToolCallOpt = toolCall.function();
+    if (!functionToolCallOpt.isPresent()) {
+      return null;
+    }
     try {
-      String toolId = toolCall.id();
-      ChatCompletionMessageToolCall.Function function = toolCall.function();
+      ChatCompletionMessageFunctionToolCall functionToolCall = functionToolCallOpt.get();
+      String toolId = functionToolCall.id();
+      ChatCompletionMessageFunctionToolCall.Function function = functionToolCall.function();
       String name = function.name();
       String argumentsJson = function.arguments();
 
@@ -32,7 +37,7 @@ public static LLMObs.ToolCall getToolCall(ChatCompletionMessageToolCall toolCall
       }
 
       String type = "function";
-      Optional<String> typeOpt = toolCall._type().asString();
+      Optional<String> typeOpt = functionToolCall._type().asString() ;
       if (typeOpt.isPresent()) {
         type = typeOpt.get();
       }

dd-java-agent/instrumentation/openai-java/openai-java-1.0/src/test/groovy/ChatCompletionServiceTest.groovy

@@ -128,7 +128,7 @@ class ChatCompletionServiceTest extends OpenAiTest {
     resp.choices().size() == 1
     resp.choices().get(0).message().toolCalls().isPresent()
     resp.choices().get(0).message().toolCalls().get().size() == 1
-    resp.choices().get(0).message().toolCalls().get().get(0).function().name() == "extract_student_info"
+    resp.choices().get(0).message().toolCalls().get().get(0).function().get().function().name() == "extract_student_info"
     and:
     assertChatCompletionTrace(false)
   }

dd-java-agent/instrumentation/openai-java/openai-java-1.0/src/test/groovy/OpenAiTest.groovy

@@ -10,7 +10,7 @@ import com.openai.models.ChatModel
 import com.openai.models.FunctionDefinition
 import com.openai.models.FunctionParameters
 import com.openai.models.chat.completions.ChatCompletionCreateParams
-import com.openai.models.chat.completions.ChatCompletionTool
+import com.openai.models.chat.completions.ChatCompletionFunctionTool
 import com.openai.models.completions.CompletionCreateParams
 import com.openai.models.embeddings.EmbeddingCreateParams
 import com.openai.models.embeddings.EmbeddingModel
@@ -144,7 +144,7 @@ abstract class OpenAiTest extends LlmObsSpecification {
     .addUserMessage("""David Nguyen is a sophomore majoring in computer science at Stanford University and has a GPA of 3.8.
 David is an active member of the university's Chess Club and the South Asian Student Association.
 He hopes to pursue a career in software engineering after graduating.""")
-    .addTool(ChatCompletionTool.builder()
+    .addTool(ChatCompletionFunctionTool.builder()
     .function(FunctionDefinition.builder()
     .name("extract_student_info")
     .description("Get the student information from the body of the input text")