Fix: Encourage markdown inclusion in model responses for o1/o3 #6425
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@yunlingz is attempting to deploy a commit to the NextChat Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThis update extends the Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant C as ChatGPTApi
participant O as OpenAI Platform
U->>C: Call chat() with messages
alt Model is "o1" or "o3"
C->>C: Prepend developer message ("Formatting re-enabled")
end
C->>O: Send updated RequestPayload
O-->>C: Return response
C-->>U: Return response
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
💻 Change Type
🔀 Description of Change
By default, the o1/o3 models do not attempt to produce output with markdown formatting, resulting in a poor user experience due to responses being unformatted and hard to read.
This PR manually adds the developer message "Formatting re-enabled" to encourage the inclusion of markdown in model responses.
The developer message "Formatting re-enabled" is the official suggested way, references: https://platform.openai.com/docs/guides/reasoning-best-practices and https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/reasoning?tabs=python-secure#markdown-output.
Test results:
📝 Additional Information
Summary by CodeRabbit