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

added exception to track complete error #1662

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Conversation

sfahad1414
Copy link
Collaborator

@sfahad1414 sfahad1414 commented Dec 17, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced logging for error handling, now includes stack traces for better context.
    • The LLMClassifier now supports both intent classification and entity extraction.
  • Bug Fixes

    • Improved functionality of the LLMClassifier's methods to handle entity extraction correctly.

Copy link

coderabbitai bot commented Dec 17, 2024

Walkthrough

The pull request introduces two distinct changes across different files in the Kairon project. In the model_testing.py file, the error logging mechanism is enhanced by switching from logger.error() to logger.exception(), which provides more detailed stack trace information. In the llm.py file, the LLMClassifier is significantly expanded to support both intent classification and entity extraction by modifying its class inheritance, registration, and processing methods.

Changes

File Change Summary
kairon/events/definitions/model_testing.py Updated error logging to use logger.exception() for more comprehensive error tracking
kairon/nlu/classifiers/llm.py - Added EntityExtractorMixin to class inheritance
- Updated component registration to include ENTITY_EXTRACTOR
- Modified process and prepare_context methods to support entity extraction

Sequence Diagram

sequenceDiagram
    participant User
    participant LLMClassifier
    participant LLM
    User->>LLMClassifier: Send message
    LLMClassifier->>LLM: Classify intent
    LLM-->>LLMClassifier: Intent result
    LLMClassifier->>LLM: Extract entities
    LLM-->>LLMClassifier: Entity results
    LLMClassifier->>User: Return processed message
Loading

Poem

🐰 A Rabbit's Ode to Code Upgrade

Logs now trace with deeper might,
Classifiers dance with entity's light
From error's whisper to context clear
Our code evolves without a fear!
Hop, hop, hooray for progress bright! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between be8816b and 28d4325.

📒 Files selected for processing (2)
  • kairon/events/definitions/model_testing.py (1 hunks)
  • kairon/nlu/classifiers/llm.py (1 hunks)
🔇 Additional comments (1)
kairon/nlu/classifiers/llm.py (1)

34-38: Extending LLMClassifier to Support Entity Extraction

The addition of EntityExtractorMixin to the class inheritance and registering the component as both an INTENT_CLASSIFIER and an ENTITY_EXTRACTOR appropriately extends the LLMClassifier to handle entity extraction alongside intent classification.

@@ -58,6 +58,6 @@ def execute(self, **kwargs):
nlu_result=nlu_results,
event_status=EVENT_STATUS.COMPLETED.value)
except Exception as e:
logger.error(str(e))
logger.exception(str(e))
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Simplify logger.exception Usage

When using logger.exception(), you don't need to pass str(e) as it automatically includes the exception information and stack trace. Consider updating the code as follows:

-    logger.exception(str(e))
+    logger.exception("An error occurred during model testing execution")
📝 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
logger.exception(str(e))
logger.exception("An error occurred during model testing execution")

Copy link
Collaborator

@hiteshghuge hiteshghuge left a comment

Choose a reason for hiding this comment

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

approved

@hiteshghuge hiteshghuge merged commit e31e904 into master Dec 18, 2024
8 checks passed
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.

2 participants