Skip to content

Conversation

@RyanStanLin
Copy link
Contributor

@RyanStanLin RyanStanLin commented Jul 21, 2025

Resolves #57

This PR resolves the critical history corruption issue within StreamContentAsync that occurred during streaming conversations with function calls.
The root cause was a logic that used request.Contents.Last() to determine the user's input.
This fix implements a more detailed logic that isolates the turn's real initial prompt and saves it paired with the model's final text answer, while ignoring all intermediate tool call steps, thus ensuring the chat history remains clean.

Summary by CodeRabbit

  • Bug Fixes
    • Improved chat history updates to more accurately associate AI responses with the correct user prompts, enhancing the reliability of conversation tracking.

@coderabbitai
Copy link

coderabbitai bot commented Jul 21, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The StreamContentAsync method in ChatSession.cs was updated to refine how chat history is maintained during streaming. Now, it selectively associates the streamed model response with a specific user prompt from the request contents, updating the history only when appropriate, rather than always appending the last content and response.

Changes

File(s) Change Summary
src/GenerativeAI/AiModels/ChatSession.cs Refactored StreamContentAsync to track history count, identify valid user prompts, and update history conditionally based on the presence of such prompts. No public API changes.

Estimated code review effort

2 (10–30 minutes)

Possibly related PRs

Poem

In the meadow of code where the chat streams flow,
A rabbit refines how the histories grow.
No more confusion, no more mess—
Prompts and replies now neatly coalesce!
With every hop, the session’s more wise,
Keeping the past clear in the chat’s sunrise.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f2ce891 and b2daca5.

📒 Files selected for processing (1)
  • src/GenerativeAI/AiModels/ChatSession.cs (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/GenerativeAI/AiModels/ChatSession.cs (1)

185-185: Consider potential performance optimization for response text building.

The sb.ToString() call creates the final response text, but the RequestExtensions.FormatGenerateContentInput might be doing additional processing that could be optimized.

Consider caching the result if FormatGenerateContentInput is expensive, or verify if the StringBuilder content can be used more directly:

-var finalModelResponseContent = RequestExtensions.FormatGenerateContentInput(sb.ToString(), Roles.Model);
+var responseText = sb.ToString();
+var finalModelResponseContent = RequestExtensions.FormatGenerateContentInput(responseText, Roles.Model);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0cc85eb and f2ce891.

📒 Files selected for processing (1)
  • src/GenerativeAI/AiModels/ChatSession.cs (1 hunks)
🔇 Additional comments (3)
src/GenerativeAI/AiModels/ChatSession.cs (3)

176-176: Good approach to track history state before processing.

Capturing the history count before processing the request is a clean way to identify which content items are new in this request. This helps avoid confusion between existing history and new content.


190-197: Conditional history update logic correctly addresses the core issue.

The conditional logic properly handles both scenarios:

  • When a valid user prompt is found: Updates history with the user prompt and model response
  • When no valid user prompt is found: Only updates LastResponseContent without modifying history

This approach ensures that intermediate function call steps don't corrupt the chat history while still maintaining the final response for reference.


186-189: Validate user prompt isolation in both streaming and non-streaming flows

  • Verify that history is prepended to request.Contents before identifying the user prompt:
    – Non-stream path: you’re already calling

    request.Contents.InsertRange(0, History);  // line 132

    which confirms the ordering assumption.
    – Streaming path: ensure that base.StreamContentAsync(request) also receives the same history-first ordering so that

    var historyCountBeforeRequest = this.History.Count;
    var userPromptContent = request.Contents
        .Skip(historyCountBeforeRequest)
        .FirstOrDefault();

    always skips the history messages, not just the new ones.

  • Consider how to handle multiple user prompts after skipping history:
    – With FirstOrDefault, only the first user message is used. If your scenario allows more than one new prompt in a single request, decide whether to switch to SingleOrDefault, LastOrDefault, or explicitly guard against multiple user entries.

Please confirm both the history insertion in the streaming override and your intended behavior when multiple prompts are present.

@gunpal5 gunpal5 merged commit ec66c5f into gunpal5:main Jul 21, 2025
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Q] Seeking Clarification on History Behavior with StreamContentAsync and Function Calling

2 participants