agentscope-ai / agentscope-ai/agentscope-runtime-java

[Bug / Tech Debt] Refactor OpenAI responses API protocol: Replace Manual Implementation with SDK-Based Approach

Open
#69 0 comments 0 reactions 1 assignee Claimed by @xuehuitian45 View on GitHub
bug
Dominant language
Java
Stars
184
Forks
38
PR merge metrics
No merged PRs in 30d

Description

### Description

The current OpenAI Responses API protocol is **largely hand-written based on public documentation**. While this offers initial flexibility, it introduces several critical risks:

- **Inconsistencies with actual API behavior** (e.g., field names, status codes, error formats)
- **Missing edge cases** (rate limits, retry logic, pagination, streaming headers)
- **Hard to maintain** when upstream APIs evolve
- **No type safety or compile-time validation**
- **Duplication of effort** when official SDKs already exist

This has already led to subtle bugs in production—such as malformed JSON payloads, incorrect error handling, or unexpected deserialization failures—especially when integrating with new models or third-party services

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.