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

intent ranking added #1656

Merged
merged 1 commit into from
Dec 16, 2024
Merged

intent ranking added #1656

merged 1 commit into from
Dec 16, 2024

Conversation

sfahad1414
Copy link
Collaborator

@sfahad1414 sfahad1414 commented Dec 13, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced intent ranking handling to improve clarity during message processing.
  • Bug Fixes

    • Improved error logging for better traceability of issues during predictions.

Copy link

coderabbitai bot commented Dec 13, 2024

Walkthrough

The changes involve modifications to the LLMClassifier class in the kairon/nlu/classifiers/llm.py file. The process method now initializes the intent_ranking variable with a copy of the intent dictionary instead of an empty list when the classifier is untrained or lacks data. Additionally, the predict method's error handling has been improved to log exceptions more effectively, capturing error messages during prediction. These updates enhance intent tracking and error traceability in the classifier's operations.

Changes

File Change Summary
kairon/nlu/classifiers/llm.py Modified process method to initialize intent_ranking with a copy of the intent dictionary. Improved error logging in the predict method to capture error messages.

Poem

In the meadow where intentions bloom,
A classifier finds its room.
With rankings clear and errors logged,
The paths of thought no longer fogged.
Hooray for changes, bright and new,
A hop, a skip, for all to view! 🐇✨


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. (Experiment)
  • @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

🧹 Outside diff range and nitpick comments (3)
kairon/nlu/classifiers/llm.py (3)

Line range hint 182-187: Enhance error handling in predict method

The current error handling is too broad and lacks context. Consider:

  1. Adding specific exception handling
  2. Including request context in error logs
  3. Implementing proper fallback behavior

Example implementation:

-        except Exception as e:
-            logger.error(e)
+        except json.JSONDecodeError as e:
+            logger.error(f"Failed to parse LLM response for text '{text}': {str(e)}")
+        except litellm.exceptions.OpenAIError as e:
+            logger.error(f"LLM API error for text '{text}': {str(e)}")
+        except Exception as e:
+            logger.error(f"Unexpected error processing text '{text}': {str(e)}", exc_info=True)

Line range hint 173-174: Security: Remove sensitive data from debug logs

The debug logging of the complete API response could expose sensitive information.

Consider sanitizing the logged response:

-            logger.debug(response)
+            logger.debug(f"Received response for text length: {len(text)}, status: {response.choices[0]['finish_reason']}")

Line range hint 134-159: Optimize context preparation performance

The context preparation could be more efficient by:

  1. Pre-formatting static parts of the message
  2. Using list comprehension for entity extraction
  3. Reducing redundant set operations

Consider this optimization:

-                entities = set([entity[ENTITY_ATTRIBUTE_TYPE] for entity in entities])
+                entities.update(entity[ENTITY_ATTRIBUTE_TYPE] for entity in self.data[i].get(ENTITIES, []))
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e7ae941 and 30b27ea.

📒 Files selected for processing (1)
  • kairon/nlu/classifiers/llm.py (1 hunks)

@@ -213,7 +213,7 @@ def process(self, messages: List[Message]) -> List[Message]:
else:
label, reason, entities = self.predict(message.get(TEXT))
intent = {"name": label, "confidence": 1, "reason": reason}
intent_ranking = []
intent_ranking = [intent.copy()]
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider implementing proper confidence scoring for intent ranking

While copying the intent is better than an empty list, the current implementation doesn't provide true intent ranking as it:

  1. Always sets confidence to 1
  2. Only includes a single intent in the ranking

Consider implementing proper confidence scoring and multiple intents in the ranking. Example approach:

def process(self, messages: List[Message]) -> List[Message]:
    for message in messages:
        if not self.vector and not self.data:
            intent = None
            intent_ranking = []
            entities = []
        else:
            label, reason, entities = self.predict(message.get(TEXT))
            # Get top N intents with confidence scores
            intent = {"name": label, "confidence": self._calculate_confidence(label), "reason": reason}
            intent_ranking = self._get_intent_ranking(label)  # Return top N intents with scores
            entities = self.add_extractor_name(entities)

@hiteshghuge hiteshghuge merged commit c14f537 into master Dec 16, 2024
8 checks passed
@sfahad1414 sfahad1414 deleted the llm_intent_ranking branch December 17, 2024 06:02
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