Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
2 changes: 1 addition & 1 deletion controller/relay.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func relayHandler(c *gin.Context, info *relaycommon.RelayInfo) *types.NewAPIErro
err = relay.RerankHelper(c, info)
case relayconstant.RelayModeEmbeddings:
err = relay.EmbeddingHelper(c, info)
case relayconstant.RelayModeResponses:
case relayconstant.RelayModeResponses, relayconstant.RelayModeResponsesCompact:
err = relay.ResponsesHelper(c, info)
default:
err = relay.TextHelper(c, info)
Expand Down
111 changes: 106 additions & 5 deletions docs/openapi/relay.json
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,46 @@
}
]
}
},
"/v1/responses/compact": {
"post": {
"summary": "压缩对话 (OpenAI Responses API)",
"deprecated": false,
"description": "OpenAI Responses API,用于对长对话进行 compaction。",
"operationId": "compactResponse",
"tags": [
"OpenAI格式(Responses)"
],
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponsesCompactionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "成功压缩对话",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponsesCompactionResponse"
}
}
},
"headers": {}
}
},
"security": [
{
"BearerAuth": []
}
]
}
},
"/v1/images/generations": {
"post": {
Expand Down Expand Up @@ -3130,10 +3170,71 @@
}
}
},
"ResponsesStreamResponse": {
"type": "object",
"properties": {
"type": {
"ResponsesCompactionResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"example": "response.compaction"
},
"created_at": {
"type": "integer"
},
"output": {
"type": "array",
"items": {
"type": "object",
"properties": {}
}
},
"usage": {
"$ref": "#/components/schemas/Usage"
},
"error": {
"type": "object",
"properties": {}
}
}
},
"ResponsesCompactionRequest": {
"type": "object",
"required": [
"model"
],
"properties": {
"model": {
"type": "string"
},
"input": {
"description": "输入内容,可以是字符串或消息数组",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {}
}
}
]
},
"instructions": {
"type": "string"
},
"previous_response_id": {
"type": "string"
}
}
},
"ResponsesStreamResponse": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"response": {
Expand Down Expand Up @@ -7138,4 +7239,4 @@
"BearerAuth": []
}
]
}
}
20 changes: 20 additions & 0 deletions dto/openai_compaction.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package dto

import (
"encoding/json"

"github.com/QuantumNous/new-api/types"
)

type OpenAIResponsesCompactionResponse struct {
ID string `json:"id"`
Object string `json:"object"`
CreatedAt int `json:"created_at"`
Output json.RawMessage `json:"output"`
Usage *Usage `json:"usage"`
Error any `json:"error,omitempty"`
}

func (o *OpenAIResponsesCompactionResponse) GetOpenAIError() *types.OpenAIError {
return GetOpenAIError(o.Error)
}
40 changes: 40 additions & 0 deletions dto/openai_responses_compaction_request.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package dto

import (
"encoding/json"
"strings"

"github.com/QuantumNous/new-api/types"

"github.com/gin-gonic/gin"
)

type OpenAIResponsesCompactionRequest struct {
Model string `json:"model"`
Input json.RawMessage `json:"input,omitempty"`
Instructions json.RawMessage `json:"instructions,omitempty"`
PreviousResponseID string `json:"previous_response_id,omitempty"`
}

func (r *OpenAIResponsesCompactionRequest) GetTokenCountMeta() *types.TokenCountMeta {
var parts []string
if len(r.Instructions) > 0 {
parts = append(parts, string(r.Instructions))
}
if len(r.Input) > 0 {
parts = append(parts, string(r.Input))
}
return &types.TokenCountMeta{
CombineText: strings.Join(parts, "\n"),
}
}

func (r *OpenAIResponsesCompactionRequest) IsStream(c *gin.Context) bool {
return false
}

func (r *OpenAIResponsesCompactionRequest) SetModelName(modelName string) {
if modelName != "" {
r.Model = modelName
}
}
4 changes: 4 additions & 0 deletions middleware/distributor.go
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,10 @@ func getModelRequest(c *gin.Context) (*ModelRequest, bool, error) {
modelRequest.Group = req.Group
common.SetContextKey(c, constant.ContextKeyTokenGroup, modelRequest.Group)
}

if strings.HasPrefix(c.Request.URL.Path, "/v1/responses/compact") && modelRequest.Model != "" {
modelRequest.Model = ratio_setting.WithCompactModelSuffix(modelRequest.Model)
}
return &modelRequest, shouldSelectChannel, nil
}

Expand Down
6 changes: 3 additions & 3 deletions relay/channel/codex/adaptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ func (a *Adaptor) DoRequest(c *gin.Context, info *relaycommon.RelayInfo, request
}

func (a *Adaptor) DoResponse(c *gin.Context, resp *http.Response, info *relaycommon.RelayInfo) (usage any, err *types.NewAPIError) {
if info.RelayMode != relayconstant.RelayModeResponses {
if info.RelayMode != relayconstant.RelayModeResponses && info.RelayMode != relayconstant.RelayModeResponsesCompact {
return nil, types.NewError(errors.New("codex channel: endpoint not supported"), types.ErrorCodeInvalidRequest)
}

Expand All @@ -121,8 +121,8 @@ func (a *Adaptor) GetChannelName() string {
}

func (a *Adaptor) GetRequestURL(info *relaycommon.RelayInfo) (string, error) {
if info.RelayMode != relayconstant.RelayModeResponses {
return "", errors.New("codex channel: only /v1/responses is supported")
if info.RelayMode != relayconstant.RelayModeResponses && info.RelayMode != relayconstant.RelayModeResponsesCompact {
return "", errors.New("codex channel: only /v1/responses and /v1/responses/compact are supported")
}
return relaycommon.GetFullRequestURL(info.ChannelBaseUrl, "/backend-api/codex/responses", info.ChannelType), nil
}
Expand Down
2 changes: 2 additions & 0 deletions relay/channel/openai/adaptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,8 @@ func (a *Adaptor) DoResponse(c *gin.Context, resp *http.Response, info *relaycom
} else {
usage, err = OaiResponsesHandler(c, info, resp)
}
case relayconstant.RelayModeResponsesCompact:
usage, err = OaiResponsesCompactionHandler(c, resp)
default:
if info.IsStream {
usage, err = OaiStreamHandler(c, info, resp)
Expand Down
44 changes: 44 additions & 0 deletions relay/channel/openai/relay_responses_compact.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package openai

import (
"io"
"net/http"

"github.com/QuantumNous/new-api/common"
"github.com/QuantumNous/new-api/dto"
"github.com/QuantumNous/new-api/service"
"github.com/QuantumNous/new-api/types"

"github.com/gin-gonic/gin"
)

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

responseBody, err := io.ReadAll(resp.Body)
if err != nil {
return nil, types.NewOpenAIError(err, types.ErrorCodeReadResponseBodyFailed, http.StatusInternalServerError)
}

var compactResp dto.OpenAIResponsesCompactionResponse
if err := common.Unmarshal(responseBody, &compactResp); err != nil {
return nil, types.NewOpenAIError(err, types.ErrorCodeBadResponseBody, http.StatusInternalServerError)
}
if oaiError := compactResp.GetOpenAIError(); oaiError != nil && oaiError.Type != "" {
return nil, types.WithOpenAIError(*oaiError, resp.StatusCode)
}

service.IOCopyBytesGracefully(c, resp, responseBody)

usage := dto.Usage{}
if compactResp.Usage != nil {
usage.PromptTokens = compactResp.Usage.InputTokens
usage.CompletionTokens = compactResp.Usage.OutputTokens
usage.TotalTokens = compactResp.Usage.TotalTokens
if compactResp.Usage.InputTokensDetails != nil {
usage.PromptTokensDetails.CachedTokens = compactResp.Usage.InputTokensDetails.CachedTokens
}
}

return &usage, nil
}
14 changes: 14 additions & 0 deletions relay/common/relay_info.go
Original file line number Diff line number Diff line change
Expand Up @@ -481,6 +481,11 @@ func GenRelayInfo(c *gin.Context, relayFormat types.RelayFormat, request dto.Req
break
}
err = errors.New("request is not a OpenAIResponsesRequest")
case types.RelayFormatOpenAIResponsesCompaction:
if request, ok := request.(*dto.OpenAIResponsesCompactionRequest); ok {
return GenRelayInfoResponsesCompaction(c, request), nil
}
return nil, errors.New("request is not a OpenAIResponsesCompactionRequest")
Comment on lines +484 to +488

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Initialize RequestConversionChain for compaction paths.

This branch returns early, so InitRequestConversionChain() never runs and the original relay format won’t be recorded. Align with the other formats by setting info and falling through to the common init.

💡 Suggested fix
 case types.RelayFormatOpenAIResponsesCompaction:
 	if request, ok := request.(*dto.OpenAIResponsesCompactionRequest); ok {
-		return GenRelayInfoResponsesCompaction(c, request), nil
+		info = GenRelayInfoResponsesCompaction(c, request)
+		break
 	}
-	return nil, errors.New("request is not a OpenAIResponsesCompactionRequest")
+	err = errors.New("request is not a OpenAIResponsesCompactionRequest")
🤖 Prompt for AI Agents
In `@relay/common/relay_info.go` around lines 484 - 488, The compaction branch
currently returns early and prevents the common InitRequestConversionChain from
running; change this branch to mirror the others by assigning info :=
GenRelayInfoResponsesCompaction(c, request) (after type-asserting request to
*dto.OpenAIResponsesCompactionRequest) instead of returning, so execution falls
through to the shared initialization logic (and remove the early return path
that returns the error); keep the type-check and still return an error only if
the assertion fails.

case types.RelayFormatTask:
info = genBaseRelayInfo(c, nil)
case types.RelayFormatMjProxy:
Expand Down Expand Up @@ -531,6 +536,15 @@ func (info *RelayInfo) AppendRequestConversion(format types.RelayFormat) {
info.RequestConversionChain = append(info.RequestConversionChain, format)
}

func GenRelayInfoResponsesCompaction(c *gin.Context, request *dto.OpenAIResponsesCompactionRequest) *RelayInfo {
info := genBaseRelayInfo(c, request)
if info.RelayMode == relayconstant.RelayModeUnknown {
info.RelayMode = relayconstant.RelayModeResponsesCompact
}
info.RelayFormat = types.RelayFormatOpenAIResponsesCompaction
return info
}

//func (info *RelayInfo) SetPromptTokens(promptTokens int) {
// info.promptTokens = promptTokens
//}
Expand Down
4 changes: 4 additions & 0 deletions relay/constant/relay_mode.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ const (
RelayModeRealtime

RelayModeGemini

RelayModeResponsesCompact
)

func Path2RelayMode(path string) int {
Expand All @@ -70,6 +72,8 @@ func Path2RelayMode(path string) int {
relayMode = RelayModeImagesEdits
} else if strings.HasPrefix(path, "/v1/edits") {
relayMode = RelayModeEdits
} else if strings.HasPrefix(path, "/v1/responses/compact") {
relayMode = RelayModeResponsesCompact
} else if strings.HasPrefix(path, "/v1/responses") {
relayMode = RelayModeResponses
} else if strings.HasPrefix(path, "/v1/audio/speech") {
Expand Down
25 changes: 24 additions & 1 deletion relay/helper/model_mapped.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,27 @@ import (
"encoding/json"
"errors"
"fmt"
"strings"

"github.com/QuantumNous/new-api/dto"
"github.com/QuantumNous/new-api/relay/common"
relayconstant "github.com/QuantumNous/new-api/relay/constant"
"github.com/QuantumNous/new-api/setting/ratio_setting"
"github.com/gin-gonic/gin"
)

func ModelMappedHelper(c *gin.Context, info *common.RelayInfo, request dto.Request) error {
if info.ChannelMeta == nil {
info.ChannelMeta = &common.ChannelMeta{}
}

isResponsesCompact := info.RelayMode == relayconstant.RelayModeResponsesCompact
originModelName := info.OriginModelName
mappingModelName := originModelName
if isResponsesCompact && strings.HasSuffix(originModelName, ratio_setting.CompactModelSuffix) {
mappingModelName = strings.TrimSuffix(originModelName, ratio_setting.CompactModelSuffix)
}

// map model name
modelMapping := c.GetString("model_mapping")
if modelMapping != "" && modelMapping != "{}" {
Expand All @@ -21,7 +35,7 @@ func ModelMappedHelper(c *gin.Context, info *common.RelayInfo, request dto.Reque
}

// 支持链式模型重定向,最终使用链尾的模型
currentModel := info.OriginModelName
currentModel := mappingModelName
visitedModels := map[string]bool{
currentModel: true,
}
Expand Down Expand Up @@ -51,6 +65,15 @@ func ModelMappedHelper(c *gin.Context, info *common.RelayInfo, request dto.Reque
info.UpstreamModelName = currentModel
}
}

if isResponsesCompact {
finalUpstreamModelName := mappingModelName
if info.IsModelMapped && info.UpstreamModelName != "" {
finalUpstreamModelName = info.UpstreamModelName
}
info.UpstreamModelName = finalUpstreamModelName
info.OriginModelName = ratio_setting.WithCompactModelSuffix(finalUpstreamModelName)
}
if request != nil {
request.SetModelName(info.UpstreamModelName)
}
Comment on lines 77 to 79

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# Find all SetModelName calls and their context
ast-grep --pattern 'SetModelName($_)'

Repository: QuantumNous/new-api

Length of output: 45


🏁 Script executed:

# Read the relevant section of model_mapped.go to understand the complete logic flow
wc -l relay/helper/model_mapped.go

Repository: QuantumNous/new-api

Length of output: 94


🏁 Script executed:

# Read the entire model_mapped.go file to understand the logic
cat -n relay/helper/model_mapped.go

Repository: QuantumNous/new-api

Length of output: 2903


🏁 Script executed:

# Search for SetModelName implementation and where request comes from
rg -B 5 -A 5 "SetModelName" relay/

Repository: QuantumNous/new-api

Length of output: 1778


🏁 Script executed:

# Check where UpstreamModelName is initialized and used
rg "UpstreamModelName\s*=" relay/ -B 2 -A 2

Repository: QuantumNous/new-api

Length of output: 6974


🏁 Script executed:

# Find the Request type and SetModelName definition
fd "request\.go|dto\.go" relay/ | head -5

Repository: QuantumNous/new-api

Length of output: 196


🏁 Script executed:

# Find RelayInfo struct definition
rg "type RelayInfo struct" relay/ -A 20

Repository: QuantumNous/new-api

Length of output: 1263


🏁 Script executed:

# Check api_request.go to understand SetModelName
cat -n relay/channel/api_request.go | head -60

Repository: QuantumNous/new-api

Length of output: 2127


🏁 Script executed:

# Search for SetModelName implementation
rg "func.*SetModelName" relay/ -A 5

Repository: QuantumNous/new-api

Length of output: 45


🏁 Script executed:

# Look for the Request interface/struct definition and SetModelName
rg "SetModelName" dto/ -B 2 -A 3

Repository: QuantumNous/new-api

Length of output: 3113


Use OriginModelName as fallback when no mapping occurs.

When isResponsesCompact is false and IsModelMapped is false, UpstreamModelName remains empty. While SetModelName("") is safely handled by guard clauses in all implementations and won't clear the model, this pattern is inconsistent with the approach in relay/common/relay_info.go (line 172), which explicitly uses OriginModelName as a fallback. For clarity and consistency, consider:

if isResponsesCompact {
	finalUpstreamModelName := mappingModelName
	if info.IsModelMapped && info.UpstreamModelName != "" {
		finalUpstreamModelName = info.UpstreamModelName
	}
	info.UpstreamModelName = finalUpstreamModelName
	info.OriginModelName = ratio_setting.WithCompactModelSuffix(finalUpstreamModelName)
} else if info.UpstreamModelName == "" {
	info.UpstreamModelName = info.OriginModelName
}
🤖 Prompt for AI Agents
In @relay/helper/model_mapped.go around lines 77 - 79, When isResponsesCompact
is false and info.IsModelMapped is false, ensure info.UpstreamModelName falls
back to info.OriginModelName instead of leaving it empty; update the logic
around request.SetModelName(info.UpstreamModelName) in
relay/helper/model_mapped.go to compute a finalUpstreamModelName (use
mappingModelName when compact, prefer info.UpstreamModelName when mapped and
non-empty, otherwise set info.UpstreamModelName = info.OriginModelName) and also
set info.OriginModelName =
ratio_setting.WithCompactModelSuffix(finalUpstreamModelName) when compact; then
call request.SetModelName(finalUpstreamModelName).

Expand Down
Loading