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

Feature/bot update api supports modifying dataset #174

Conversation

fanhang34
Copy link

@fanhang34 fanhang34 commented Jan 21, 2025

#167 更新智能体接口不支持修改知识库

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced BotKnowledge configuration to enhance bot capabilities.
    • Added ability to configure bot's knowledge base with dataset IDs, auto-call, and search strategies.
  • Improvements

    • Updated bot creation and update methods to support knowledge configuration.
    • Extended bot model to include optional knowledge settings.

Copy link

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request introduces a new BotKnowledge class to the Cozepy library, expanding the public interface and enhancing the configuration capabilities for bots. This addition allows users to specify knowledge base settings such as dataset IDs, auto-call behavior, and search strategies. The changes modify the Bot, BotsClient, and AsyncBotsClient classes to incorporate an optional knowledge parameter, enabling more flexible bot configuration and knowledge management.

Changes

File Change Summary
cozepy/__init__.py Added BotKnowledge to imports and __all__ list
cozepy/bots/__init__.py - New BotKnowledge class added
- Updated Bot class with optional knowledge attribute
- Modified create and update methods in BotsClient and AsyncBotsClient to support knowledge parameter

Poem

🐰 A rabbit's tale of knowledge bright,
Bots now learn with newfound might!
Dataset IDs and search so keen,
Configuring wisdom, a coder's dream
Hop along, code with delight! 🌟


📜 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 9cef61d and 289aba7.

📒 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

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.

@chyroc chyroc added the feature label Jan 22, 2025
@chyroc
Copy link
Collaborator

chyroc commented Jan 22, 2025

请修复 ci

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: 2

🔭 Outside diff range comments (1)
cozepy/__init__.py (1)

Line range hint 1-154: Fix import sorting and formatting as per pipeline failure.

The import block is un-sorted or un-formatted, leading to a pipeline failure. Please run ruff --fix to automatically sort and format the imports according to the project's code standards.

This issue is causing the CI pipeline to fail. Applying the fix will ensure the imports are properly organized and adhere to the style guidelines.

📜 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 9cef61d.

📒 Files selected for processing (2)
  • cozepy/__init__.py (2 hunks)
  • cozepy/bots/__init__.py (10 hunks)
🧰 Additional context used
🪛 GitHub Actions: CI
cozepy/__init__.py

[error] 1-154: Import block is un-sorted or un-formatted. This can be fixed automatically using the --fix option with ruff.

🔇 Additional comments (2)
cozepy/bots/__init__.py (2)

23-30: BotKnowledge class definition looks good.

The addition of the BotKnowledge class with appropriate default values enhances the bot's knowledge configuration capabilities.


86-87: Addition of knowledge attribute to Bot class is appropriate.

Including the optional knowledge attribute in the Bot class allows bots to utilize knowledge configurations effectively.

Comment on lines +294 to +301
self,
*,
space_id: str,
name: str,
description: Optional[str] = None,
icon_file_id: Optional[str] = None,
prompt_info: Optional[BotPromptInfo] = None,
onboarding_info: Optional[BotOnboardingInfo] = None,
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add the knowledge parameter to the async create method for consistency and functionality.

Similar to the synchronous create method, the asynchronous create method in AsyncBotsClient lacks the knowledge parameter. To enable setting the bot's knowledge configuration during creation, consider adding the knowledge parameter.

Apply this diff to add the knowledge parameter to the create method and include it in the request body:

 async def create(
     self,
     *,
     space_id: str,
     name: str,
     description: Optional[str] = None,
     icon_file_id: Optional[str] = None,
     prompt_info: Optional[BotPromptInfo] = None,
     onboarding_info: Optional[BotOnboardingInfo] = None,
+    knowledge: Optional[BotKnowledge] = None,
 ) -> Bot:
     url = f"{self._base_url}/v1/bot/create"
     body = {
         "space_id": space_id,
         "name": name,
         "description": description,
         "icon_file_id": icon_file_id,
         "prompt_info": prompt_info.model_dump() if prompt_info else None,
         "onboarding_info": onboarding_info.model_dump() if onboarding_info else None,
+        "knowledge": knowledge.model_dump() if knowledge else None,
     }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
self,
*,
space_id: str,
name: str,
description: Optional[str] = None,
icon_file_id: Optional[str] = None,
prompt_info: Optional[BotPromptInfo] = None,
onboarding_info: Optional[BotOnboardingInfo] = None,
self,
*,
space_id: str,
name: str,
description: Optional[str] = None,
icon_file_id: Optional[str] = None,
prompt_info: Optional[BotPromptInfo] = None,
onboarding_info: Optional[BotOnboardingInfo] = None,
knowledge: Optional[BotKnowledge] = None,

Comment on lines +139 to +146
self,
*,
space_id: str,
name: str,
description: Optional[str] = None,
icon_file_id: Optional[str] = None,
prompt_info: Optional[BotPromptInfo] = None,
onboarding_info: Optional[BotOnboardingInfo] = None,
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add the knowledge parameter to the create method for consistency and functionality.

Currently, the create method does not accept a knowledge parameter, which means the bot's knowledge configuration cannot be set during creation. To allow users to set the bot's knowledge during creation and avoid the need for a subsequent update, consider adding the knowledge parameter to the create method.

Apply this diff to add the knowledge parameter to the create method and include it in the request body:

 def create(
     self,
     *,
     space_id: str,
     name: str,
     description: Optional[str] = None,
     icon_file_id: Optional[str] = None,
     prompt_info: Optional[BotPromptInfo] = None,
     onboarding_info: Optional[BotOnboardingInfo] = None,
+    knowledge: Optional[BotKnowledge] = None,
 ) -> Bot:
     url = f"{self._base_url}/v1/bot/create"
     body = {
         "space_id": space_id,
         "name": name,
         "description": description,
         "icon_file_id": icon_file_id,
         "prompt_info": prompt_info.model_dump() if prompt_info else None,
         "onboarding_info": onboarding_info.model_dump() if onboarding_info else None,
+        "knowledge": knowledge.model_dump() if knowledge else None,
     }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
self,
*,
space_id: str,
name: str,
description: Optional[str] = None,
icon_file_id: Optional[str] = None,
prompt_info: Optional[BotPromptInfo] = None,
onboarding_info: Optional[BotOnboardingInfo] = None,
self,
*,
space_id: str,
name: str,
description: Optional[str] = None,
icon_file_id: Optional[str] = None,
prompt_info: Optional[BotPromptInfo] = None,
onboarding_info: Optional[BotOnboardingInfo] = None,
knowledge: Optional[BotKnowledge] = None,

@fanhang34 fanhang34 closed this Jan 22, 2025
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