+
### March 24, 2024
PR-Agent is now available for easy installation via [pip](https://pr-agent-docs.codium.ai/installation/locally/#using-pip-package).
diff --git a/docs/docs/tools/ask.md b/docs/docs/tools/ask.md
index 453807fd..79c4f00f 100644
--- a/docs/docs/tools/ask.md
+++ b/docs/docs/tools/ask.md
@@ -7,9 +7,9 @@ It can be invoked manually by commenting on any PR:
```
For example:
-{width=768}
+{width=512}
-{width=768}
+{width=512}
## Ask lines
@@ -18,6 +18,35 @@ You can run `/ask` on specific lines of code in the PR from the PR's diff view.
- To select multiple lines, click on the '+' sign of the first line and then hold and drag to select the rest of the lines.
- write `/ask "..."` in the comment box and press `Add single comment` button.
-{width=768}
+{width=512}
Note that the tool does not have "memory" of previous questions, and answers each question independently.
+
+## Ask on images (using the PR code as context)
+
+You can also ask questions about images that appear in the comment, where the entire PR is considered as the context. The tool will answer questions based on the images in the PR.
+The basic syntax is:
+```
+/ask "..."
+
+[Image](https://real_link_to_image)
+```
+
+Note that GitHub has a mecahnism of pasting images in comments. However, pasted image does not provide a direct link.
+To get a direct link to the image, we recommend using the following steps:
+1) send a comment that contains only the image:
+
+{width=512}
+
+2) quote reply to that comment:
+
+{width=512}
+
+3) type the question below the image:
+
+{width=512}
+{width=512}
+
+4) post the comment, and receive the answer:
+
+{width=512}
\ No newline at end of file
diff --git a/pr_agent/algo/ai_handlers/base_ai_handler.py b/pr_agent/algo/ai_handlers/base_ai_handler.py
index c8473fb3..b5166b8e 100644
--- a/pr_agent/algo/ai_handlers/base_ai_handler.py
+++ b/pr_agent/algo/ai_handlers/base_ai_handler.py
@@ -15,7 +15,7 @@ class BaseAiHandler(ABC):
pass
@abstractmethod
- async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+ async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
"""
This method should be implemented to return a chat completion from the AI model.
Args:
diff --git a/pr_agent/algo/ai_handlers/litellm_ai_handler.py b/pr_agent/algo/ai_handlers/litellm_ai_handler.py
index d07542f6..4acd55ea 100644
--- a/pr_agent/algo/ai_handlers/litellm_ai_handler.py
+++ b/pr_agent/algo/ai_handlers/litellm_ai_handler.py
@@ -1,5 +1,5 @@
import os
-
+import requests
import boto3
import litellm
import openai
@@ -102,13 +102,27 @@ class LiteLLMAIHandler(BaseAiHandler):
retry=retry_if_exception_type((openai.APIError, openai.APIConnectionError, openai.Timeout)), # No retry on RateLimitError
stop=stop_after_attempt(OPENAI_RETRIES)
)
- async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+ async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2, img_path: str = None):
try:
resp, finish_reason = None, None
deployment_id = self.deployment_id
if self.azure:
model = 'azure/' + model
messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
+ if img_path:
+ try:
+ # check if the image link is alive
+ r = requests.head(img_path, allow_redirects=True)
+ if r.status_code == 404:
+ error_msg = f"The image link is not [alive](img_path).\nPlease repost the original image as a comment, and send the question again with 'quote reply' (see [instructions](https://pr-agent-docs.codium.ai/tools/ask/#ask-on-images-using-the-pr-code-as-context))."
+ get_logger().error(error_msg)
+ return f"{error_msg}", "error"
+ except Exception as e:
+ get_logger().error(f"Error fetching image: {img_path}", e)
+ return f"Error fetching image: {img_path}", "error"
+ messages[1]["content"] = [{"type": "text", "text": messages[1]["content"]},
+ {"type": "image_url", "image_url": {"url": img_path}}]
+
kwargs = {
"model": model,
"deployment_id": deployment_id,
diff --git a/pr_agent/servers/github_app.py b/pr_agent/servers/github_app.py
index bc7042b1..f0d1340d 100644
--- a/pr_agent/servers/github_app.py
+++ b/pr_agent/servers/github_app.py
@@ -86,8 +86,13 @@ async def handle_comments_on_pr(body: Dict[str, Any],
return {}
comment_body = body.get("comment", {}).get("body")
if comment_body and isinstance(comment_body, str) and not comment_body.lstrip().startswith("/"):
- get_logger().info("Ignoring comment not starting with /")
- return {}
+ if '/ask' in comment_body and comment_body.strip().startswith('> ![image]'):
+ comment_body_split = comment_body.split('/ask')
+ comment_body = '/ask' + comment_body_split[1] +' \n' +comment_body_split[0].strip().lstrip('>')
+ get_logger().info(f"Reformatting comment_body so command is at the beginning: {comment_body}")
+ else:
+ get_logger().info("Ignoring comment not starting with /")
+ return {}
disable_eyes = False
if "issue" in body and "pull_request" in body["issue"] and "url" in body["issue"]["pull_request"]:
api_url = body["issue"]["pull_request"]["url"]
diff --git a/pr_agent/servers/help.py b/pr_agent/servers/help.py
index 9e85887d..d76f70a4 100644
--- a/pr_agent/servers/help.py
+++ b/pr_agent/servers/help.py
@@ -160,16 +160,17 @@ It can be invoked manually by commenting on any PR:
/ask "..."
```
-Note that the tool does not have "memory" of previous questions, and answers each question independently.
+Note that the tool does not have "memory" of previous questions, and answers each question independently.
+You can ask questions about the entire PR, about specific code lines, or about an image related to the PR code changes.
"""
- output += "\n\nMore PR-Agent commands\n\n" - output += HelpMessage.get_general_bot_help_text() - output += "\n\n |
More PR-Agent commands\n\n" + # # output += HelpMessage.get_general_bot_help_text() + # # output += "\n\n |