Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Missing `name` field in Realtime function-call event in OpenAPI spec breaks generated SDK models

Đang mở
#683 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
java, openapi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu với schema OpenAPI và tài liệu cho sự kiện Realtime response.function_call_arguments.done, sử dụng tài liệu tham chiếu Realtime API được liên kết làm ngữ cảnh. Xác nhận rằng sự kiện bao gồm name dưới dạng chuỗi, sau đó tạo lại các model Java SDK bị ảnh hưởng và xác minh rằng model được tạo biểu diễn payload của server.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

bug spec

Summary

The Realtime API returns a name field in the response.function_call_arguments.done event payload, but this field is not documented and not present in the OpenAPI spec. Because the Java SDK is generated from the spec, the resulting model does not include the field, causing incomplete deserialization and forcing manual workarounds.

This is a Bug + Spec fix + Enhancement issue.


Impacted Endpoint / Event

response.function_call_arguments.done (Realtime API)

Docs reference:
https://platform.openai.com/docs/api-reference/realtime-server-events/response/function_call_arguments/done


Current Docs & Spec Behavior

Docs example (no name field):

{
  "event_id": "event_5556",
  "type": "response.function_call_arguments.done",
  "response_id": "resp_002",
  "item_id": "fc_001",
  "output_index": 0,
  "call_id": "call_001",
  "arguments": "{\"location\": \"San Francisco\"}"
}

Actual Server Behavior

Actual Realtime events include a name field, for example:

{
  "type": "response.function_call_arguments.done",
  "name": "getWeather",
  ...
}

Expectation

The OpenAPI spec and documentation should include the name field so that SDK models (including Java) correctly represent function-calling data.


Impact / Severity

Severity: B — Major (workaround possible but painful)

Consequences:

  • Generated models are incomplete

  • Function name context is lost

  • Cannot rely on strongly-typed SDK

  • Cannot round-trip Realtime function-calling data via SDK


Workaround

Currently working around this by parsing raw JSON event payloads.


Root Cause

Spec / docs mismatch → incorrect OpenAPI → incorrect SDK generation.


Proposed Fix

  • Add name: string to the response.function_call_arguments.* events in the OpenAPI specification and documentation

  • Regenerate affected SDKs (Java + others)


Environment

Component | Value -- | -- SDK | openai-java v4.16.1 Java | 21 OS | Windows 11

Type of Issue

  • Bug

  • Spec / Documentation

  • Enhancement (generated SDK)


Why Combined

Fixing the spec resolves the SDK issue automatically without needing separate work.


Closing Note

This issue makes Realtime function-calling harder to use via strongly-typed models. Aligning the spec/docs with server behavior would resolve the bug and improve developer ergonomics across generator-based SDKs.

Thanks! 🙏

Ngôn ngữ chính
Kotlin
Star
1.5k
Fork
264
Merge trung bình
13 giờ 51 phút
Pull request đã merge (30 ngày)
113

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openai/openai-java

Tất cả issue của openai/openai-java

Issue tương tự

Thêm issue về Kotlin

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.