Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add inserted_additional_messages to chat response #169

Merged
merged 4 commits into from
Jan 20, 2025

Conversation

Lexiay
Copy link
Contributor

@Lexiay Lexiay commented Jan 18, 2025

增加conversation.chat.created事件中的inserted_additional_messages字段 #168

Summary by CodeRabbit

  • New Features
    • Enhanced chat data model to support additional messages.
    • Added optional capability to insert supplementary messages into chat context.

增加conversation.chat.created事件中的inserted_additional_messages字段
Copy link

coderabbitai bot commented Jan 18, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a new class InsertedMessage in the cozepy/chat/__init__.py file. This class extends CozeModel and contains a single id attribute of type str. The existing Chat class has been updated to include an optional attribute inserted_additional_messages, which is a list of InsertedMessage instances. This modification allows for more flexible message management within the chat context without altering existing functionality.

Changes

File Change Summary
cozepy/chat/__init__.py - Added new InsertedMessage class with id attribute
- Updated Chat class to include optional inserted_additional_messages list

Poem

🐰 A rabbit's tale of messages new,
Inserted with grace, a data breakthrough!
IDs dancing in a list so bright,
Enhancing chats with pure delight 🌟
Code evolves, flexibility takes flight! 📨


📜 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 70c4f2c and 2f36a27.

📒 Files selected for processing (1)
  • cozepy/chat/__init__.py (2 hunks)

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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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)
cozepy/chat/__init__.py (1)

324-324: Add docstring for the new field.

The new field inserted_additional_messages would benefit from documentation explaining its purpose and usage. Consider adding a docstring comment similar to other fields in the class.

     usage: Optional[ChatUsage] = None

-    inserted_additional_messages: Optional[List[ChatInsertedAdditionalMessage]] = None
+    # List of additional messages that were inserted into the chat.
+    # These messages are typically system-generated or automatically inserted content.
+    inserted_additional_messages: Optional[List[ChatInsertedAdditionalMessage]] = None
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8e40beb and aa8f290.

📒 Files selected for processing (1)
  • cozepy/chat/__init__.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test (Python 3.8 on Windows)
🔇 Additional comments (1)
cozepy/chat/__init__.py (1)

286-288: LGTM! Clean and well-structured model class.

The ChatInsertedAdditionalMessage class follows the established patterns in the codebase, inheriting from CozeModel and maintaining a simple, focused structure.

Copy link
Contributor

@wasd96040501 wasd96040501 left a comment

Choose a reason for hiding this comment

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

  1. 标题改成 feat: 开头,然后换成英文
  2. commit 也是
  3. ci 没有过: 运行一下 poetry run ruff format ,然后合并一下 commit 再 push 一下

@Lexiay Lexiay changed the title cozepy.chat.Chat类增加字段 add inserted_additional_messages field and ChatInsertedAdditionalMessage class Jan 20, 2025
@Lexiay Lexiay changed the title add inserted_additional_messages field and ChatInsertedAdditionalMessage class feat: add inserted_additional_messages field and ChatInsertedAdditionalMessage class Jan 20, 2025
@chyroc chyroc added the feature label Jan 20, 2025
Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.84%. Comparing base (3c7b915) to head (14ed43a).

@@            Coverage Diff             @@
##             main     #169      +/-   ##
==========================================
- Coverage   89.88%   89.84%   -0.05%     
==========================================
  Files          63       63              
  Lines        5765     5768       +3     
==========================================
  Hits         5182     5182              
- Misses        583      586       +3     
Files with missing lines Coverage Δ
cozepy/chat/__init__.py 97.17% <100.00%> (+0.03%) ⬆️

... and 1 file with indirect coverage changes

@chyroc chyroc changed the title feat: add inserted_additional_messages field and ChatInsertedAdditionalMessage class feat: Add inserted_additional_messages to chat response Jan 20, 2025
@chyroc chyroc merged commit fd67c33 into coze-dev:main Jan 20, 2025
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants