valid_request.go 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. package helper
  2. import (
  3. "errors"
  4. "fmt"
  5. "math"
  6. "one-api/common"
  7. "one-api/dto"
  8. "one-api/logger"
  9. relayconstant "one-api/relay/constant"
  10. "one-api/types"
  11. "strings"
  12. "github.com/gin-gonic/gin"
  13. )
  14. func GetAndValidateRequest(c *gin.Context, format types.RelayFormat) (request dto.Request, err error) {
  15. relayMode := relayconstant.Path2RelayMode(c.Request.URL.Path)
  16. switch format {
  17. case types.RelayFormatOpenAI:
  18. request, err = GetAndValidateTextRequest(c, relayMode)
  19. case types.RelayFormatGemini:
  20. if strings.Contains(c.Request.URL.Path, ":embedContent") || strings.Contains(c.Request.URL.Path, ":batchEmbedContents") {
  21. request, err = GetAndValidateGeminiEmbeddingRequest(c)
  22. } else {
  23. request, err = GetAndValidateGeminiRequest(c)
  24. }
  25. case types.RelayFormatClaude:
  26. request, err = GetAndValidateClaudeRequest(c)
  27. case types.RelayFormatOpenAIResponses:
  28. request, err = GetAndValidateResponsesRequest(c)
  29. case types.RelayFormatOpenAIImage:
  30. request, err = GetAndValidOpenAIImageRequest(c, relayMode)
  31. case types.RelayFormatEmbedding:
  32. request, err = GetAndValidateEmbeddingRequest(c, relayMode)
  33. case types.RelayFormatRerank:
  34. request, err = GetAndValidateRerankRequest(c)
  35. case types.RelayFormatOpenAIAudio:
  36. request, err = GetAndValidAudioRequest(c, relayMode)
  37. case types.RelayFormatOpenAIRealtime:
  38. request = &dto.BaseRequest{}
  39. default:
  40. return nil, fmt.Errorf("unsupported relay format: %s", format)
  41. }
  42. return request, err
  43. }
  44. func GetAndValidAudioRequest(c *gin.Context, relayMode int) (*dto.AudioRequest, error) {
  45. audioRequest := &dto.AudioRequest{}
  46. err := common.UnmarshalBodyReusable(c, audioRequest)
  47. if err != nil {
  48. return nil, err
  49. }
  50. switch relayMode {
  51. case relayconstant.RelayModeAudioSpeech:
  52. if audioRequest.Model == "" {
  53. return nil, errors.New("model is required")
  54. }
  55. default:
  56. err = c.Request.ParseForm()
  57. if err != nil {
  58. return nil, err
  59. }
  60. formData := c.Request.PostForm
  61. if audioRequest.Model == "" {
  62. audioRequest.Model = formData.Get("model")
  63. }
  64. if audioRequest.Model == "" {
  65. return nil, errors.New("model is required")
  66. }
  67. audioRequest.ResponseFormat = formData.Get("response_format")
  68. if audioRequest.ResponseFormat == "" {
  69. audioRequest.ResponseFormat = "json"
  70. }
  71. }
  72. return audioRequest, nil
  73. }
  74. func GetAndValidateRerankRequest(c *gin.Context) (*dto.RerankRequest, error) {
  75. var rerankRequest *dto.RerankRequest
  76. err := common.UnmarshalBodyReusable(c, &rerankRequest)
  77. if err != nil {
  78. logger.LogError(c, fmt.Sprintf("getAndValidateTextRequest failed: %s", err.Error()))
  79. return nil, types.NewError(err, types.ErrorCodeInvalidRequest, types.ErrOptionWithSkipRetry())
  80. }
  81. if rerankRequest.Query == "" {
  82. return nil, types.NewError(fmt.Errorf("query is empty"), types.ErrorCodeInvalidRequest, types.ErrOptionWithSkipRetry())
  83. }
  84. if len(rerankRequest.Documents) == 0 {
  85. return nil, types.NewError(fmt.Errorf("documents is empty"), types.ErrorCodeInvalidRequest, types.ErrOptionWithSkipRetry())
  86. }
  87. return rerankRequest, nil
  88. }
  89. func GetAndValidateEmbeddingRequest(c *gin.Context, relayMode int) (*dto.EmbeddingRequest, error) {
  90. var embeddingRequest *dto.EmbeddingRequest
  91. err := common.UnmarshalBodyReusable(c, &embeddingRequest)
  92. if err != nil {
  93. logger.LogError(c, fmt.Sprintf("getAndValidateTextRequest failed: %s", err.Error()))
  94. return nil, types.NewError(err, types.ErrorCodeInvalidRequest, types.ErrOptionWithSkipRetry())
  95. }
  96. if embeddingRequest.Input == nil {
  97. return nil, fmt.Errorf("input is empty")
  98. }
  99. if relayMode == relayconstant.RelayModeModerations && embeddingRequest.Model == "" {
  100. embeddingRequest.Model = "omni-moderation-latest"
  101. }
  102. if relayMode == relayconstant.RelayModeEmbeddings && embeddingRequest.Model == "" {
  103. embeddingRequest.Model = c.Param("model")
  104. }
  105. return embeddingRequest, nil
  106. }
  107. func GetAndValidateResponsesRequest(c *gin.Context) (*dto.OpenAIResponsesRequest, error) {
  108. request := &dto.OpenAIResponsesRequest{}
  109. err := common.UnmarshalBodyReusable(c, request)
  110. if err != nil {
  111. return nil, err
  112. }
  113. if request.Model == "" {
  114. return nil, errors.New("model is required")
  115. }
  116. if request.Input == nil {
  117. return nil, errors.New("input is required")
  118. }
  119. return request, nil
  120. }
  121. func GetAndValidOpenAIImageRequest(c *gin.Context, relayMode int) (*dto.ImageRequest, error) {
  122. imageRequest := &dto.ImageRequest{}
  123. switch relayMode {
  124. case relayconstant.RelayModeImagesEdits:
  125. if strings.Contains(c.Request.Header.Get("Content-Type"), "multipart/form-data") {
  126. _, err := c.MultipartForm()
  127. if err != nil {
  128. return nil, fmt.Errorf("failed to parse image edit form request: %w", err)
  129. }
  130. formData := c.Request.PostForm
  131. imageRequest.Prompt = formData.Get("prompt")
  132. imageRequest.Model = formData.Get("model")
  133. imageRequest.N = uint(common.String2Int(formData.Get("n")))
  134. imageRequest.Quality = formData.Get("quality")
  135. imageRequest.Size = formData.Get("size")
  136. if imageRequest.Model == "gpt-image-1" {
  137. if imageRequest.Quality == "" {
  138. imageRequest.Quality = "standard"
  139. }
  140. }
  141. if imageRequest.N == 0 {
  142. imageRequest.N = 1
  143. }
  144. watermark := formData.Has("watermark")
  145. if watermark {
  146. imageRequest.Watermark = &watermark
  147. }
  148. break
  149. }
  150. fallthrough
  151. default:
  152. err := common.UnmarshalBodyReusable(c, imageRequest)
  153. if err != nil {
  154. return nil, err
  155. }
  156. if imageRequest.Model == "" {
  157. //imageRequest.Model = "dall-e-3"
  158. return nil, errors.New("model is required")
  159. }
  160. if strings.Contains(imageRequest.Size, "×") {
  161. return nil, errors.New("size an unexpected error occurred in the parameter, please use 'x' instead of the multiplication sign '×'")
  162. }
  163. // Not "256x256", "512x512", or "1024x1024"
  164. if imageRequest.Model == "dall-e-2" || imageRequest.Model == "dall-e" {
  165. if imageRequest.Size != "" && imageRequest.Size != "256x256" && imageRequest.Size != "512x512" && imageRequest.Size != "1024x1024" {
  166. return nil, errors.New("size must be one of 256x256, 512x512, or 1024x1024 for dall-e-2 or dall-e")
  167. }
  168. if imageRequest.Size == "" {
  169. imageRequest.Size = "1024x1024"
  170. }
  171. } else if imageRequest.Model == "dall-e-3" {
  172. if imageRequest.Size != "" && imageRequest.Size != "1024x1024" && imageRequest.Size != "1024x1792" && imageRequest.Size != "1792x1024" {
  173. return nil, errors.New("size must be one of 1024x1024, 1024x1792 or 1792x1024 for dall-e-3")
  174. }
  175. if imageRequest.Quality == "" {
  176. imageRequest.Quality = "standard"
  177. }
  178. if imageRequest.Size == "" {
  179. imageRequest.Size = "1024x1024"
  180. }
  181. } else if imageRequest.Model == "gpt-image-1" {
  182. if imageRequest.Quality == "" {
  183. imageRequest.Quality = "auto"
  184. }
  185. }
  186. //if imageRequest.Prompt == "" {
  187. // return nil, errors.New("prompt is required")
  188. //}
  189. if imageRequest.N == 0 {
  190. imageRequest.N = 1
  191. }
  192. }
  193. return imageRequest, nil
  194. }
  195. func GetAndValidateClaudeRequest(c *gin.Context) (textRequest *dto.ClaudeRequest, err error) {
  196. textRequest = &dto.ClaudeRequest{}
  197. err = c.ShouldBindJSON(textRequest)
  198. if err != nil {
  199. return nil, err
  200. }
  201. if textRequest.Messages == nil || len(textRequest.Messages) == 0 {
  202. return nil, errors.New("field messages is required")
  203. }
  204. if textRequest.Model == "" {
  205. return nil, errors.New("field model is required")
  206. }
  207. //if textRequest.Stream {
  208. // relayInfo.IsStream = true
  209. //}
  210. return textRequest, nil
  211. }
  212. func GetAndValidateTextRequest(c *gin.Context, relayMode int) (*dto.GeneralOpenAIRequest, error) {
  213. textRequest := &dto.GeneralOpenAIRequest{}
  214. err := common.UnmarshalBodyReusable(c, textRequest)
  215. if err != nil {
  216. return nil, err
  217. }
  218. if relayMode == relayconstant.RelayModeModerations && textRequest.Model == "" {
  219. textRequest.Model = "text-moderation-latest"
  220. }
  221. if relayMode == relayconstant.RelayModeEmbeddings && textRequest.Model == "" {
  222. textRequest.Model = c.Param("model")
  223. }
  224. if textRequest.MaxTokens > math.MaxInt32/2 {
  225. return nil, errors.New("max_tokens is invalid")
  226. }
  227. if textRequest.Model == "" {
  228. return nil, errors.New("model is required")
  229. }
  230. if textRequest.WebSearchOptions != nil {
  231. if textRequest.WebSearchOptions.SearchContextSize != "" {
  232. validSizes := map[string]bool{
  233. "high": true,
  234. "medium": true,
  235. "low": true,
  236. }
  237. if !validSizes[textRequest.WebSearchOptions.SearchContextSize] {
  238. return nil, errors.New("invalid search_context_size, must be one of: high, medium, low")
  239. }
  240. } else {
  241. textRequest.WebSearchOptions.SearchContextSize = "medium"
  242. }
  243. }
  244. switch relayMode {
  245. case relayconstant.RelayModeCompletions:
  246. if textRequest.Prompt == "" {
  247. return nil, errors.New("field prompt is required")
  248. }
  249. case relayconstant.RelayModeChatCompletions:
  250. // For FIM (Fill-in-the-middle) requests with prefix/suffix, messages is optional
  251. // It will be filled by provider-specific adaptors if needed (e.g., SiliconFlow)。Or it is allowed by model vendor(s) (e.g., DeepSeek)
  252. if len(textRequest.Messages) == 0 && textRequest.Prefix == nil && textRequest.Suffix == nil {
  253. return nil, errors.New("field messages is required")
  254. }
  255. case relayconstant.RelayModeEmbeddings:
  256. case relayconstant.RelayModeModerations:
  257. if textRequest.Input == nil || textRequest.Input == "" {
  258. return nil, errors.New("field input is required")
  259. }
  260. case relayconstant.RelayModeEdits:
  261. if textRequest.Instruction == "" {
  262. return nil, errors.New("field instruction is required")
  263. }
  264. }
  265. return textRequest, nil
  266. }
  267. func GetAndValidateGeminiRequest(c *gin.Context) (*dto.GeminiChatRequest, error) {
  268. request := &dto.GeminiChatRequest{}
  269. err := common.UnmarshalBodyReusable(c, request)
  270. if err != nil {
  271. return nil, err
  272. }
  273. if len(request.Contents) == 0 {
  274. return nil, errors.New("contents is required")
  275. }
  276. //if c.Query("alt") == "sse" {
  277. // relayInfo.IsStream = true
  278. //}
  279. return request, nil
  280. }
  281. func GetAndValidateGeminiEmbeddingRequest(c *gin.Context) (*dto.GeminiEmbeddingRequest, error) {
  282. request := &dto.GeminiEmbeddingRequest{}
  283. err := common.UnmarshalBodyReusable(c, request)
  284. if err != nil {
  285. return nil, err
  286. }
  287. return request, nil
  288. }