improve coverage for tool choice

Author: ygree

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

@@ -194,6 +194,36 @@ class ChatCompletionServiceTest extends OpenAiTest {
     toolDefinitions[0].schema.required == ["name"]
   }
 
+  def "create chat/completion test with tool choice"() {
+    runUnderTrace("parent") {
+      openAiClient.chat().completions().create(chatCompletionCreateParamsWithToolChoice())
+    }
+
+    expect:
+    List<LLMObs.LLMMessage> outputTag = []
+    List<Map<String, Object>> toolDefinitions = []
+    assertChatCompletionTrace(false, outputTag, [tool_choice: "function"], true, toolDefinitions)
+    and:
+    toolDefinitions.size() == 1
+    toolDefinitions[0].name == "extract_student_info"
+    toolDefinitions[0].description == "Get the student information from the body of the input text"
+    and:
+    outputTag.size() == 1
+    LLMObs.LLMMessage outputMsg = outputTag.get(0)
+    outputMsg.toolCalls.size() == 1
+    def toolcall = outputMsg.toolCalls.get(0)
+    toolcall.name == "extract_student_info"
+    toolcall.toolId instanceof String
+    toolcall.type == "function"
+    toolcall.arguments == [
+      name: 'David Nguyen',
+      major: 'computer science',
+      school: 'Stanford University',
+      grades: 3.8,
+      clubs: ['Chess Club', 'South Asian Student Association']
+    ]
+  }
+
   def "create streaming chat/completion test with tool calls"() {
     runnableUnderTrace("parent") {
       StreamResponse<ChatCompletionChunk> streamCompletion = openAiClient.chat().completions().createStreaming(chatCompletionCreateParamsWithTools())

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

@@ -14,6 +14,7 @@ import com.openai.models.Reasoning
 import com.openai.models.ReasoningEffort
 import com.openai.models.chat.completions.ChatCompletionCreateParams
 import com.openai.models.chat.completions.ChatCompletionFunctionTool
+import com.openai.models.chat.completions.ChatCompletionNamedToolChoice
 import com.openai.models.chat.completions.ChatCompletionStreamOptions
 import com.openai.models.completions.CompletionCreateParams
 import com.openai.models.embeddings.EmbeddingCreateParams
@@ -262,6 +263,17 @@ He hopes to pursue a career in software engineering after graduating.""")
     .build()
   }
 
+  ChatCompletionCreateParams chatCompletionCreateParamsWithToolChoice() {
+    chatCompletionCreateParamsWithTools().toBuilder()
+    .toolChoice(ChatCompletionNamedToolChoice.builder()
+    .type(JsonValue.from("function"))
+    .function(ChatCompletionNamedToolChoice.Function.builder()
+    .name("extract_student_info")
+    .build())
+    .build())
+    .build()
+  }
+
   ChatCompletionCreateParams chatCompletionCreateParamsWithRawTools() {
     def functionMap = [
       name: "extract_student_info_raw",

dd-java-agent/instrumentation/openai-java/openai-java-3.0/src/test/resources/http-records/chat/completions/44176131e15bf8c0+81d6f6852e8115be.POST.rec

@@ -0,0 +1,79 @@
+method: POST
+path: chat/completions
+-- begin request body --
+{"messages":[{"content":"David Nguyen is a sophomore majoring in computer science at Stanford University and has a GPA of 3.8.\nDavid is an active member of the university's Chess Club and the South Asian Student Association.\nHe hopes to pursue a career in software engineering after graduating.","role":"user"}],"model":"gpt-4o-mini","tool_choice":{"function":{"name":"extract_student_info"},"type":"function"},"tools":[{"function":{"name":"extract_student_info","description":"Get the student information from the body of the input text","parameters":{"type":"object","properties":{"name":{"type":"string","description":"Name of the person"},"major":{"type":"string","description":"Major subject."},"school":{"type":"string","description":"The university name."},"grades":{"type":"integer","description":"GPA of the student."},"clubs":{"type":"array","description":"School clubs for extracurricular activities. ","items":{"type":"string","description":"Name of School Club"}}}}},"type":"function"}]}
+-- end request body -- 
+status code: 200
+-- begin response headers --
+access-control-expose-headers: X-Request-ID
+alt-svc: h3=":443"; ma=86400
+cf-cache-status: DYNAMIC
+cf-ray: 9e52289bcf4b6811-SEA
+content-type: application/json
+date: Tue, 31 Mar 2026 20:38:37 GMT
+openai-organization: datadog-staging
+openai-processing-ms: 975
+openai-project: proj_gt6TQZPRbZfoY2J9AQlEJMpd
+openai-version: 2020-10-01
+server: cloudflare
+set-cookie: __cf_bm=8UpsxSUpYP5PmHi3NoNcvUAPHElwZCix7hG5h.Jprr8-1774989516.1296408-1.0.1.1-2GEVgpgzsaA8PIC.4pr9thdXAw7zglpkJZF_LD08k1itVMbyhtxUjskkov5EnFuRLGkMaXiKrl5sngZSQF3mFA_h_Cfh.bCgd.k3ovK4p9VcbEmkfWy7MStLsa5i3LFh; HttpOnly; Secure; Path=/; Domain=api.openai.com; Expires=Tue, 31 Mar 2026 21:08:37 GMT
+strict-transport-security: max-age=31536000; includeSubDomains; preload
+x-content-type-options: nosniff
+x-openai-proxy-wasm: v0.1
+x-ratelimit-limit-requests: 30000
+x-ratelimit-limit-tokens: 150000000
+x-ratelimit-remaining-requests: 29999
+x-ratelimit-remaining-tokens: 149999927
+x-ratelimit-reset-requests: 2ms
+x-ratelimit-reset-tokens: 0s
+x-request-id: req_6de1d82c867f4dc3a10eb169eda01c8f
+-- end response headers --
+-- begin response body --
+{
+  "id": "chatcmpl-DPa96rNBMqoTGuLjKfIw3huHXDuai",
+  "object": "chat.completion",
+  "created": 1774989516,
+  "model": "gpt-4o-mini-2024-07-18",
+  "choices": [
+    {
+      "index": 0,
+      "message": {
+        "role": "assistant",
+        "content": null,
+        "tool_calls": [
+          {
+            "id": "call_FPVMvOQnA8cKnmYI83lMmQ75",
+            "type": "function",
+            "function": {
+              "name": "extract_student_info",
+              "arguments": "{\"name\":\"David Nguyen\",\"major\":\"computer science\",\"school\":\"Stanford University\",\"grades\":3.8,\"clubs\":[\"Chess Club\",\"South Asian Student Association\"]}"
+            }
+          }
+        ],
+        "refusal": null,
+        "annotations": []
+      },
+      "logprobs": null,
+      "finish_reason": "stop"
+    }
+  ],
+  "usage": {
+    "prompt_tokens": 162,
+    "completion_tokens": 34,
+    "total_tokens": 196,
+    "prompt_tokens_details": {
+      "cached_tokens": 0,
+      "audio_tokens": 0
+    },
+    "completion_tokens_details": {
+      "reasoning_tokens": 0,
+      "audio_tokens": 0,
+      "accepted_prediction_tokens": 0,
+      "rejected_prediction_tokens": 0
+    }
+  },
+  "service_tier": "default",
+  "system_fingerprint": "fp_1bf41b89ce"
+}
+�
+-- end response body --