chore: o1模型使用max_completion_tokens

[DDMeaqua]

💻 变更类型 | Change Type

• feat
• fix
• refactor
• perf
• style
• test
• docs
• ci
• chore
• build

🔀 变更说明 | Description of Change

#5635

📝 补充信息 | Additional Information

Summary by CodeRabbit

• New Features

  • Introduced a new optional property max_completion_tokens for more granular control over token limits in completion requests.
  • Enhanced the chat functionality to conditionally include max_completion_tokens for the "o1" model.

• Bug Fixes

  • Clarified the handling of the max_tokens parameter for DALL-E 3 models, ensuring it is capped at 4000 tokens.

[vercel]

@DDMeaqua is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes in this pull request involve modifications to the RequestPayload interface by adding an optional property max_completion_tokens. This allows for specifying a maximum number of tokens for completion requests. Updates to the chat method in the ChatGPTApi class conditionally integrate this new property based on the model configuration, specifically for the "o1" model. The handling of max_tokens for DALL-E 3 models remains intact, with a clarification that it is capped at 4000 tokens.

Changes

File Path	Change Summary
app/client/platforms/openai.ts	Updated RequestPayload interface to include max_completion_tokens?. Modified chat method to conditionally include max_completion_tokens for the "o1" model. Clarified handling of max_tokens for DALL-E 3 models, set to a maximum of 4000 tokens.

Possibly related PRs

• fix no max_tokens in payload when the vision model name does not cont… #5304: Modifies the max_tokens handling in the ChatGPTApi class, directly related to the introduction of max_completion_tokens.
• fix: remove the visual model judgment method that checks if the model… #5415: Addresses logic for adding max_tokens to the request payload, aligning with the updates in the main PR.
• feat: add o1 model #5416: Introduces handling for the "o1" model in the ChatGPTApi, relevant to the changes in model configurations and token management.

Suggested labels

planned

Suggested reviewers

• lloydzhou
• Dogtiti

🐇 In a world of tokens, we hop and play,
New limits set for a brighter day.
With max_completion_tokens, we leap so high,
For "o1" models, we reach for the sky!
DALL-E's cap is clear, no need to fret,
In the garden of code, new features are set! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Your build has completed!

Preview deployment

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

app/client/platforms/openai.ts (2)

237-237: Consider translating the comment to English

For better international collaboration, consider translating the Chinese comment to English:

-// O1 使用 max_completion_tokens 控制token数 (https://platform.openai.com/docs/guides/reasoning#controlling-costs)
+// O1 model uses max_completion_tokens to control token count (https://platform.openai.com/docs/guides/reasoning#controlling-costs)

---

238-241: Consider adding token limit validation

While the implementation correctly sets max_completion_tokens for the o1 model, consider adding validation for the token limit to prevent potential API errors:

 if (isO1) {
+  const MAX_O1_TOKENS = 4096; // Adjust this value based on the model's actual limit
+  const validatedTokens = Math.min(
+    Math.max(modelConfig.max_tokens, 1),
+    MAX_O1_TOKENS
+  );
-  requestPayload["max_completion_tokens"] = modelConfig.max_tokens;
+  requestPayload["max_completion_tokens"] = validatedTokens;
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fbb9385 and d5bda29.

📒 Files selected for processing (1)

• app/client/platforms/openai.ts (2 hunks)

🔇 Additional comments (1)

app/client/platforms/openai.ts (1)

68-68: LGTM: Interface update aligns with OpenAI's documentation

The addition of max_completion_tokens as an optional number property follows OpenAI's guidelines for controlling costs in their reasoning guide.