Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion relay/channel/openai/relay_responses.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,31 @@ import (
"github.com/QuantumNous/new-api/service"

"github.com/gin-gonic/gin"
"github.com/tidwall/gjson"
"github.com/tidwall/sjson"
)

func normalizeResponsesOutputItemAdded(data string, event dto.ResponsesStreamResponse) (string, error) {
if event.Type != dto.ResponsesOutputTypeItemAdded || event.Item == nil {
return data, nil
}

var missingCollectionPath string
switch event.Item.Type {
case "reasoning":
missingCollectionPath = "item.summary"
case "message":
missingCollectionPath = "item.content"
default:
return data, nil
}
if gjson.Get(data, missingCollectionPath).Exists() {
return data, nil
}

return sjson.SetRaw(data, missingCollectionPath, "[]")
}

func OaiResponsesHandler(c *gin.Context, info *relaycommon.RelayInfo, resp *http.Response) (*dto.Usage, *types.NewAPIError) {
defer service.CloseResponseBodyGracefully(resp)

Expand Down Expand Up @@ -94,7 +117,13 @@ func OaiResponsesStreamHandler(c *gin.Context, info *relaycommon.RelayInfo, resp
sr.Error(err)
return
}
sendResponsesStreamData(c, streamResponse, data)
normalizedData, err := normalizeResponsesOutputItemAdded(data, streamResponse)
if err != nil {
logger.LogError(c, "failed to normalize responses output item: "+err.Error())
sr.Error(err)
return
}
sendResponsesStreamData(c, streamResponse, normalizedData)
switch streamResponse.Type {
case "response.completed", "response.done":
if streamResponse.Response != nil {
Expand Down
67 changes: 67 additions & 0 deletions relay/channel/openai/relay_responses_compat_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
package openai

import (
"strings"
"testing"

"github.com/QuantumNous/new-api/common"
"github.com/QuantumNous/new-api/constant"
"github.com/QuantumNous/new-api/relaykit/dto"
"github.com/gin-gonic/gin"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestOaiResponsesStreamHandlerAddsMissingItemCollections(t *testing.T) {
oldMode := gin.Mode()
gin.SetMode(gin.TestMode)
t.Cleanup(func() { gin.SetMode(oldMode) })

oldTimeout := constant.StreamingTimeout
constant.StreamingTimeout = 30
t.Cleanup(func() { constant.StreamingTimeout = oldTimeout })

body := strings.Join([]string{
`data: {"type":"response.output_item.added","output_index":0,"item":{"id":"rs_missing","type":"reasoning","status":"in_progress"},"sequence_number":2}`,
`data: {"type":"response.output_item.added","output_index":1,"item":{"id":"msg_missing","type":"message","role":"assistant","status":"in_progress"},"sequence_number":3}`,
`data: {"type":"response.output_item.added","output_index":2,"item":{"id":"rs_existing","type":"reasoning","summary":[{"type":"summary_text","text":"kept"}],"status":"in_progress"},"sequence_number":4}`,
`data: {"type":"response.output_item.added","output_index":3,"item":{"id":"fc_1","type":"function_call","call_id":"call_1","name":"lookup"},"sequence_number":5}`,
`data: {"type":"response.completed","response":{"id":"resp_1","status":"completed","usage":{"input_tokens":1,"output_tokens":1,"total_tokens":2}}}`,
`data: [DONE]`,
``,
}, "\n")

c, recorder, resp, info := newResponsesChatTestContext(t, body, true)
usage, relayErr := OaiResponsesStreamHandler(c, info, resp)
require.Nil(t, relayErr)
require.NotNil(t, usage)
require.Equal(t, 2, usage.TotalTokens)

items := make(map[string]map[string]any)
sequences := make(map[string]any)
for _, line := range strings.Split(recorder.Body.String(), "\n") {
line = strings.TrimSpace(line)
if !strings.HasPrefix(line, "data: ") || line == "data: [DONE]" {
continue
}
var event map[string]any
require.NoError(t, common.Unmarshal([]byte(strings.TrimPrefix(line, "data: ")), &event))
if event["type"] != dto.ResponsesOutputTypeItemAdded {
continue
}
item, ok := event["item"].(map[string]any)
require.True(t, ok)
id, ok := item["id"].(string)
require.True(t, ok)
items[id] = item
sequences[id] = event["sequence_number"]
}

require.Len(t, items, 4)
assert.Equal(t, []any{}, items["rs_missing"]["summary"])
assert.Equal(t, []any{}, items["msg_missing"]["content"])
assert.Equal(t, []any{map[string]any{"type": "summary_text", "text": "kept"}}, items["rs_existing"]["summary"])
assert.NotContains(t, items["fc_1"], "content")
assert.Equal(t, float64(2), sequences["rs_missing"])
assert.Equal(t, float64(5), sequences["fc_1"])
}