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: Update bot api support knowledge #176

Conversation

fanhang34
Copy link
Contributor

@fanhang34 fanhang34 commented Jan 22, 2025

#167

Summary by CodeRabbit

  • New Features

    • Introduced BotKnowledge configuration option for bots.
    • Added ability to specify dataset IDs, auto-call settings, and search strategy when creating or updating bots.
  • Improvements

    • Enhanced bot creation and update methods to support knowledge configuration.
    • Expanded library's flexibility for bot management.

Copy link

coderabbitai bot commented Jan 22, 2025

Walkthrough

The pull request introduces a new BotKnowledge class to the Cozepy library, which allows configuring bot knowledge settings. This enhancement enables users to specify dataset IDs, auto-call behavior, and search strategies when creating or updating bots. The changes are implemented across the __init__.py files in the cozepy and cozepy/bots modules, expanding the library's functionality for bot configuration.

Changes

File Change Summary
cozepy/__init__.py Added BotKnowledge to import statements and __all__ list
cozepy/bots/__init__.py - Added BotKnowledge class with dataset_ids, auto_call, and search_strategy attributes
- Updated Bot class to include optional knowledge attribute
- Modified BotsClient and AsyncBotsClient create and update methods to support knowledge parameter

Sequence Diagram

sequenceDiagram
    participant User
    participant BotsClient
    participant Bot
    
    User->>BotsClient: create/update bot
    User->>BotsClient: with BotKnowledge
    BotsClient->>Bot: Configure knowledge settings
    Bot-->>BotsClient: Bot with knowledge configuration
    BotsClient-->>User: Configured bot
Loading

Poem

🐰 A rabbit's tale of bot delight,
Knowledge now takes a curious flight!
Dataset IDs dancing free,
Auto-call with playful glee,
Cozepy's magic shines so bright! 🌟


📜 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 2a85e67 and d154d34.

📒 Files selected for processing (1)
  • cozepy/__init__.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cozepy/init.py
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test (Python 3.8 on macOS)
  • GitHub Check: test (Python 3.8 on Windows)

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/bots/__init__.py (1)

23-30: Consider using an enum for search_strategy values.

The search strategy values (0, 1, 20) would be better represented as an enum, similar to how BotMode is implemented. This would improve code maintainability and type safety.

+class BotSearchStrategy(IntEnum):
+    SEMANTIC_SEARCH = 0
+    HYBRID_SEARCH = 1
+    FULL_TEXT_SEARCH = 20
+
 class BotKnowledge(CozeModel):
     dataset_ids: List[str] = []
     auto_call: bool = True
-    search_strategy: int = 0
+    search_strategy: BotSearchStrategy = BotSearchStrategy.SEMANTIC_SEARCH
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2c3d507 and 2a85e67.

📒 Files selected for processing (2)
  • cozepy/__init__.py (2 hunks)
  • cozepy/bots/__init__.py (8 hunks)
🔇 Additional comments (4)
cozepy/bots/__init__.py (3)

86-87: LGTM!

The knowledge attribute is well-documented and properly integrated into the Bot class with correct type hints.


169-169: LGTM!

The knowledge parameter is well-integrated into the update method with comprehensive documentation and consistent implementation.

Also applies to: 188-188, 199-199


324-324: LGTM!

The knowledge parameter implementation in the async client perfectly mirrors the sync client implementation.

Also applies to: 343-343, 354-354

cozepy/__init__.py (1)

25-25: LGTM!

The BotKnowledge class is properly exposed in the module's public interface.

Also applies to: 183-183

@chyroc chyroc added the feature label Jan 27, 2025
@chyroc chyroc changed the title Feature/bot update api supports modifying dataset feat: Update bot api support knowledge Feb 5, 2025
Copy link

codecov bot commented Feb 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.02%. Comparing base (86956f9) to head (e66c323).
Report is 1 commits behind head on main.

@@           Coverage Diff           @@
##             main     #176   +/-   ##
=======================================
  Coverage   90.01%   90.02%           
=======================================
  Files          65       65           
  Lines        5840     5845    +5     
=======================================
+ Hits         5257     5262    +5     
  Misses        583      583           
Files with missing lines Coverage Δ
cozepy/__init__.py 100.00% <ø> (ø)
cozepy/bots/__init__.py 100.00% <100.00%> (ø)

@chyroc chyroc merged commit 03e5312 into coze-dev:main Feb 5, 2025
14 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.

2 participants