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

Llm bot id classifier corrected #1646

Closed
wants to merge 2 commits into from
Closed

Conversation

sfahad1414
Copy link
Collaborator

@sfahad1414 sfahad1414 commented Dec 12, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced API key management for improved clarity and security.
    • Updated training functions to better handle bot configuration and training status.
  • Bug Fixes

    • Improved error handling during the training process to ensure consistent status updates.

Copy link

coderabbitai bot commented Dec 12, 2024

Walkthrough

The changes in this pull request involve modifications to the LLMClassifier class in kairon/nlu/classifiers/llm.py, specifically focusing on how API keys are managed. The load_api_key method has been updated to utilize a secret attribute stored in a dictionary format. This impacts the get_embeddings and predict methods, which now reference the secret attribute. Additionally, the train.py file has been updated to incorporate the bot_id into the configuration for the LLMClassifier and to enhance exception handling in the start_training function.

Changes

File Path Change Summary
kairon/nlu/classifiers/llm.py Updated LLMClassifier methods to use a secret attribute for API key management instead of api_key.
Adjusted predict method to unpack secret dictionary for API calls.
Enhanced error handling in the predict method.
kairon/train.py Modified train_model_for_bot to update bot_id in the configuration for LLMClassifier.
Added a finally block in start_training to ensure training status updates regardless of exceptions.

Possibly related PRs

  • added secret and bot_id in config #1644: This PR directly modifies the LLMClassifier class in kairon/nlu/classifiers/llm.py, specifically updating the handling of API keys to use a secret attribute, which aligns with the changes made in the main PR regarding the same class and methods.

Suggested reviewers

  • hiteshghuge

Poem

In the code where secrets dwell,
A rabbit hops, and all is well.
Keys now tucked in a cozy nest,
Training bots, we do our best!
With each change, we leap and bound,
In the world of code, joy is found! 🐇✨


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.

@sfahad1414 sfahad1414 closed this Dec 12, 2024
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: 4

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

90-90: Remove unnecessary f-string prefix

The error message doesn't contain any placeholders.

-            raise KeyError(
-                f"either set bot_id'in LLMClassifier config or set LLM_API_KEY in environment variables"
-            )
+            raise KeyError(
+                "either set bot_id in LLMClassifier config or set LLM_API_KEY in environment variables"
+            )
🧰 Tools
🪛 Ruff (0.8.2)

90-90: f-string without any placeholders

Remove extraneous f prefix

(F541)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 521990a and 7daa2f9.

📒 Files selected for processing (2)
  • kairon/nlu/classifiers/llm.py (2 hunks)
  • kairon/train.py (2 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
kairon/nlu/classifiers/llm.py

90-90: f-string without any placeholders

Remove extraneous f prefix

(F541)

Comment on lines +42 to +44
index = next((index for (index, d) in enumerate(config['pipeline']) if d["name"] == "kairon.nlu.LLMClassifier"), None)
if index:
config['pipeline'][index]['bot_id']= bot
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 error handling for LLMClassifier configuration

While the logic is correct, consider adding error handling to make the code more robust:

-        index = next((index for (index, d) in enumerate(config['pipeline']) if d["name"] == "kairon.nlu.LLMClassifier"), None)
-        if index:
-            config['pipeline'][index]['bot_id']= bot
+        if not config.get('pipeline'):
+            raise ValueError("Pipeline configuration is missing")
+        
+        index = next((index for (index, d) in enumerate(config['pipeline']) if d["name"] == "kairon.nlu.LLMClassifier"), None)
+        if index is not None:
+            config['pipeline'][index]['bot_id'] = bot
+        else:
+            logging.debug("LLMClassifier not found in pipeline configuration")
📝 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
index = next((index for (index, d) in enumerate(config['pipeline']) if d["name"] == "kairon.nlu.LLMClassifier"), None)
if index:
config['pipeline'][index]['bot_id']= bot
if not config.get('pipeline'):
raise ValueError("Pipeline configuration is missing")
index = next((index for (index, d) in enumerate(config['pipeline']) if d["name"] == "kairon.nlu.LLMClassifier"), None)
if index is not None:
config['pipeline'][index]['bot_id'] = bot
else:
logging.debug("LLMClassifier not found in pipeline configuration")

Comment on lines +95 to 96
model="text-embedding-3-small", input=text, max_retries=3, **self.secret
)
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Use configuration for embedding model

The embedding model name is hardcoded despite being available in the component configuration.

         embeddings = litellm.embedding(
-            model="text-embedding-3-small", input=text, max_retries=3, **self.secret
+            model=self.component_config.get("embedding_model", "text-embedding-3-small"),
+            input=text,
+            max_retries=self.component_config.get("retry", 3),
+            **self.secret
         )
📝 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
model="text-embedding-3-small", input=text, max_retries=3, **self.secret
)
model=self.component_config.get("embedding_model", "text-embedding-3-small"),
input=text,
max_retries=self.component_config.get("retry", 3),
**self.secret
)

Comment on lines +191 to +192
max_retries=3,
**self.secret
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve error handling in predict method

The error handling could be more specific and informative.

             max_retries=3,
             **self.secret
         )
         logger.debug(response)
         responses = json.loads(response.choices[0]["message"]["content"])
         intent = responses["intent"] if "intent" in responses.keys() else "nlu_fallback"
         explanation = responses["explanation"] if "explanation" in responses.keys() else None
         entities = responses["entities"]if "entities" in responses.keys() else []
-    except Exception as e:
-        logger.error(e)
+    except json.JSONDecodeError as e:
+        logger.error(f"Failed to parse LLM response: {e}")
+    except (KeyError, IndexError) as e:
+        logger.error(f"Unexpected response format from LLM: {e}")
+    except Exception as e:
+        logger.error(f"Error during prediction: {str(e)}")

Committable suggestion skipped: line range outside the PR's diff.

Comment on lines +85 to +87
self.secret = llm_secret.get('api_key')
elif os.environ.get("LLM_API_KEY"):
self.api_key = os.environ.get("LLM_API_KEY")
self.secret = {'api_key': os.environ.get("LLM_API_KEY")}
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 validation for API key and type hints

The API key handling could be more robust with proper validation and type hints.

+    secret: Dict[str, str]
+
     def load_api_key(self, bot_id: Text):
         if bot_id:
             from kairon.shared.admin.processor import Sysadmin
             llm_secret = Sysadmin.get_llm_secret("openai", bot_id)
-            self.secret = llm_secret.get('api_key')
+            api_key = llm_secret.get('api_key')
+            if not api_key:
+                raise ValueError("API key not found in llm_secret")
+            self.secret = {'api_key': api_key}
         elif os.environ.get("LLM_API_KEY"):
             self.secret = {'api_key': os.environ.get("LLM_API_KEY")}
         else:
             raise KeyError(
                 "either set bot_id in LLMClassifier config or set LLM_API_KEY in environment variables"
             )
📝 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.secret = llm_secret.get('api_key')
elif os.environ.get("LLM_API_KEY"):
self.api_key = os.environ.get("LLM_API_KEY")
self.secret = {'api_key': os.environ.get("LLM_API_KEY")}
secret: Dict[str, str]
def load_api_key(self, bot_id: Text):
if bot_id:
from kairon.shared.admin.processor import Sysadmin
llm_secret = Sysadmin.get_llm_secret("openai", bot_id)
api_key = llm_secret.get('api_key')
if not api_key:
raise ValueError("API key not found in llm_secret")
self.secret = {'api_key': api_key}
elif os.environ.get("LLM_API_KEY"):
self.secret = {'api_key': os.environ.get("LLM_API_KEY")}
else:
raise KeyError(
"either set bot_id in LLMClassifier config or set LLM_API_KEY in environment variables"
)

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.

1 participant