feat: Implement methods in AzureDevopsProvider for publishing code suggestions, labels, and removing comments

docs: Enhance 'improve' tool documentation and update 'DESCRIBE.md' w…

.github/workflows/pr-agent-review.yaml

@@ -5,8 +5,9 @@
 name: PR-Agent
 
 on:
-  pull_request:
-  issue_comment:
+# pull_request:
+# issue_comment:
+  workflow_dispatch:
 
 permissions:
   issues: write

INSTALL.md

@@ -46,7 +46,7 @@ docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GI
 
 Note: If you have a dedicated GitLab instance, you need to specify the custom url as variable:
 ```
-docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> GITLAB.URL=<your gitlab instance url> codiumai/pr-agent:latest --pr_url <pr_url> review
+docker run --rm -it -e OPENAI.KEY=<your key> -e CONFIG.GIT_PROVIDER=gitlab -e GITLAB.PERSONAL_ACCESS_TOKEN=<your token> -e GITLAB.URL=<your gitlab instance url> codiumai/pr-agent:latest --pr_url <pr_url> review
 ```
 
 - For BitBucket:

README.md

@@ -21,7 +21,7 @@ Making pull requests less painful with an AI agent
 </div>
 <div style="text-align:left;">
 
-CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull requests faster and more efficiently. It automatically analyzes the pull request and can provide several types of commands:
+CodiumAI PR-Agent is an open-source tool to help efficiently review and handle pull requests. It automatically analyzes the pull request and can provide several types of commands:
 
 ‣ **Auto Description ([`/describe`](./docs/DESCRIBE.md))**: Automatically generating PR description - title, type, summary, code walkthrough and labels.
 \
@@ -33,31 +33,54 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull
 \
 ‣ **Update Changelog ([`/update_changelog`](./docs/UPDATE_CHANGELOG.md))**: Automatically updating the CHANGELOG.md file with the PR changes.
 \
-‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues
+‣ **Find Similar Issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues.
 \
-‣ **Add Documentation ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Automatically adds documentation to un-documented functions/classes in the PR.
+‣ **Add Documentation 💎  ([`/add_docs`](./docs/ADD_DOCUMENTATION.md))**: Automatically adds documentation to methods/functions/classes that changed in the PR.
 \
-‣ **Generate Custom Labels ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
+‣ **Generate Custom Labels 💎 ([`/generate_labels`](./docs/GENERATE_CUSTOM_LABELS.md))**: Automatically suggests custom labels based on the PR code changes.
+\
+‣ **Analyze 💎 ([`/analyze`](./docs/Analyze.md))**: Automatically analyzes the PR, and presents changes walkthrough for each component.
 
-See the [Installation Guide](./INSTALL.md) for instructions how to install and run the tool on different platforms.
 
-See the [Usage Guide](./Usage.md) for instructions how to run the different tools from _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
+See the [Installation Guide](./INSTALL.md) for instructions on installing and running the tool on different git platforms.
 
-See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the different tools.
+See the [Usage Guide](./Usage.md) for running the PR-Agent commands via different interfaces, including _CLI_, _online usage_, or by _automatically triggering_ them when a new PR is opened.
 
-<h3>Example results:</h3>
+See the [Tools Guide](./docs/TOOLS_GUIDE.md) for a detailed description of the different tools (tools are run via the commands).
+
+## Table of Contents
+- [Example results](#example-results)
+- [Features overview](#features-overview)
+- [Try it now](#try-it-now)
+- [Installation](#installation)
+- [PR-Agent Pro 💎](#pr-agent-pro-)
+- [How it works](#how-it-works)
+- [Why use PR-Agent?](#why-use-pr-agent)
+
+## Example results
 </div>
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1687561986">/describe:</a></h4>
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/describe</a></h4>
 <div align="center">
 <p float="center">
-<img src="https://www.codium.ai/images/describe-2.gif" width="800">
+<img src="https://www.codium.ai/images/pr_agent/describe_short_main.png" width="800">
 </p>
 </div>
+<hr>
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/472#discussion_r1435819374">/improve</a></h4>
 
-<h4><a href="https://github.com/Codium-ai/pr-agent/pull/229#issuecomment-1695021901">/review:</a></h4>
 <div align="center">
 <p float="center">
-<img src="https://www.codium.ai/images/review-2.gif" width="800">
+<kbd>
+<img src="https://www.codium.ai/images/pr_agent/improve_short_main.png" width="768">
+</kbd>
+</p>
+
+</div>
+<hr>
+<h4><a href="https://github.com/Codium-ai/pr-agent/pull/530">/generate_labels</a></h4>
+<div align="center">
+<p float="center">
+<kbd><img src="https://www.codium.ai/images/pr_agent/geneare_custom_labels_main_short.png" width="300"></kbd>
 </p>
 </div>
 
@@ -98,49 +121,48 @@ See the [Tools Guide](./docs/TOOLS_GUIDE.md) for detailed description of the dif
 [//]: # (</div>)
 <div align="left">
 
-## Table of Contents
-- [Overview](#overview)
-- [Try it now](#try-it-now)
-- [Installation](#installation)
-- [How it works](#how-it-works)
-- [Why use PR-Agent?](#why-use-pr-agent)
-- [Roadmap](#roadmap)
+
 </div>
+<hr>
 
-
-## Overview
+## Features overview
 `PR-Agent` offers extensive pull request functionalities across various git providers:
-|       |                                             | GitHub | Gitlab | Bitbucket | CodeCommit | Azure DevOps | Gerrit |
-|-------|---------------------------------------------|:------:|:------:|:---------:|:----------:|:----------:|:----------:|
-| TOOLS | Review                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:    |
-|       | ⮑ Incremental                              |   :white_check_mark:    |       |           |       |          |     |
-|       | Ask                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:          |   :white_check_mark:          | :white_check_mark: |  :white_check_mark:    |
-|       | Auto-Description                            |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |   :white_check_mark:    | :white_check_mark:    |
-|       | Improve Code                                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
-|       | ⮑ Extended                             |   :white_check_mark:    |   :white_check_mark:    |        :white_check_mark:   |   :white_check_mark:    |          | :white_check_mark:    |
-|       | Reflect and Review                          |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |          |   :white_check_mark:    |    :white_check_mark:    |
-|       | Update CHANGELOG.md                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |       |
-|       | Find similar issue                          |   :white_check_mark:    |                         |                             |          |          |       |
-|       | Add Documentation                           |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
-|       | Generate Labels                           |   :white_check_mark:    |   :white_check_mark:    |         |     |          |      |
-|       |                                             |        |        |      |      |      |
-| USAGE | CLI                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |   :white_check_mark:    |   :white_check_mark:    |
-|       | App / webhook                               |   :white_check_mark:    |   :white_check_mark:    |           |          |          |
-|       | Tagging bot                                 |   :white_check_mark:    |        |           |          |          |
-|       | Actions                                     |   :white_check_mark:    |        |           |          |          |
-|       | Web server                                  |       |        |           |          |          |  :white_check_mark:   |
-|       |                                             |        |        |      |      |      |
-| CORE  | PR compression                              |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Repo language prioritization                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Adaptive and token-aware<br />file patch fitting |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Multiple models support |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
-|       | Incremental PR Review |   :white_check_mark:    |      |      |      |      |      |
+|       |                                             | GitHub | Gitlab | Bitbucket |
+|-------|---------------------------------------------|:------:|:------:|:---------:|
+| TOOLS | Review                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | ⮑ Incremental                              |   :white_check_mark:    |                         |                            |
+|       | ⮑ [SOC2 Compliance](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-) 💎                       |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Ask                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Describe                                    |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Improve                                     |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | ⮑ Extended                                 |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Reflect and Review                          |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Update CHANGELOG.md                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | Find Similar Issue                          |   :white_check_mark:    |                         |                             |
+|       | [Add PR Documentation](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md) 💎                     |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |
+|       | [Generate Custom Labels](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem) 💎                   |   :white_check_mark:    |   :white_check_mark:    |         |
+|       | [Analyze PR Components](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎                    |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:      |
+|       |                                             |        |        |      |
+| USAGE | CLI                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | App / webhook                               |   :white_check_mark:    |   :white_check_mark:    |           |
+|       | Tagging bot                                 |   :white_check_mark:    |        |           | 
+|       | Actions                                     |   :white_check_mark:    |        |           | 
+|       |                                             |        |        |      |
+| CORE  | PR compression                              |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | Repo language prioritization                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |
+|       | Adaptive and token-aware<br />file patch fitting |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:     |
+|       | Multiple models support |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |
+|       | Incremental PR review |   :white_check_mark:    |      |      |
+|       | [Static code analysis](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md) 💎 |   :white_check_mark:    |   :white_check_mark:     |    :white_check_mark:    |
+|       | [Global configuration](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-) 💎 |   :white_check_mark:    |   :white_check_mark:     |    :white_check_mark:    |
 
-Review the [usage guide](./Usage.md) section for detailed instructions how to use the different tools, select the relevant git provider (GitHub, Gitlab, Bitbucket,...), and adjust the configuration file to your needs.
+
+- 💎 means this feature is available only in [PR-Agent Pro](https://www.codium.ai/pricing/)
+- Support for additional git providers is described in [here](./docs/Full_enviroments.md) 
 
 ## Try it now
 
-You can try GPT-4 powered PR-Agent, on your public GitHub repository, instantly. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
+Try the GPT-4 powered PR-Agent instantly on _your public GitHub repository_. Just mention `@CodiumAI-Agent` and add the desired command in any PR comment. The agent will generate a response based on your command.
 For example, add a comment to any pull request with the following text:
 ```
 @CodiumAI-Agent /review
@@ -151,12 +173,12 @@ and the agent will respond with a review of your PR
 
 
 To set up your own PR-Agent, see the [Installation](#installation) section below.
+Note that when you set your own PR-Agent or use CodiumAI hosted PR-Agent, there is no need to mention `@CodiumAI-Agent ...`. Instead, directly start with the command, e.g., `/ask ...`.
 
 ---
 
 ## Installation
-
-To get started with PR-Agent quickly, you first need to acquire two tokens:
+To use your own version of PR-Agent, you first need to acquire two tokens:
 
 1. An OpenAI key from [here](https://platform.openai.com/), with access to GPT-4.
 2. A GitHub personal access token (classic) with the repo scope.
@@ -175,6 +197,21 @@ There are several ways to use PR-Agent:
 - [Method 8: Run a GitLab webhook server](INSTALL.md#method-8---run-a-gitlab-webhook-server)
 - [Method 9: Run as a Bitbucket Pipeline](INSTALL.md#method-9-run-as-a-bitbucket-pipeline)
 
+## PR-Agent Pro 💎
+[PR-Agent Pro](https://www.codium.ai/pricing/) is a hosted version of PR-Agent, provided by CodiumAI. It is available for a monthly fee, and provides the following benefits:
+1. **Fully managed** - We take care of everything for you - hosting, models, regular updates, and more. Installation is as simple as signing up and adding the PR-Agent app to your GitHub\BitBucket repo.
+2. **Improved privacy** - No data will be stored or used to train models. PR-Agent Pro will employ zero data retention, and will use an OpenAI account with zero data retention.
+3. **Improved support** - PR-Agent Pro users will receive priority support, and will be able to request new features and capabilities.
+4. **Extra features** -In addition to the benefits listed above, PR-Agent Pro will emphasize more customization, and the usage of static code analysis, in addition to LLM logic, to improve results. It has the following additional features:
+    - [**SOC2 compliance check**](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#soc2-ticket-compliance-)
+    - [**PR documentation**](https://github.com/Codium-ai/pr-agent/blob/main/docs/ADD_DOCUMENTATION.md)
+    - [**Custom labels**](https://github.com/Codium-ai/pr-agent/blob/main/docs/DESCRIBE.md#handle-custom-labels-from-the-repos-labels-page-gem)
+    - [**Global configuration**](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#global-configuration-file-)
+    - [**Analyze PR components**](https://github.com/Codium-ai/pr-agent/blob/main/docs/Analyze.md)
+    - **Custom Code Suggestions** [WIP]
+    - **Chat on Specific Code Lines** [WIP]
+
+
 ## How it works
 
 The following diagram illustrates PR-Agent tools and their flow:
@@ -185,50 +222,22 @@ Check out the [PR Compression strategy](./PR_COMPRESSION.md) page for more detai
 
 ## Why use PR-Agent?
 
-A reasonable question that can be asked is: `"Why use PR-Agent? What make it stand out from existing tools?"`
+A reasonable question that can be asked is: `"Why use PR-Agent? What makes it stand out from existing tools?"`
 
 Here are some advantages of PR-Agent:
 
 - We emphasize **real-life practical usage**. Each tool (review, improve, ask, ...) has a single GPT-4 call, no more. We feel that this is critical for realistic team usage - obtaining an answer quickly (~30 seconds) and affordably.
 - Our [PR Compression strategy](./PR_COMPRESSION.md)  is a core ability that enables to effectively tackle both short and long PRs.
 - Our JSON prompting strategy enables to have **modular, customizable tools**. For example, the '/review' tool categories can be controlled via the [configuration](pr_agent/settings/configuration.toml) file. Adding additional categories is easy and accessible.
-- We support **multiple git providers** (GitHub, Gitlab, Bitbucket, CodeCommit), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
-- We are open-source, and welcome contributions from the community.
+- We support **multiple git providers** (GitHub, Gitlab, Bitbucket), **multiple ways** to use the tool (CLI, GitHub Action, GitHub App, Docker, ...), and **multiple models** (GPT-4, GPT-3.5, Anthropic, Cohere, Llama2).
 
 
-## Roadmap
+## Data privacy
 
-- [x] Support additional models, as a replacement for OpenAI (see [here](https://github.com/Codium-ai/pr-agent/pull/172))
-- [x] Develop additional logic for handling large PRs (see [here](https://github.com/Codium-ai/pr-agent/pull/229))
-- [ ] Add additional context to the prompt. For example, repo (or relevant files) summarization, with tools such a [ctags](https://github.com/universal-ctags/ctags)
-- [x] PR-Agent for issues
-- [ ] Adding more tools. Possible directions:
-  - [x] PR description
-  - [x] Inline code suggestions
-  - [x] Reflect and review
-  - [x] Rank the PR (see [here](https://github.com/Codium-ai/pr-agent/pull/89))   
-  - [ ] Enforcing CONTRIBUTING.md guidelines
-  - [ ] Performance (are there any performance issues)
-  - [x] Documentation (is the PR properly documented)
-  - [ ] ...
-
-See the [Release notes](./RELEASE_NOTES.md) for updates on the latest changes.
-
-
-## Similar Projects
-
-- [CodiumAI - Meaningful tests for busy devs](https://github.com/Codium-ai/codiumai-vscode-release) (although various capabilities are much more advanced in the CodiumAI IDE plugins)
-- [Aider - GPT powered coding in your terminal](https://github.com/paul-gauthier/aider)
-- [openai-pr-reviewer](https://github.com/coderabbitai/openai-pr-reviewer)
-- [CodeReview BOT](https://github.com/anc95/ChatGPT-CodeReview)
-- [AI-Maintainer](https://github.com/merwanehamadi/AI-Maintainer)
-
-## Data Privacy
-
-If you use a self-hosted PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
+If you host PR-Agent with your OpenAI API key, it is between you and OpenAI. You can read their API data privacy policy here:
 https://openai.com/enterprise-privacy
 
-When using a PR-Agent app hosted by CodiumAI, we will not store any of your data, nor will we used it for training.
+When using PR-Agent Pro 💎, hosted by CodiumAI, we will not store any of your data, nor will we use it for training.
 You will also benefit from an OpenAI account with zero data retention.
 
 ## Links

Usage.md

@@ -2,14 +2,12 @@
 
 ### Table of Contents
 - [Introduction](#introduction)
-- [Working from a local repo (CLI)](#working-from-a-local-repo-cli)
-- [Online usage](#online-usage)
-- [Working with GitHub App](#working-with-github-app)
-- [Working with GitHub Action](#working-with-github-action)
-- [Working with BitBucket App](#working-with-bitbucket-self-hosted-app)
-- [Changing a model](#changing-a-model)
-- [Working with large PRs](#working-with-large-prs)
-- [Appendix - additional configurations walkthrough](#appendix---additional-configurations-walkthrough)
+- [Local Repo (CLI)](#working-from-a-local-repo-cli)
+- [Online Usage](#online-usage)
+- [GitHub App](#working-with-github-app)
+- [GitHub Action](#working-with-github-action)
+- [BitBucket App](#working-with-bitbucket-self-hosted-app)
+- [Additional Configurations Walkthrough](#appendix---additional-configurations-walkthrough)
 
 ### Introduction
 
@@ -25,10 +23,36 @@ GitHub App and GitHub Action also enable to run PR-Agent specific tool automatic
 
 
 #### The configuration file
-The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the **[configuration file](pr_agent/settings/configuration.toml)**.
+- The different tools and sub-tools used by CodiumAI PR-Agent are adjustable via the **[configuration file](pr_agent/settings/configuration.toml)**.
 In addition to general configuration options, each tool has its own configurations. For example, the `review` tool will use parameters from the [pr_reviewer](/pr_agent/settings/configuration.toml#L16) section in the configuration file.
 
-The [Tools Guide](./docs/TOOLS_GUIDE.md) provides a detailed description of the different tools and their configurations.
+- The [Tools Guide](./docs/TOOLS_GUIDE.md) provides a detailed description of the different tools and their configurations.
+
+
+- By uploading a local `.pr_agent.toml` file to the root of the repo's main branch, you can edit and customize any configuration parameter. Note that you need to upload `.pr_agent.toml` prior to creating a PR, in order for the configuration to take effect.
+
+For example, if you set in `.pr_agent.toml`:
+
+```
+[pr_reviewer]
+extra_instructions="""\
+- instruction a
+- instruction b
+...
+"""
+```
+
+Then you can give a list of extra instructions to the `review` tool.
+
+
+#### Global configuration file 💎
+
+If you create a repo called `pr-agent-settings` in your **organization**, it's configuration file `.pr_agent.toml` will be used as a global configuration file for any other repo that belongs to the same organization.
+Parameters from a local `.pr_agent.toml` file, in a specific repo, will override the global configuration parameters.
+
+For example, in the GitHub organization `Codium-ai`:
+- The repo [`https://github.com/Codium-ai/pr-agent-settings`](https://github.com/Codium-ai/pr-agent-settings/blob/main/.pr_agent.toml) contains a `.pr_agent.toml` file that serves as a global configuration file for all the repos in the GitHub organization `Codium-ai`.
+- The repo [`https://github.com/Codium-ai/pr-agent`](https://github.com/Codium-ai/pr-agent/blob/main/.pr_agent.toml) inherits the global configuration file from `pr-agent-settings`.
 
 #### Ignoring files from analysis
 In some cases, you may want to exclude specific files or directories from the analysis performed by CodiumAI PR-Agent. This can be useful, for example, when you have files that are generated automatically or files that shouldn't be reviewed, like vendored code.
@@ -53,18 +77,6 @@ The [git_provider](pr_agent/settings/configuration.toml#L4) field in the configu
 "github", "gitlab", "azure", "codecommit", "local", "gerrit"
 `
 
-[//]: # (** online usage:**)
-
-[//]: # (Options that are available in the configuration file can be specified at run time when calling actions. Two examples:)
-
-[//]: # (```)
-
-[//]: # (- /review --pr_reviewer.extra_instructions="focus on the file: ...")
-
-[//]: # (- /describe --pr_description.add_original_user_description=false -pr_description.extra_instructions="make sure to mention: ...")
-
-[//]: # (```)
-
 ### Working from a local repo (CLI)
 When running from your local repo (CLI), your local configuration file will be used.
 Examples of invoking the different tools via the CLI:
@@ -131,7 +143,7 @@ Then you will overwrite the default number of code suggestions to 1.
 
 #### GitHub app automatic tools
 The [github_app](pr_agent/settings/configuration.toml#L76) section defines GitHub app-specific configurations.  
-In this section you can define configurations to control the conditions for which tools will **run automatically**.  
+In this section, you can define configurations to control the conditions for which tools will **run automatically**.  
 
 ##### GitHub app automatic tools for PR actions
 The GitHub app can respond to the following actions on a PR:
@@ -147,11 +159,11 @@ The configuration parameter `pr_commands` defines the list of tools that will be
 handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
 pr_commands = [
     "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/auto_review",
+    "/review",
 ]
 ```
-This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe` and `auto_review` tools.  
-For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
+This means that when a new PR is opened/reopened or marked as ready for review, PR-Agent will run the `describe` and `review` tools.  
+For the `describe` tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.
 
 You can override the default tool parameters by uploading a local configuration file called `.pr_agent.toml` to the root of your repo.
 For example, if your local `.pr_agent.toml` file contains:
@@ -178,12 +190,12 @@ The configuration parameter `push_commands` defines the list of tools that will
 handle_push_trigger = true
 push_commands = [
     "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/auto_review -i --pr_reviewer.remove_previous_review_comment=true",
+    "/review -i --pr_reviewer.remove_previous_review_comment=true",
 ]
 ```
-This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and incremental `auto_review` tools.  
-For the describe tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.  
-For the `auto_review` tool, it will run in incremental mode, and the `remove_previous_review_comment` parameter will be set to true.
+This means that when new code is pushed to the PR, the PR-Agent will run the `describe` and incremental `review` tools.  
+For the `describe` tool, the `add_original_user_description` and `keep_original_user_title` parameters will be set to true.  
+For the `review` tool, it will run in incremental mode, and the `remove_previous_review_comment` parameter will be set to true.
 
 Much like the configurations for `pr_commands`, you can override the default tool parameters by uploading a local configuration file to the root of your repo.
 
@@ -239,13 +251,51 @@ inline_code_comments = true
 
 Each time you invoke a `/review` tool, it will use inline code comments.
 
-### Changing a model
+#### BitBucket Self-Hosted App automatic tools
+You can configure in your local `.pr_agent.toml` file which tools will **run automatically** when a new PR is opened.
+
+Specifically, set the following values:
+```yaml
+[bitbucket_app]
+auto_review = true    # set as config var in .pr_agent.toml
+auto_describe = true  # set as config var in .pr_agent.toml
+auto_improve = true   # set as config var in .pr_agent.toml
+```
+
+`bitbucket_app.auto_review`, `bitbucket_app.auto_describe` and `bitbucket_app.auto_improve` are used to enable/disable automatic tools.
+If not set, the default option is that only the `review` tool will run automatically when a new PR is opened.
+
+Note that due to limitations of the bitbucket platform, the `auto_describe` tool will be able to publish a PR description only as a comment. 
+In addition, some subsections like `PR changes walkthrough` will not appear, since they require the usage of collapsible sections, which are not supported by bitbucket.
+
+### Appendix - additional configurations walkthrough
+
+
+#### Extra instructions
+All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
+```
+/update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..."
+```
+
+#### Working with large PRs
+
+The default mode of CodiumAI is to have a single call per tool, using GPT-4, which has a token limit of 8000 tokens.
+This mode provide a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
+When the PR is above the token limit, it employs a [PR Compression strategy](./PR_COMPRESSION.md).
+
+However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are 2 possible solutions:
+1) [Use a model](#changing-a-model) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
+2) For the `/improve` tool, there is an ['extended' mode](./docs/IMPROVE.md) (`/improve --extended`),
+which divides the PR to chunks, and process each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)
+
+
+#### Changing a model
 
 See [here](pr_agent/algo/__init__.py) for the list of available models.
 To use a different model than the default (GPT-4), you need to edit [configuration file](pr_agent/settings/configuration.toml#L2).
 For models and environments not from OPENAI, you might need to provide additional keys and other parameters. See below for instructions.
 
-#### Azure
+##### Azure
 To use Azure, set in your `.secrets.toml` (working from CLI), or in the GitHub `Settings > Secrets and variables` (working from GitHub App or GitHub Action):
 ```
 api_key = "" # your azure api key
@@ -261,7 +311,7 @@ and set in your configuration file:
 model="" # the OpenAI model you've deployed on Azure (e.g. gpt-3.5-turbo)
 ```
 
-#### Huggingface
+##### Huggingface
 
 **Local**
 You can run Huggingface models locally through either [VLLM](https://docs.litellm.ai/docs/providers/vllm) or [Ollama](https://docs.litellm.ai/docs/providers/ollama)
@@ -310,7 +360,7 @@ api_base = ... # the base url for your huggingface inference endpoint
 ```
 (you can obtain a Llama2 key from [here](https://replicate.com/replicate/llama-2-70b-chat/api))
 
-#### Replicate
+##### Replicate
 
 To use Llama2 model with Replicate, for example, set:
 ```
@@ -324,7 +374,7 @@ key = ...
 
 Also review the [AiHandler](pr_agent/algo/ai_handler.py) file for instruction how to set keys for other models.
 
-#### Vertex AI
+##### Vertex AI
 
 To use Google's Vertex AI platform and its associated models (chat-bison/codechat-bison) set:
 
@@ -342,7 +392,7 @@ Your [application default credentials](https://cloud.google.com/docs/authenticat
 
 If you do want to set explicit credentials then you can use the `GOOGLE_APPLICATION_CREDENTIALS` environment variable set to a path to a json credentials file.
 
-#### Amazon Bedrock
+##### Amazon Bedrock
 
 To use Amazon Bedrock and its foundational models, add the below configuration:
 
@@ -359,25 +409,6 @@ Note that you have to add access to foundational models before using them. Pleas
 
 AWS session is automatically authenticated from your environment, but you can also explicitly set `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables.
 
-### Working with large PRs
-
-The default mode of CodiumAI is to have a single call per tool, using GPT-4, which has a token limit of 8000 tokens.
-This mode provide a very good speed-quality-cost tradeoff, and can handle most PRs successfully.
-When the PR is above the token limit, it employs a [PR Compression strategy](./PR_COMPRESSION.md).
-
-However, for very large PRs, or in case you want to emphasize quality over speed and cost, there are 2 possible solutions:
-1) [Use a model](#changing-a-model) with larger context, like GPT-32K, or claude-100K. This solution will be applicable for all the tools.
-2) For the `/improve` tool, there is an ['extended' mode](./docs/IMPROVE.md) (`/improve --extended`),
-which divides the PR to chunks, and process each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur)
-
-### Appendix - additional configurations walkthrough
-
-
-#### Extra instructions
-All PR-Agent tools have a parameter called `extra_instructions`, that enables to add free-text extra instructions. Example usage:
-```
-/update_changelog --pr_update_changelog.extra_instructions="Make sure to update also the version ..."
-```
 
 #### Patch Extra Lines
 By default, around any change in your PR, git patch provides 3 lines of context above and below the change.

docs/ADD_DOCUMENTATION.md

@@ -1,5 +1,5 @@
-# Add Documentation Tool
-The `add_docs` tool scans the PR code changes, and automatically suggests documentation for the undocumented code components (functions, classes, etc.).
+# Add Documentation Tool 💎
+The `add_docs` tool scans the PR code changes, and automatically suggests documentation for any code components that changed in the PR (functions, classes, etc.).
 
 It can be invoked manually by commenting on any PR:
 ```
@@ -7,9 +7,18 @@ It can be invoked manually by commenting on any PR:
 ```
 For example:
 
-<kbd><img src=https://codium.ai/images/pr_agent/add_docs_comment.png width="768"></kbd>
-<kbd><img src=https://codium.ai/images/pr_agent/add_docs.png width="768"></kbd>
+<kbd><img src=https://codium.ai/images/pr_agent/docs_command.png width="768"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/docs_components.png width="768"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/docs_single_component.png width="768"></kbd>
 
 ### Configuration options
  - `docs_style`: The exact style of the documentation (for python docstring). you can choose between: `google`, `numpy`, `sphinx`, `restructuredtext`, `plain`. Default is `sphinx`.
  - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+
+Notes 
+- Language that are currently fully supported: Python, Java, C++, JavaScript, TypeScript.
+- For languages that are not fully supported, the tool will suggest documentation only for new components in the PR.
+- A previous version of the tool, that offered support only for new components, was deprecated.
+

docs/Analyze.md

@@ -0,0 +1,21 @@
+# Analyze Tool 💎
+The `analyze` tool combines static code analysis with LLM capabilities to provide a comprehensive analysis of the PR code changes.
+
+The tool scans the PR code changes, find the code components (methods, functions, classes) that changed, and summarizes the changes in each component.
+
+It can be invoked manually by commenting on any PR:
+```
+/analyze
+```
+
+An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
+
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_1.png width="768"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_2.png width="768"></kbd>
+___
+<kbd><img src=https://codium.ai/images/pr_agent/analyze_3.png width="768"></kbd>
+
+
+Notes 
+- Language that are currently supported: Python, Java, C++, JavaScript, TypeScript.

docs/DESCRIBE.md

@@ -1,22 +1,34 @@
 # Describe Tool
+## Table of Contents
+- [Overview](#overview)
+  - [Configuration options](#configuration-options)
+  - [Handle custom labels from the Repo's labels page :gem:](#handle-custom-labels-from-the-repos-labels-page-gem)
+  - [Markers template](#markers-template)
+- [Usage Tips](#usage-tips)
+  - [Automation](#automation)
+  - [Custom labels](#custom-labels)
 
-The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, walkthrough and labels.
-It can be invoked manually by commenting on any PR:
+## Overview
+The `describe` tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels.
+
+The tool can be triggered automatically every time a new PR is [opened](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools), or it can be invoked manually by commenting on any PR:
 ```
 /describe
 ```
 For example:
-
+___
 <kbd><img src=https://codium.ai/images/pr_agent/describe_comment.png width="768"></kbd>
-
+___
 <kbd><img src=https://codium.ai/images/pr_agent/describe.png width="768"></kbd>
-
-The `describe` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
+___
   
 ### Configuration options
+To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related to the describe tool (`pr_description` section), use the following template:
+```
+/describe --pr_description.some_config1=... --pr_description.some_config2=...
+```
 
-Under the section 'pr_description', the [configuration file](./../pr_agent/settings/configuration.toml#L28) contains options to customize the 'describe' tool:
-
+**Possible configurations:**
 - `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true.
 
 - `publish_description_as_comment`: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the origianl description. Default is false.
@@ -33,16 +45,36 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti
 
 - `final_update_message`: if set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is true.
 
-- `enable_semantic_files_types`: if set to true, "PR changes walkthrough" section will be generated. Default is true.
+- `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true.
+- `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive".
+  
+
+### Handle custom labels from the Repo's labels page :gem:
+> This feature is available only in PR-Agent Pro 
+
+You can control  the custom labels that will be suggested by the `describe` tool, from the repo's labels page:
+
+* GitHub : go to `https://github.com/{owner}/{repo}/labels` (or click on the "Labels" tab in the issues or PRs page)
+* GitLab : go to `https://gitlab.com/{owner}/{repo}/-/labels` (or click on "Manage" -> "Labels" on the left menu)
+
+Now add/edit the custom labels. they should be formatted as follows:
+* Label name: The name of the custom label.
+* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
+
+The description should be comprehensive and detailed, indicating when to add the desired label. For example:
+<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="880"></kbd>
+
 
 ### Markers template
-
+To enable markers, set `pr_description.use_description_markers=true`.
 markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism.
 
 For example, if the PR original description was:
 ```
 User content...
 
+## PR Type:
+pr_agent:type
 
 ## PR Description:
 pr_agent:summary
@@ -50,13 +82,7 @@ pr_agent:summary
 ## PR Walkthrough:
 pr_agent:walkthrough
 ```
-The marker `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
-
-##### Example:
-```
-        env:
-          pr_description.use_description_markers: 'true'
-```          
+The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough.
 
 <kbd><img src=https://codium.ai/images/pr_agent/describe_markers_before.png width="768"></kbd>
 
@@ -64,7 +90,52 @@ The marker `pr_agent:summary` will be replaced with the PR summary, and `pr_agen
 
 <kbd><img src=https://codium.ai/images/pr_agent/describe_markers_after.png width="768"></kbd>
 
-##### Configuration params:
+**Configuration params:**
 
 - `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false.
 - `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true.
+
+
+## Usage Tips
+1)  [Automation](#automation)
+2) [Custom labels](#custom-labels)
+### Automation
+- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the describe tool is:
+```
+pr_commands = ["/describe --pr_description.add_original_user_description=true" 
+                         "--pr_description.keep_original_user_title=true", ...]
+```
+meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. 
+<br> This default settings aim to strike a good balance between automation and control:
+If you want more automation, just give the PR a title, and the tool will auto-write a full description; If you want more control, you can add a detailed description, and the tool will add the complementary description below it.
+- For maximal automation, you can change the default mode to:
+```
+pr_commands = ["/describe --pr_description.add_original_user_description=false" 
+                         "--pr_description.keep_original_user_title=true", ...]
+```
+so the title will be auto-generated as well.
+- Markers are an alternative way to control the generated description, to give maximal control to the user. If you set:
+```
+pr_commands = ["/describe --pr_description.use_description_markers=true", ...]
+```
+the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following:
+  - `type`: the PR type.
+  - `summary`: the PR summary.
+  - `walkthrough`: the PR walkthrough.
+
+Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
+
+### Custom labels
+The default labels of the describe tool are quite generic, since they are meant to be used in any repo: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`].
+
+If you specify [custom labels](#handle-custom-labels-from-the-repos-labels-page-gem) in the repo's labels page, you can get tailored labels for your use cases.
+Examples for custom labels:
+- `Main topic:performence` -  pr_agent:The main topic of this PR is performance
+- `New endpoint` -  pr_agent:A new endpoint was added in this PR
+- `SQL query` -  pr_agent:A new SQL query was added in this PR
+- `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile
+- ...
+
+The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
+Note that Labels are not mutually exclusive, so you can add multiple label categories.
+<br>Make sure to provide proper title, and detailed and well-phrased description for each label, so the tool will know when to suggest it.

docs/Full_enviroments.md

@@ -0,0 +1,27 @@
+## Overview
+`PR-Agent` offers extensive pull request functionalities across various git providers:
+|       |                                             | GitHub | Gitlab | Bitbucket | CodeCommit | Azure DevOps | Gerrit |
+|-------|---------------------------------------------|:------:|:------:|:---------:|:----------:|:----------:|:----------:|
+| TOOLS | Review                                      |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:    |
+|       | ⮑ Incremental                              |   :white_check_mark:    |       |           |       |          |     |
+|       | Ask                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:          |   :white_check_mark:          | :white_check_mark: |  :white_check_mark:    |
+|       | Auto-Description                            |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |   :white_check_mark:    | :white_check_mark:    |
+|       | Improve Code                                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
+|       | ⮑ Extended                             |   :white_check_mark:    |   :white_check_mark:    |        :white_check_mark:   |   :white_check_mark:    |          | :white_check_mark:    |
+|       | Reflect and Review                          |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |          |   :white_check_mark:    |    :white_check_mark:    |
+|       | Update CHANGELOG.md                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |       |
+|       | Find similar issue                          |   :white_check_mark:    |                         |                             |          |          |       |
+|       | Add Documentation                           |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:        |   :white_check_mark:    |          |    :white_check_mark:    |
+|       | Generate Custom Labels 💎                   |   :white_check_mark:    |   :white_check_mark:    |         |     |          |      |
+|       |                                             |        |        |      |      |      |
+| USAGE | CLI                                         |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       |   :white_check_mark:    |   :white_check_mark:    |
+|       | App / webhook                               |   :white_check_mark:    |   :white_check_mark:    |           |          |          |
+|       | Tagging bot                                 |   :white_check_mark:    |        |           |          |          |
+|       | Actions                                     |   :white_check_mark:    |        |           |          |          |
+|       | Web server                                  |       |        |           |          |          |  :white_check_mark:   |
+|       |                                             |        |        |      |      |      |
+| CORE  | PR compression                              |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
+|       | Repo language prioritization                |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
+|       | Adaptive and token-aware<br />file patch fitting |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
+|       | Multiple models support |   :white_check_mark:    |   :white_check_mark:    |   :white_check_mark:       | :white_check_mark: |   :white_check_mark:       | :white_check_mark:       |
+|       | Incremental PR Review |   :white_check_mark:    |      |      |      |      |      |

docs/GENERATE_CUSTOM_LABELS.md

@@ -1,4 +1,4 @@
-# Generate Custom Labels
+# Generate Custom Labels 💎
 The `generate_labels` tool scans the PR code changes, and given a list of labels and their descriptions, it automatically suggests labels that match the PR code changes.
 
 It can be invoked manually by commenting on any PR:
@@ -14,16 +14,32 @@ If we wish to add detect changes to SQL queries in a given PR, we can add the fo
 When running the `generate_labels` tool on a PR that includes changes in SQL queries, it will automatically suggest the custom label:
 <kbd><img src=https://codium.ai/images/pr_agent/custom_label_published.png width="768"></kbd>
 
+Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `describe` tool.
+
 ### How to enable custom labels
+There are 3 ways to enable custom labels:
 
-Note that in addition to the dedicated tool `generate_labels`, the custom labels will also be used by the `review` and `describe` tools.
+#### 1. CLI (local configuration file)
+When working from CLI, you need to apply the [configuration changes](#configuration-changes) to the [custom_labels file](./../pr_agent/settings/custom_labels.toml):
 
-#### CLI
-To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the [custom_labels file](./../pr_agent/settings/custom_labels.toml):
-
-#### GitHub Action and GitHub App
+#### 2. Repo configuration file
 To enable custom labels, you need to apply the [configuration changes](#configuration-changes) to the local `.pr_agent.toml` file in you repository.
 
+#### 3. Handle custom labels from the Repo's labels page 
+> This feature is available only in PR-Agent Pro 
+* GitHub : `https://github.com/{owner}/{repo}/labels`, or click on the "Labels" tab in the issues or PRs page.
+* GitLab : `https://gitlab.com/{owner}/{repo}/-/labels`, or click on "Manage" -> "Labels" on the left menu.
+
+b. Add/edit the custom labels. It should be formatted as follows:
+* Label name: The name of the custom label.
+* Description: Start the description of with prefix `pr_agent:`, for example: `pr_agent: Description of when AI should suggest this label`.<br>
+The description should be comprehensive and detailed, indicating when to add the desired label.
+<kbd><img src=https://codium.ai/images/pr_agent/add_native_custom_labels.png width="880"></kbd>
+
+c. Now the custom labels will be included in the `generate_labels` tool.
+
+*This feature is supported in GitHub and GitLab.
+
 #### Configuration changes
  - Change `enable_custom_labels` to True: This will turn off the default labels and enable the custom labels provided in the custom_labels.toml file.
  - Add the custom labels. It should be formatted as follows:

docs/IMPROVE.md

@@ -1,57 +1,100 @@
 # Improve Tool
 
+## Table of Contents
+- [Overview](#overview)
+  - [Configuration options](#configuration-options)
+  - [Summarize mode](#summarize-mode)
+- [Usage Tips](#usage-tips)
+    - [Extra instructions](#extra-instructions)
+    - [PR footprint - regular vs summarize mode](#pr-footprint---regular-vs-summarize-mode)
+    - [A note on code suggestions quality](#a-note-on-code-suggestions-quality)
+
+## Overview
 The `improve` tool scans the PR code changes, and automatically generates committable suggestions for improving the PR code.
-It can be invoked manually by commenting on any PR:
+The tool can be triggered automatically every time a new PR is [opened](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools), or it can be invoked manually by commenting on any PR:
 ```
 /improve
 ```
+
 For example:
 
 <kbd><img src=https://codium.ai/images/pr_agent/improve_comment.png width="768"></kbd>
+
+---
+
 <kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>
 
-The `improve` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
+---
 
 An extended mode, which does not involve PR Compression and provides more comprehensive suggestions, can be invoked by commenting on any PR:
 ```
 /improve --extended
 ```
-Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (multiple calls to GPT-4).
+Note that the extended mode divides the PR code changes into chunks, up to the token limits, where each chunk is handled separately (might use multiple calls to GPT-4 for large PRs).
 Hence, the total number of suggestions is proportional to the number of chunks, i.e., the size of the PR.
 
 ### Configuration options
 
-Under the section 'pr_code_suggestions', the [configuration file](./../pr_agent/settings/configuration.toml#L40) contains options to customize the 'improve' tool:
+To edit [configurations](./../pr_agent/settings/configuration.toml#L66) related to the improve tool (`pr_code_suggestions` section), use the following template:
+```
+/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
+```
 
+#### General options
 - `num_code_suggestions`: number of code suggestions provided by the 'improve' tool. Default is 4.
 - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
 - `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false.
+- `include_improved_code`: if set to true, the tool will include an improved code implementation in the suggestion. Default is true.
 
 #### params for '/improve --extended' mode
+- `auto_extended_mode`: enable extended mode automatically (no need for the `--extended` option). Default is false.
 - `num_code_suggestions_per_chunk`: number of code suggestions provided by the 'improve' tool, per chunk. Default is 8.
 - `rank_extended_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is true.
 - `max_number_of_calls`: maximum number of chunks. Default is 5.
 - `final_clip_factor`: factor to remove suggestions with low confidence. Default is 0.9.
 
-#### summarize mode
-- `summarize`: if set to true, the tool will present the code suggestions in a compact way. Default is false.
-
+#### Summarize mode
 In this mode, instead of presenting committable suggestions, the different suggestions will be combined into a single compact comment, with significantly smaller PR footprint.
 
-For example:
+To invoke the summarize mode, use the following command:
+```
+/improve --pr_code_suggestions.summarize=true
+```
 
-`/improve --pr_code_suggestions.summarize=true`
+For example:
 
 <kbd><img src=https://codium.ai/images/pr_agent/improved_summerize_open.png width="768"></kbd>
 
 ___
 
+## Usage Tips
+
+### Extra instructions
+Extra instructions are very important for the `imrpove` tool, since they enable you to guide the model to suggestions that are more relevant to the specific needs of the project.
+
+Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
+
+Examples for extra instructions:
+```
+[pr_code_suggestions] # /improve #
+extra_instructions="""
+Emphasize the following aspects:
+- Does the code logic covers relevant edge cases?
+- Is the code logic clear and easy to understand?
+- Is the code logic efficient?
+...
+"""
+```
+Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
+
+### PR footprint - regular vs summarize mode
+The default mode of the `improve` tool provides committable suggestions. This mode as a high PR footprint, since each suggestion is a separate comment you need to resolve.
+If you prefer something more compact, use the [`summarize`](#summarize-mode) mode, which combines all the suggestions into a single comment.
+
 ### A note on code suggestions quality
 
 - While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
-
 - Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_code_suggestions_prompts.toml#L34). Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
-
 - Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project.
-
 - Best quality will be obtained by using 'improve --extended' mode.
+

docs/REVIEW.md

@@ -1,40 +1,59 @@
 # Review Tool
 
+## Table of Contents
+- [Overview](#overview)
+  - [Configuration options](#configuration-options)
+  - [Incremental Mode](#incremental-mode)
+  - [PR Reflection](#pr-reflection)
+- [Usage Tips](#usage-tips)
+  - [General guidelines](#general-guidelines)
+  - [Code suggestions](#code-suggestions)
+  - [Automation](#automation)
+  - [Auto-labels](#auto-labels)
+  - [Extra instructions](#extra-instructions)
+
+## Overview
 The `review` tool scans the PR code changes, and automatically generates a PR review.
-It can be invoked manually by commenting on any PR:
+The tool can be triggered automatically every time a new PR is [opened](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools), or can be invoked manually by commenting on any PR:
 ```
 /review
 ```
 For example:
-
+___
 <kbd><img src=https://codium.ai/images/pr_agent/review_comment.png width="768"></kbd>
+___
 <kbd><img src=https://codium.ai/images/pr_agent/review.png width="768"></kbd>
-
-The `review` tool can also be triggered automatically every time a new PR is opened. See examples for automatic triggers for [GitHub App](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) and [GitHub Action](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#working-with-github-action)
+___
 
 ### Configuration options
 
-Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review' tool:
+To edit [configurations](./../pr_agent/settings/configuration.toml#L19)  related to the review tool (`pr_reviewer` section), use the following template:
+```
+/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
+```
 
-#### enable\\disable features
+#### General options
+- `num_code_suggestions`: number of code suggestions provided by the 'review' tool. Default is 4.
+- `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.
+- `persistent_comment`: if set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.
+- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
+#### Enable\\disable features
 - `require_focused_review`: if set to true, the tool will add a section - 'is the PR a focused one'. Default is false.
 - `require_score_review`: if set to true, the tool will add a section that scores the PR. Default is false.
 - `require_tests_review`: if set to true, the tool will add a section that checks if the PR contains tests. Default is true.
 - `require_security_review`: if set to true, the tool will add a section that checks if the PR contains security issues. Default is true.
 - `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates thed effort needed to review the PR. Default is true.
-#### general options
-- `num_code_suggestions`: number of code suggestions provided by the 'review' tool. Default is 4.
-- `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.
-- `automatic_review`: if set to false, no automatic reviews will be done. Default is true.
-- `remove_previous_review_comment`: if set to true, the tool will remove the previous review comment before adding a new one. Default is false.
-- `persistent_comment`: if set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true.
-- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
-#### review labels
+#### SOC2 ticket compliance 💎
+This sub-tool checks if the PR description properly contains a ticket to a project management system (e.g., Jira, Asana, Trello, etc.), as required by SOC2 compliance. If not, it will add a label to the PR: "Missing SOC2 ticket".
+- `require_soc2_review`: If set to true, the SOC2 ticket checker sub-tool will be enabled. Default is false.
+- `soc2_ticket_prompt`: The prompt for the SOC2 ticket review. Default is: `Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?`. Edit this field if your compliance requirements are different.
+#### Adding PR labels
 - `enable_review_labels_security`: if set to true, the tool will publish a 'possible security issue' label if it detects a security issue. Default is true.
 - `enable_review_labels_effort`: if set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is false.
-- To enable `custom labels`, apply the configuration changes described [here](./GENERATE_CUSTOM_LABELS.md#configuration-changes) 
-####  Incremental Mode
-For an incremental review, which only considers changes since the last PR-Agent review, this can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again, the following command can be used:
+
+###  Incremental Mode
+Incremental review only considers changes since the last PR-Agent review. This can be useful when working on the PR in an iterative manner, and you want to focus on the changes since the last review instead of reviewing the entire PR again.
+For invoking the incremental mode, the following command can be used:
 ```
 /review -i
 ```
@@ -42,7 +61,7 @@ Note that the incremental mode is only available for GitHub.
 
 <kbd><img src=https://codium.ai/images/pr_agent/incremental_review.png width="768"></kbd>
 
-Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L16) contains options to customize the 'review -i' tool.  
+Under the section 'pr_reviewer', the [configuration file](./../pr_agent/settings/configuration.toml#L19) contains options to customize the 'review -i' tool.  
 These configurations can be used to control the rate at which the incremental review tool will create new review comments when invoked automatically, to prevent making too much noise in the PR.
 - `minimal_commits_for_incremental_review`: Minimal number of commits since the last review that are required to create incremental review.
 If there are less than the specified number of commits since the last review, the tool will not perform any action.
@@ -55,25 +74,75 @@ For example, if `minimal_commits_for_incremental_review=2` and `minimal_minutes_
 When `require_all_thresholds_for_incremental_review=true` the incremental review __will not__ run, because only 1 out of 2 conditions were met (we have enough commits but the last review is too recent),
 but when `require_all_thresholds_for_incremental_review=false` the incremental review __will__ run, because one condition is enough (we have 3 commits which is more than the configured 2).
 Default is false - the tool will run as long as at least once conditions is met.
+- `remove_previous_review_comment`: if set to true, the tool will remove the previous review comment before adding a new one. Default is false.
 
-#### PR Reflection
+### PR Reflection
 By invoking:
 ```
 /reflect_and_review
 ```
-The tool will first ask the author questions about the PR, and will guide the review based on his answers.
+The tool will first ask the author questions about the PR, and will guide the review based on their answers.
 
 <kbd><img src=https://codium.ai/images/pr_agent/reflection_questions.png width="768"></kbd>
+___
 <kbd><img src=https://codium.ai/images/pr_agent/reflection_answers.png width="768"></kbd>
+___
 <kbd><img src=https://codium.ai/images/pr_agent/reflection_insights.png width="768"></kbd>
+___
 
 
-#### A note on code suggestions quality
+## Usage Tips
+1) [General guidelines](#general-guidelines)
+2) [Code suggestions](#code-suggestions)
+3) [Automation](#automation)
+4) [Auto-labels](#auto-labels)
+5) [Extra instructions](#extra-instructions)
 
-- With current level of AI for code (GPT-4), mistakes can happen. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
+### General guidelines
+The `review` tool provides a collection of possible feedbacks about a PR.
+It is recommended to review the [Configuration options](#configuration-options) section, and choose the relevant options for your use case.
 
-- Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_reviewer_prompts.toml#L29). Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
+Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: 
+`require_score_review`, `require_soc2_review`, `enable_review_labels_effort`, and more.
 
-- Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project.
+On the other hand, if you find one of the enabled features to be irrelevant for your use case, disable it. No default configuration can fit all use cases.
+
+### Code suggestions
+The `review` tool provides several type of feedbacks, one of them is code suggestions.
+If you are interested **only** in the code suggestions, it is recommended to use the [`improve`](./IMPROVE.md) feature instead, since it dedicated only to code suggestions, and usually gives better results.
+Use the `review` tool if you want to get a more comprehensive feedback, which includes code suggestions as well.
+
+### Automation
+- When you first install the app, the [default mode](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) for the `review` tool is:
+```
+pr_commands = ["/review", ...]
+```
+meaning the `review` tool will run automatically on every PR, with the default configuration.
+Edit this field to enable/disable the tool, or to change the used configurations
+
+### Auto-labels
+The `review` tool can auto-generate two specific types of labels for a PR:
+- a `possible security issue` label if it detects a [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) (`enable_review_labels_security` flag)
+- a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
+
+Both modes are useful, and we recommended to enable them.
+
+### Extra instructions
+Extra instruction are important.
+The `review` tool can be configured with extra instructions, which can be used to guide the model to feedback tailored to the needs of your project.
+
+Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
+
+Examples for extra instructions:
+```
+[pr_reviewer] # /review #
+extra_instructions="""
+In the code feedback section, emphasize the following:
+- Does the code logic covers relevant edge cases?
+- Is the code logic clear and easy to understand?
+- Is the code logic efficient?
+...
+"""
+```
+Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
 
-- Unlike the 'review' feature, which does a lot of things, the ['improve --extended'](./IMPROVE.md) feature is dedicated only to suggestions, and usually gives better results.

docs/SIMILAR_ISSUE.md

@@ -12,7 +12,15 @@ For example:
 
 Note that to perform retrieval, the `similar_issue` tool indexes all the repo previous issues (once).
 
-To enable usage of the '**similar issue**' tool, you need to set the following keys in `.secrets.toml` (or in the relevant environment variables):
+
+**Select VectorDBs** by changing `pr_similar_issue` parameter in `configuration.toml` file 
+
+2 VectorDBs are available to switch in
+1. LanceDB
+2. Pinecone
+
+To enable usage of the '**similar issue**' tool for Pinecone, you need to set the following keys in `.secrets.toml` (or in the relevant environment variables):
+
 ```
 [pinecone]
 api_key = "..."

docs/TOOLS_GUIDE.md

@@ -7,5 +7,6 @@
 - [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)
 - [ADD DOCUMENTATION](./ADD_DOCUMENTATION.md)
 - [GENERATE CUSTOM LABELS](./GENERATE_CUSTOM_LABELS.md)
+- [Analyze](./Analyze.md)
 
 See the **[installation guide](/INSTALL.md)** for instructions on how to setup PR-Agent.

pr_agent/agent/pr_agent.py

@@ -1,8 +1,13 @@
 import shlex
+from functools import partial
+
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 
 from pr_agent.algo.utils import update_settings_from_args
 from pr_agent.config_loader import get_settings
 from pr_agent.git_providers.utils import apply_repo_settings
+from pr_agent.log import get_logger
 from pr_agent.tools.pr_add_docs import PRAddDocs
 from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
 from pr_agent.tools.pr_config import PRConfig
@@ -38,8 +43,8 @@ command2class = {
 commands = list(command2class.keys())
 
 class PRAgent:
-    def __init__(self):
-        pass
+    def __init__(self, ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
+        self.ai_handler = ai_handler # will be initialized in run_action
 
     async def handle_request(self, pr_url, request, notify=None) -> bool:
         # First, apply repo specific settings if exists
@@ -61,13 +66,14 @@ class PRAgent:
         if action == "answer":
             if notify:
                 notify()
-            await PRReviewer(pr_url, is_answer=True, args=args).run()
+            await PRReviewer(pr_url, is_answer=True, args=args, ai_handler=self.ai_handler).run()
         elif action == "auto_review":
-            await PRReviewer(pr_url, is_auto=True, args=args).run()
+            await PRReviewer(pr_url, is_auto=True, args=args, ai_handler=self.ai_handler).run()
         elif action in command2class:
             if notify:
                 notify()
-            await command2class[action](pr_url, args=args).run()
+                
+            await command2class[action](pr_url, ai_handler=self.ai_handler, args=args).run()
         else:
             return False
         return True

pr_agent/algo/ai_handlers/base_ai_handler.py

@@ -0,0 +1,28 @@
+from abc import ABC, abstractmethod
+
+class BaseAiHandler(ABC):
+    """
+    This class defines the interface for an AI handler to be used by the PR Agents.  
+    """
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @property
+    @abstractmethod
+    def deployment_id(self):
+        pass
+
+    @abstractmethod   
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+        """
+        This method should be implemented to return a chat completion from the AI model.
+        Args:
+            model (str): the name of the model to use for the chat completion
+            system (str): the system message string to use for the chat completion
+            user (str): the user message string to use for the chat completion
+            temperature (float): the temperature to use for the chat completion    
+        """
+        pass
+

pr_agent/algo/ai_handlers/langchain_ai_handler.py

@@ -0,0 +1,67 @@
+try:
+    from langchain.chat_models import ChatOpenAI, AzureChatOpenAI
+    from langchain.schema import SystemMessage, HumanMessage
+except: # we don't enforce langchain as a dependency, so if it's not installed, just move on
+    pass
+
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.config_loader import get_settings
+from pr_agent.log import get_logger
+
+from openai.error import APIError, RateLimitError, Timeout, TryAgain
+from retry import retry
+import functools
+
+OPENAI_RETRIES = 5
+
+class LangChainOpenAIHandler(BaseAiHandler):
+    def __init__(self):
+        # Initialize OpenAIHandler specific attributes here
+        super().__init__()
+        self.azure = get_settings().get("OPENAI.API_TYPE", "").lower() == "azure"
+        try:
+            if self.azure:
+                # using a partial function so we can set the deployment_id later to support fallback_deployments
+                # but still need to access the other settings now so we can raise a proper exception if they're missing
+                self._chat = functools.partial(
+                    lambda **kwargs: AzureChatOpenAI(**kwargs),
+                    openai_api_key=get_settings().openai.key,
+                    openai_api_base=get_settings().openai.api_base,
+                    openai_api_version=get_settings().openai.api_version,
+                )
+            else:
+                self._chat = ChatOpenAI(openai_api_key=get_settings().openai.key)
+        except AttributeError as e:
+            if getattr(e, "name"):
+                raise ValueError(f"OpenAI {e.name} is required") from e
+            else:
+                raise e
+    
+    @property
+    def chat(self):
+        if self.azure:
+            # we must set the deployment_id only here (instead of the __init__ method) to support fallback_deployments
+            return self._chat(deployment_name=self.deployment_id)
+        else:
+            return self._chat
+
+    @property
+    def deployment_id(self):
+        """
+        Returns the deployment ID for the OpenAI API.
+        """
+        return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
+    @retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
+           tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+        try:
+            messages=[SystemMessage(content=system), HumanMessage(content=user)]
+            
+            # get a chat completion from the formatted messages
+            resp = self.chat(messages, model=model, temperature=temperature)
+            finish_reason="completed"
+            return resp.content, finish_reason
+        
+        except (Exception) as e:
+            get_logger().error("Unknown error during OpenAI inference: ", e)
+            raise e

pr_agent/algo/ai_handlers/litellm_ai_handler.py

@@ -6,13 +6,14 @@ import openai
 from litellm import acompletion
 from openai.error import APIError, RateLimitError, Timeout, TryAgain
 from retry import retry
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
 from pr_agent.config_loader import get_settings
 from pr_agent.log import get_logger
 
 OPENAI_RETRIES = 5
 
 
-class AiHandler:
+class LiteLLMAIHandler(BaseAiHandler):
     """
     This class handles interactions with the OpenAI API for chat completions.
     It initializes the API key and other settings from a configuration file,
@@ -100,11 +101,6 @@ class AiHandler:
         """
         try:
             deployment_id = self.deployment_id
-            if get_settings().config.verbosity_level >= 2:
-                get_logger().debug(
-                    f"Generating completion with {model}"
-                    f"{(' from deployment ' + deployment_id) if deployment_id else ''}"
-                )
             if self.azure:
                 model = 'azure/' + model
             messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]

pr_agent/algo/ai_handlers/openai_ai_handler.py

@@ -0,0 +1,67 @@
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+import openai
+from openai.error import APIError, RateLimitError, Timeout, TryAgain
+from retry import retry
+
+from pr_agent.config_loader import get_settings
+from pr_agent.log import get_logger
+
+OPENAI_RETRIES = 5
+
+
+class OpenAIHandler(BaseAiHandler):
+    def __init__(self):
+        # Initialize OpenAIHandler specific attributes here
+        try:
+            super().__init__()
+            openai.api_key = get_settings().openai.key
+            if get_settings().get("OPENAI.ORG", None):
+                openai.organization = get_settings().openai.org
+            if get_settings().get("OPENAI.API_TYPE", None):
+                if get_settings().openai.api_type == "azure":
+                    self.azure = True
+                    openai.azure_key = get_settings().openai.key
+            if get_settings().get("OPENAI.API_VERSION", None):
+                openai.api_version = get_settings().openai.api_version
+            if get_settings().get("OPENAI.API_BASE", None):
+                openai.api_base = get_settings().openai.api_base
+
+        except AttributeError as e:
+            raise ValueError("OpenAI key is required") from e
+    @property
+    def deployment_id(self):
+        """
+        Returns the deployment ID for the OpenAI API.
+        """
+        return get_settings().get("OPENAI.DEPLOYMENT_ID", None)
+    
+    @retry(exceptions=(APIError, Timeout, TryAgain, AttributeError, RateLimitError),
+           tries=OPENAI_RETRIES, delay=2, backoff=2, jitter=(1, 3))
+    async def chat_completion(self, model: str, system: str, user: str, temperature: float = 0.2):
+        try:
+            deployment_id = self.deployment_id
+            get_logger().info("System: ", system)
+            get_logger().info("User: ", user)
+            messages = [{"role": "system", "content": system}, {"role": "user", "content": user}]
+
+            chat_completion = await openai.ChatCompletion.acreate(
+                model=model,
+                deployment_id=deployment_id,
+                messages=messages,
+                temperature=temperature,
+            )
+            resp = chat_completion["choices"][0]['message']['content']
+            finish_reason = chat_completion["choices"][0]["finish_reason"]
+            usage = chat_completion.get("usage")
+            get_logger().info("AI response", response=resp, messages=messages, finish_reason=finish_reason,
+                            model=model, usage=usage)
+            return resp, finish_reason       
+        except (APIError, Timeout, TryAgain) as e:
+            get_logger().error("Error during OpenAI inference: ", e)
+            raise
+        except (RateLimitError) as e:
+            get_logger().error("Rate limit error during OpenAI inference: ", e)
+            raise
+        except (Exception) as e:
+            get_logger().error("Unknown error during OpenAI inference: ", e)
+            raise TryAgain from e        

pr_agent/algo/pr_processing.py

@@ -226,6 +226,11 @@ async def retry_with_fallback_models(f: Callable):
     # try each (model, deployment_id) pair until one is successful, otherwise raise exception
     for i, (model, deployment_id) in enumerate(zip(all_models, all_deployments)):
         try:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().debug(
+                    f"Generating prediction with {model}"
+                    f"{(' from deployment ' + deployment_id) if deployment_id else ''}"
+                )
             get_settings().set("openai.deployment_id", deployment_id)
             return await f(model)
         except Exception as e:
@@ -264,19 +269,10 @@ def _get_all_deployments(all_models: List[str]) -> List[str]:
 
 def find_line_number_of_relevant_line_in_file(diff_files: List[FilePatchInfo],
                                               relevant_file: str,
-                                              relevant_line_in_file: str) -> Tuple[int, int]:
-    """
-    Find the line number and absolute position of a relevant line in a file.
-
-    Args:
-        diff_files (List[FilePatchInfo]): A list of FilePatchInfo objects representing the patches of files.
-        relevant_file (str): The name of the file where the relevant line is located.
-        relevant_line_in_file (str): The content of the relevant line.
-
-    Returns:
-        Tuple[int, int]: A tuple containing the line number and absolute position of the relevant line in the file.
-    """
+                                              relevant_line_in_file: str,
+                                              absolute_position: int = None) -> Tuple[int, int]:
     position = -1
+    if absolute_position is None:
         absolute_position = -1
     re_hunk_header = re.compile(
         r"^@@ -(\d+)(?:,(\d+))? \+(\d+)(?:,(\d+))? @@[ ]?(.*)")
@@ -285,15 +281,32 @@ def find_line_number_of_relevant_line_in_file(diff_files: List[FilePatchInfo],
         if file.filename and (file.filename.strip() == relevant_file):
             patch = file.patch
             patch_lines = patch.splitlines()
+            delta = 0
+            start1, size1, start2, size2 = 0, 0, 0, 0
+            if absolute_position != -1: # matching absolute to relative
+                for i, line in enumerate(patch_lines):
+                    # new hunk
+                    if line.startswith('@@'):
+                        delta = 0
+                        match = re_hunk_header.match(line)
+                        start1, size1, start2, size2 = map(int, match.groups()[:4])
+                    elif not line.startswith('-'):
+                        delta += 1
 
+                    #
+                    absolute_position_curr = start2 + delta - 1
+
+                    if absolute_position_curr == absolute_position:
+                        position = i
+                        break
+            else:
                 # try to find the line in the patch using difflib, with some margin of error
                 matches_difflib: list[str | Any] = difflib.get_close_matches(relevant_line_in_file,
                                                                              patch_lines, n=3, cutoff=0.93)
                 if len(matches_difflib) == 1 and matches_difflib[0].startswith('+'):
                     relevant_line_in_file = matches_difflib[0]
 
-            delta = 0
-            start1, size1, start2, size2 = 0, 0, 0, 0
+
                 for i, line in enumerate(patch_lines):
                     if line.startswith('@@'):
                         delta = 0

pr_agent/algo/utils.py

@@ -49,7 +49,7 @@ def convert_to_markdown(output_data: dict, gfm_supported: bool=True) -> str:
     }
 
     for key, value in output_data.items():
-        if value is None or value == '' or value == {}:
+        if value is None or value == '' or value == {} or value == []:
             continue
         if isinstance(value, dict):
             markdown_text += f"## {key}\n\n"
@@ -58,15 +58,15 @@ def convert_to_markdown(output_data: dict, gfm_supported: bool=True) -> str:
             emoji = emojis.get(key, "")
             if key.lower() == 'code feedback':
                 if gfm_supported:
-                    markdown_text += f"\n\n- "
-                    markdown_text += f"<details><summary> { emoji } Code feedback:</summary>\n\n"
+                    markdown_text += f"\n\n"
+                    markdown_text += f"<details><summary> <strong>{ emoji } Code feedback:</strong></summary>"
                 else:
-                    markdown_text += f"\n\n- **{emoji} Code feedback:**\n\n"
+                    markdown_text += f"\n\n**{emoji} Code feedback:**\n\n"
             else:
                 markdown_text += f"- {emoji} **{key}:**\n\n"
-            for item in value:
+            for i, item in enumerate(value):
                 if isinstance(item, dict) and key.lower() == 'code feedback':
-                    markdown_text += parse_code_suggestion(item, gfm_supported)
+                    markdown_text += parse_code_suggestion(item, i, gfm_supported)
                 elif item:
                     markdown_text += f"  - {item}\n"
             if key.lower() == 'code feedback':
@@ -76,11 +76,17 @@ def convert_to_markdown(output_data: dict, gfm_supported: bool=True) -> str:
                     markdown_text += "\n\n"
         elif value != 'n/a':
             emoji = emojis.get(key, "")
+            if key.lower() == 'general suggestions':
+                if gfm_supported:
+                    markdown_text += f"\n\n<strong>{emoji} General suggestions:</strong> {value}\n"
+                else:
+                    markdown_text += f"{emoji} **General suggestions:** {value}\n"
+            else:
                 markdown_text += f"- {emoji} **{key}:** {value}\n"
     return markdown_text
 
 
-def parse_code_suggestion(code_suggestions: dict, gfm_supported: bool=True) -> str:
+def parse_code_suggestion(code_suggestions: dict, i: int = 0, gfm_supported: bool = True) -> str:
     """
     Convert a dictionary of data into markdown format.
 
@@ -91,6 +97,35 @@ def parse_code_suggestion(code_suggestions: dict, gfm_supported: bool=True) -> s
         str: A string containing the markdown formatted text generated from the input dictionary.
     """
     markdown_text = ""
+    if gfm_supported and 'relevant line' in code_suggestions:
+        if i == 0:
+            markdown_text += "<hr>"
+        markdown_text += '<table>'
+        for sub_key, sub_value in code_suggestions.items():
+            try:
+                if sub_key.lower() == 'relevant file':
+                    relevant_file = sub_value.strip('`').strip('"').strip("'")
+                    markdown_text += f"<tr><td>{sub_key}</td><td>{relevant_file}</td></tr>"
+                    # continue
+                elif sub_key.lower() == 'suggestion':
+                    markdown_text += (f"<tr><td>{sub_key} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>"
+                                      f"<td><br>\n\n**{sub_value.strip()}**\n<br></td></tr>")
+                elif sub_key.lower() == 'relevant line':
+                    markdown_text += f"<tr><td>relevant line</td>"
+                    sub_value_list = sub_value.split('](')
+                    relevant_line = sub_value_list[0].lstrip('`').lstrip('[')
+                    if len(sub_value_list) > 1:
+                        link = sub_value_list[1].rstrip(')').strip('`')
+                        markdown_text += f"<td><a href={link}>{relevant_line}</a></td>"
+                    else:
+                        markdown_text += f"<td>{relevant_line}</td>"
+                    markdown_text += "</tr>"
+            except Exception as e:
+                get_logger().exception(f"Failed to parse code suggestion: {e}")
+                pass
+        markdown_text += '</table>'
+        markdown_text += "<hr>"
+    else:
         for sub_key, sub_value in code_suggestions.items():
             if isinstance(sub_value, dict):  # "code example"
                 markdown_text += f"  - **{sub_key}:**\n"
@@ -288,19 +323,21 @@ def _fix_key_value(key: str, value: str):
     return key, value
 
 
-def load_yaml(response_text: str) -> dict:
+def load_yaml(response_text: str, keys_fix_yaml: List[str] = []) -> dict:
     response_text = response_text.removeprefix('```yaml').rstrip('`')
     try:
         data = yaml.safe_load(response_text)
     except Exception as e:
         get_logger().error(f"Failed to parse AI prediction: {e}")
-        data = try_fix_yaml(response_text)
+        data = try_fix_yaml(response_text, keys_fix_yaml=keys_fix_yaml)
     return data
 
-def try_fix_yaml(response_text: str) -> dict:
+
+def try_fix_yaml(response_text: str, keys_fix_yaml: List[str] = []) -> dict:
     response_text_lines = response_text.split('\n')
 
-    keys = ['relevant line:', 'suggestion content:', 'relevant file:']
+    keys = ['relevant line:', 'suggestion content:', 'relevant file:', 'existing code:', 'improved code:']
+    keys = keys + keys_fix_yaml
     # first fallback - try to convert 'relevant line: ...' to relevant line: |-\n        ...'
     response_text_lines_copy = response_text_lines.copy()
     for i in range(0, len(response_text_lines_copy)):
@@ -315,18 +352,19 @@ def try_fix_yaml(response_text: str) -> dict:
     except:
         get_logger().info(f"Failed to parse AI prediction after adding |-\n")
 
-    # second fallback - try to remove last lines
-    data = {}
-    for i in range(1, len(response_text_lines)):
-        response_text_lines_tmp = '\n'.join(response_text_lines[:-i])
+    # second fallback - try to extract only range from first ```yaml to ````
+    snippet_pattern = r'```(yaml)?[\s\S]*?```'
+    snippet = re.search(snippet_pattern, '\n'.join(response_text_lines_copy))
+    if snippet:
+        snippet_text = snippet.group()
         try:
-            data = yaml.safe_load(response_text_lines_tmp,)
-            get_logger().info(f"Successfully parsed AI prediction after removing {i} lines")
-            break
+            data = yaml.safe_load(snippet_text.removeprefix('```yaml').rstrip('`'))
+            get_logger().info(f"Successfully parsed AI prediction after extracting yaml snippet")
+            return data
         except:
             pass
 
-    # thrid fallback - try to remove leading and trailing curly brackets
+     # third fallback - try to remove leading and trailing curly brackets
     response_text_copy = response_text.strip().rstrip().removeprefix('{').removesuffix('}')
     try:
         data = yaml.safe_load(response_text_copy,)
@@ -335,8 +373,19 @@ def try_fix_yaml(response_text: str) -> dict:
     except:
         pass
 
+    # fourth fallback - try to remove last lines
+    data = {}
+    for i in range(1, len(response_text_lines)):
+        response_text_lines_tmp = '\n'.join(response_text_lines[:-i])
+        try:
+            data = yaml.safe_load(response_text_lines_tmp,)
+            get_logger().info(f"Successfully parsed AI prediction after removing {i} lines")
+            return data
+        except:
+            pass
 
-def set_custom_labels(variables):
+
+def set_custom_labels(variables, git_provider=None):
     if not get_settings().config.enable_custom_labels:
         return
 
@@ -348,15 +397,18 @@ def set_custom_labels(variables):
         labels_list = f"      - {labels_list}" if labels_list else ""
         variables["custom_labels"] = labels_list
         return
-    #final_labels = ""
-    #for k, v in labels.items():
-    #    final_labels += f"      - {k} ({v['description']})\n"
-    #variables["custom_labels"] = final_labels
-    #variables["custom_labels_examples"] = f"      - {list(labels.keys())[0]}"
+
+    # Set custom labels
     variables["custom_labels_class"] = "class Label(str, Enum):"
+    counter = 0
+    labels_minimal_to_labels_dict = {}
     for k, v in labels.items():
-        description = v['description'].strip('\n').replace('\n', '\\n')
-        variables["custom_labels_class"] += f"\n    {k.lower().replace(' ', '_')} = '{k}' # {description}"
+        description = "'" + v['description'].strip('\n').replace('\n', '\\n') + "'"
+        # variables["custom_labels_class"] += f"\n    {k.lower().replace(' ', '_')} = '{k}' # {description}"
+        variables["custom_labels_class"] += f"\n    {k.lower().replace(' ', '_')} = {description}"
+        labels_minimal_to_labels_dict[k.lower().replace(' ', '_')] = k
+        counter += 1
+    variables["labels_minimal_to_labels_dict"] = labels_minimal_to_labels_dict
 
 def get_user_labels(current_labels: List[str] = None):
     """

pr_agent/git_providers/azuredevops_provider.py

@@ -1,29 +1,147 @@
-import json
+import os
 from typing import Optional, Tuple
 from urllib.parse import urlparse
 
-import os
-
 from ..log import get_logger
 
 AZURE_DEVOPS_AVAILABLE = True
 try:
     from msrest.authentication import BasicAuthentication
     from azure.devops.connection import Connection
-    from azure.devops.v7_1.git.models import Comment, CommentThread, GitVersionDescriptor, GitPullRequest
-except ImportError:
+    from azure.devops.v7_1.git.models import (
+        Comment,
+        CommentThread,
+        GitVersionDescriptor,
+        GitPullRequest,
+    )
+except ImportError as e:
     AZURE_DEVOPS_AVAILABLE = False
 
-from ..config_loader import get_settings
-from ..algo.utils import load_large_diff, clip_tokens
 from ..algo.language_handler import is_valid_file
-from .git_provider import EDIT_TYPE, FilePatchInfo
+from ..algo.utils import clip_tokens, load_large_diff
+from ..config_loader import get_settings
+from .git_provider import EDIT_TYPE, FilePatchInfo, GitProvider
 
 
-class AzureDevopsProvider:
-    def __init__(self, pr_url: Optional[str] = None, incremental: Optional[bool] = False):
+class AzureDevopsProvider(GitProvider):
+    def publish_code_suggestions(self, code_suggestions: list) -> bool:
+        """
+        Publishes code suggestions as comments on the PR.
+        """
+        post_parameters_list = []
+        for suggestion in code_suggestions:
+            body = suggestion['body']
+            relevant_file = suggestion['relevant_file']
+            relevant_lines_start = suggestion['relevant_lines_start']
+            relevant_lines_end = suggestion['relevant_lines_end']
+
+            if not relevant_lines_start or relevant_lines_start == -1:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().exception(
+                        f"Failed to publish code suggestion, relevant_lines_start is {relevant_lines_start}")
+                continue
+
+            if relevant_lines_end < relevant_lines_start:
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().exception(f"Failed to publish code suggestion, "
+                                           f"relevant_lines_end is {relevant_lines_end} and "
+                                           f"relevant_lines_start is {relevant_lines_start}")
+                continue
+
+            if relevant_lines_end > relevant_lines_start:
+                post_parameters = {
+                    "body": body,
+                    "path": relevant_file,
+                    "line": relevant_lines_end,
+                    "start_line": relevant_lines_start,
+                    "start_side": "RIGHT",
+                }
+            else:  # API is different for single line comments
+                post_parameters = {
+                    "body": body,
+                    "path": relevant_file,
+                    "line": relevant_lines_start,
+                    "side": "RIGHT",
+                }
+            post_parameters_list.append(post_parameters)
+
+        try:
+            for post_parameters in post_parameters_list:
+                comment = Comment(content=post_parameters["body"], comment_type=1)
+                thread = CommentThread(comments=[comment],
+                                       thread_context={
+                                           "filePath": post_parameters["path"],
+                                           "rightFileStart": {
+                                               "line": post_parameters["start_line"],
+                                               "offset": 1,
+                                           },
+                                           "rightFileEnd": {
+                                               "line": post_parameters["line"],
+                                               "offset": 1,
+                                           },
+                                       })
+                self.azure_devops_client.create_thread(
+                    comment_thread=thread,
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    pull_request_id=self.pr_num
+                )
+                if get_settings().config.verbosity_level >= 2:
+                    get_logger().info(
+                        f"Published code suggestion on {self.pr_num} at {post_parameters['path']}"
+                    )
+            return True
+        except Exception as e:
+            if get_settings().config.verbosity_level >= 2:
+                get_logger().error(f"Failed to publish code suggestion, error: {e}")
+            return False
+
+    def get_pr_description_full(self) -> str:
+        pass
+
+    def remove_comment(self, comment):
+        try:
+            self.azure_devops_client.delete_comment(
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+                thread_id=comment["thread_id"],
+                comment_id=comment["comment_id"],
+                project=self.workspace_slug,
+            )
+        except Exception as e:
+            get_logger().exception(f"Failed to remove comment, error: {e}")
+
+    def publish_labels(self, pr_types):
+        try:
+            for pr_type in pr_types:
+                self.azure_devops_client.create_pull_request_label(
+                    label={"name": pr_type},
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    pull_request_id=self.pr_num,
+                )
+        except Exception as e:
+            get_logger().exception(f"Failed to publish labels, error: {e}")
+
+    def get_pr_labels(self):
+        try:
+            labels = self.azure_devops_client.get_pull_request_labels(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                pull_request_id=self.pr_num,
+            )
+            return [label.name for label in labels]
+        except Exception as e:
+            get_logger().exception(f"Failed to get labels, error: {e}")
+            return []
+
+    def __init__(
+            self, pr_url: Optional[str] = None, incremental: Optional[bool] = False
+    ):
         if not AZURE_DEVOPS_AVAILABLE:
-            raise ImportError("Azure DevOps provider is not available. Please install the required dependencies.")
+            raise ImportError(
+                "Azure DevOps provider is not available. Please install the required dependencies."
+            )
 
         self.azure_devops_client = self._get_azure_devops_client()
 
@@ -38,8 +156,11 @@ class AzureDevopsProvider:
             self.set_pr(pr_url)
 
     def is_supported(self, capability: str) -> bool:
-        if capability in ['get_issue_comments', 'create_inline_comment', 'publish_inline_comments', 'get_labels',
-                          'remove_initial_comment', 'gfm_markdown']:
+        if capability in [
+            "get_issue_comments",
+            "create_inline_comment",
+            "publish_inline_comments",
+        ]:
             return False
         return True
 
@@ -49,10 +170,14 @@ class AzureDevopsProvider:
 
     def get_repo_settings(self):
         try:
-            contents = self.azure_devops_client.get_item_content(repository_id=self.repo_slug,
-                                                                 project=self.workspace_slug, download=False,
-                                                                 include_content_metadata=False, include_content=True,
-                                                                 path=".pr_agent.toml")
+            contents = self.azure_devops_client.get_item_content(
+                repository_id=self.repo_slug,
+                project=self.workspace_slug,
+                download=False,
+                include_content_metadata=False,
+                include_content=True,
+                path=".pr_agent.toml",
+            )
             return contents
         except Exception as e:
             get_logger().exception("get repo settings error")
@@ -60,15 +185,19 @@ class AzureDevopsProvider:
 
     def get_files(self):
         files = []
-        for i in self.azure_devops_client.get_pull_request_commits(project=self.workspace_slug,
+        for i in self.azure_devops_client.get_pull_request_commits(
+                project=self.workspace_slug,
                 repository_id=self.repo_slug,
-                                                                   pull_request_id=self.pr_num):
-
-            changes_obj = self.azure_devops_client.get_changes(project=self.workspace_slug,
-                                                               repository_id=self.repo_slug, commit_id=i.commit_id)
+                pull_request_id=self.pr_num,
+        ):
+            changes_obj = self.azure_devops_client.get_changes(
+                project=self.workspace_slug,
+                repository_id=self.repo_slug,
+                commit_id=i.commit_id,
+            )
 
             for c in changes_obj.changes:
-                files.append(c['item']['path'])
+                files.append(c["item"]["path"])
         return list(set(files))
 
     def get_diff_files(self) -> list[FilePatchInfo]:
@@ -76,22 +205,27 @@ class AzureDevopsProvider:
             base_sha = self.pr.last_merge_target_commit
             head_sha = self.pr.last_merge_source_commit
 
-            commits = self.azure_devops_client.get_pull_request_commits(project=self.workspace_slug,
+            commits = self.azure_devops_client.get_pull_request_commits(
+                project=self.workspace_slug,
                 repository_id=self.repo_slug,
-                                                                        pull_request_id=self.pr_num)
+                pull_request_id=self.pr_num,
+            )
 
             diff_files = []
             diffs = []
             diff_types = {}
 
             for c in commits:
-                changes_obj = self.azure_devops_client.get_changes(project=self.workspace_slug,
-                                                                   repository_id=self.repo_slug, commit_id=c.commit_id)
+                changes_obj = self.azure_devops_client.get_changes(
+                    project=self.workspace_slug,
+                    repository_id=self.repo_slug,
+                    commit_id=c.commit_id,
+                )
                 for i in changes_obj.changes:
-                    if(i['item']['gitObjectType'] == 'tree'):
+                    if i["item"]["gitObjectType"] == "tree":
                         continue
-                    diffs.append(i['item']['path'])
-                    diff_types[i['item']['path']] = i['changeType']
+                    diffs.append(i["item"]["path"])
+                    diff_types[i["item"]["path"]] = i["changeType"]
 
             diffs = list(set(diffs))
 
@@ -99,47 +233,72 @@ class AzureDevopsProvider:
                 if not is_valid_file(file):
                     continue
 
-                version = GitVersionDescriptor(version=head_sha.commit_id, version_type='commit')
+                version = GitVersionDescriptor(
+                    version=head_sha.commit_id, version_type="commit"
+                )
                 try:
-                    new_file_content_str = self.azure_devops_client.get_item(repository_id=self.repo_slug,
+                    new_file_content_str = self.azure_devops_client.get_item(
+                        repository_id=self.repo_slug,
                         path=file,
                         project=self.workspace_slug,
                         version_descriptor=version,
                         download=False,
-                                                                            include_content=True)
+                        include_content=True,
+                    )
 
                     new_file_content_str = new_file_content_str.content
                 except Exception as error:
-                    get_logger().error("Failed to retrieve new file content of %s at version %s. Error: %s", file, version, str(error))
+                    get_logger().error(
+                        "Failed to retrieve new file content of %s at version %s. Error: %s",
+                        file,
+                        version,
+                        str(error),
+                    )
                     new_file_content_str = ""
 
                 edit_type = EDIT_TYPE.MODIFIED
-                if diff_types[file] == 'add':
+                if diff_types[file] == "add":
                     edit_type = EDIT_TYPE.ADDED
-                elif diff_types[file] == 'delete':
+                elif diff_types[file] == "delete":
                     edit_type = EDIT_TYPE.DELETED
-                elif diff_types[file] == 'rename':
+                elif diff_types[file] == "rename":
                     edit_type = EDIT_TYPE.RENAMED
 
-                version = GitVersionDescriptor(version=base_sha.commit_id, version_type='commit')
+                version = GitVersionDescriptor(
+                    version=base_sha.commit_id, version_type="commit"
+                )
                 try:
-                    original_file_content_str = self.azure_devops_client.get_item(repository_id=self.repo_slug,
+                    original_file_content_str = self.azure_devops_client.get_item(
+                        repository_id=self.repo_slug,
                         path=file,
                         project=self.workspace_slug,
                         version_descriptor=version,
                         download=False,
-                                                                              include_content=True)
+                        include_content=True,
+                    )
                     original_file_content_str = original_file_content_str.content
                 except Exception as error:
-                    get_logger().error("Failed to retrieve original file content of %s at version %s. Error: %s", file, version, str(error))
+                    get_logger().error(
+                        "Failed to retrieve original file content of %s at version %s. Error: %s",
+                        file,
+                        version,
+                        str(error),
+                    )
                     original_file_content_str = ""
 
-                patch = load_large_diff(file, new_file_content_str, original_file_content_str)
+                patch = load_large_diff(
+                    file, new_file_content_str, original_file_content_str
+                )
 
-                diff_files.append(FilePatchInfo(original_file_content_str, new_file_content_str,
+                diff_files.append(
+                    FilePatchInfo(
+                        original_file_content_str,
+                        new_file_content_str,
                         patch=patch,
                         filename=file,
-                                                edit_type=edit_type))
+                        edit_type=edit_type,
+                    )
+                )
 
             self.diff_files = diff_files
             return diff_files
@@ -150,67 +309,92 @@ class AzureDevopsProvider:
     def publish_comment(self, pr_comment: str, is_temporary: bool = False):
         comment = Comment(content=pr_comment)
         thread = CommentThread(comments=[comment])
-        thread_response = self.azure_devops_client.create_thread(comment_thread=thread, project=self.workspace_slug,
+        thread_response = self.azure_devops_client.create_thread(
+            comment_thread=thread,
+            project=self.workspace_slug,
             repository_id=self.repo_slug,
-                                                                 pull_request_id=self.pr_num)
+            pull_request_id=self.pr_num,
+        )
         if is_temporary:
-            self.temp_comments.append({'thread_id': thread_response.id, 'comment_id': comment.id})
+            self.temp_comments.append(
+                {"thread_id": thread_response.id, "comment_id": thread_response.comments[0].id}
+            )
 
     def publish_description(self, pr_title: str, pr_body: str):
         try:
             updated_pr = GitPullRequest()
             updated_pr.title = pr_title
             updated_pr.description = pr_body
-            self.azure_devops_client.update_pull_request(project=self.workspace_slug,
+            self.azure_devops_client.update_pull_request(
+                project=self.workspace_slug,
                 repository_id=self.repo_slug,
                 pull_request_id=self.pr_num,
-                                                         git_pull_request_to_update=updated_pr)
+                git_pull_request_to_update=updated_pr,
+            )
         except Exception as e:
-            get_logger().exception(f"Could not update pull request {self.pr_num} description: {e}")
+            get_logger().exception(
+                f"Could not update pull request {self.pr_num} description: {e}"
+            )
 
     def remove_initial_comment(self):
-        return ""  # not implemented yet
+        try:
+            for comment in self.temp_comments:
+                self.remove_comment(comment)
+        except Exception as e:
+            get_logger().exception(f"Failed to remove temp comments, error: {e}")
 
-    def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("Azure DevOps provider does not support publishing inline comment yet")
-
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("Azure DevOps provider does not support creating inline comments yet")
+    def publish_inline_comment(
+            self, body: str, relevant_file: str, relevant_line_in_file: str
+    ):
+        raise NotImplementedError(
+            "Azure DevOps provider does not support publishing inline comment yet"
+        )
 
     def publish_inline_comments(self, comments: list[dict]):
-        raise NotImplementedError("Azure DevOps provider does not support publishing inline comments yet")
+        raise NotImplementedError(
+            "Azure DevOps provider does not support publishing inline comments yet"
+        )
 
     def get_title(self):
         return self.pr.title
 
     def get_languages(self):
         languages = []
-        files = self.azure_devops_client.get_items(project=self.workspace_slug, repository_id=self.repo_slug,
-                                                   recursion_level="Full", include_content_metadata=True,
-                                                   include_links=False, download=False)
+        files = self.azure_devops_client.get_items(
+            project=self.workspace_slug,
+            repository_id=self.repo_slug,
+            recursion_level="Full",
+            include_content_metadata=True,
+            include_links=False,
+            download=False,
+        )
         for f in files:
-            if f.git_object_type == 'blob':
+            if f.git_object_type == "blob":
                 file_name, file_extension = os.path.splitext(f.path)
                 languages.append(file_extension[1:])
 
         extension_counts = {}
         for ext in languages:
-            if ext != '':
+            if ext != "":
                 extension_counts[ext] = extension_counts.get(ext, 0) + 1
 
         total_extensions = sum(extension_counts.values())
 
-        extension_percentages = {ext: (count / total_extensions) * 100 for ext, count in extension_counts.items()}
+        extension_percentages = {
+            ext: (count / total_extensions) * 100
+            for ext, count in extension_counts.items()
+        }
 
         return extension_percentages
 
     def get_pr_branch(self):
-        pr_info = self.azure_devops_client.get_pull_request_by_id(project=self.workspace_slug,
-                                                                  pull_request_id=self.pr_num)
-        source_branch = pr_info.source_ref_name.split('/')[-1]
+        pr_info = self.azure_devops_client.get_pull_request_by_id(
+            project=self.workspace_slug, pull_request_id=self.pr_num
+        )
+        source_branch = pr_info.source_ref_name.split("/")[-1]
         return source_branch
 
-    def get_pr_description(self):
+    def get_pr_description(self, full=False):
         max_tokens = get_settings().get("CONFIG.MAX_DESCRIPTION_TOKENS", None)
         if max_tokens:
             return clip_tokens(self.pr.description, max_tokens)
@@ -220,7 +404,9 @@ class AzureDevopsProvider:
         return 0
 
     def get_issue_comments(self):
-        raise NotImplementedError("Azure DevOps provider does not support issue comments yet")
+        raise NotImplementedError(
+            "Azure DevOps provider does not support issue comments yet"
+        )
 
     def add_eyes_reaction(self, issue_comment_id: int) -> Optional[int]:
         return True
@@ -229,16 +415,20 @@ class AzureDevopsProvider:
         return True
 
     def get_issue_comments(self):
-        raise NotImplementedError("Azure DevOps provider does not support issue comments yet")
+        raise NotImplementedError(
+            "Azure DevOps provider does not support issue comments yet"
+        )
 
     @staticmethod
     def _parse_pr_url(pr_url: str) -> Tuple[str, int]:
         parsed_url = urlparse(pr_url)
 
-        path_parts = parsed_url.path.strip('/').split('/')
+        path_parts = parsed_url.path.strip("/").split("/")
 
-        if len(path_parts) < 6 or path_parts[4] != 'pullrequest':
-            raise ValueError("The provided URL does not appear to be a Azure DevOps PR URL")
+        if len(path_parts) < 6 or path_parts[4] != "pullrequest":
+            raise ValueError(
+                "The provided URL does not appear to be a Azure DevOps PR URL"
+            )
 
         workspace_slug = path_parts[1]
         repo_slug = path_parts[3]
@@ -254,10 +444,9 @@ class AzureDevopsProvider:
             pat = get_settings().azure_devops.pat
             org = get_settings().azure_devops.org
         except AttributeError as e:
-            raise ValueError(
-                "Azure DevOps PAT token is required ") from e
+            raise ValueError("Azure DevOps PAT token is required ") from e
 
-        credentials = BasicAuthentication('', pat)
+        credentials = BasicAuthentication("", pat)
         azure_devops_connection = Connection(base_url=org, creds=credentials)
         azure_devops_client = azure_devops_connection.clients.get_git_client()
 
@@ -265,13 +454,23 @@ class AzureDevopsProvider:
 
     def _get_repo(self):
         if self.repo is None:
-            self.repo = self.azure_devops_client.get_repository(project=self.workspace_slug,
-                                                                repository_id=self.repo_slug)
+            self.repo = self.azure_devops_client.get_repository(
+                project=self.workspace_slug, repository_id=self.repo_slug
+            )
         return self.repo
 
     def _get_pr(self):
-        self.pr = self.azure_devops_client.get_pull_request_by_id(pull_request_id=self.pr_num, project=self.workspace_slug)
+        self.pr = self.azure_devops_client.get_pull_request_by_id(
+            pull_request_id=self.pr_num, project=self.workspace_slug
+        )
         return self.pr
 
     def get_commit_messages(self):
         return ""  # not implemented yet
+
+    def get_pr_id(self):
+        try:
+            pr_id = f"{self.workspace_slug}/{self.repo_slug}/{self.pr_num}"
+            return pr_id
+        except Exception:
+            return ""

pr_agent/git_providers/bitbucket_provider.py

@@ -201,8 +201,10 @@ class BitbucketProvider(GitProvider):
             get_logger().exception(f"Failed to remove comment, error: {e}")
 
     # funtion to create_inline_comment
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        position, absolute_position = find_line_number_of_relevant_line_in_file(self.get_diff_files(), relevant_file.strip('`'), relevant_line_in_file)
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str, absolute_position: int = None):
+        position, absolute_position = find_line_number_of_relevant_line_in_file(self.get_diff_files(),
+                                                                            relevant_file.strip('`'),
+                                                                            relevant_line_in_file, absolute_position)
         if position == -1:
             if get_settings().config.verbosity_level >= 2:
                 get_logger().info(f"Could not find position for {relevant_file} {relevant_line_in_file}")
@@ -354,5 +356,5 @@ class BitbucketProvider(GitProvider):
         pass
     
     # bitbucket does not support labels
-    def get_labels(self):
+    def get_pr_labels(self):
         pass

pr_agent/git_providers/bitbucket_server_provider.py

@@ -210,11 +210,14 @@ class BitbucketServerProvider(GitProvider):
         pass
 
     # funtion to create_inline_comment
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
+                              absolute_position: int = None):
+
         position, absolute_position = find_line_number_of_relevant_line_in_file(
             self.get_diff_files(),
             relevant_file.strip('`'),
-            relevant_line_in_file
+            relevant_line_in_file,
+            absolute_position
         )
         if position == -1:
             if get_settings().config.verbosity_level >= 2:
@@ -344,7 +347,7 @@ class BitbucketServerProvider(GitProvider):
         pass
     
     # bitbucket does not support labels
-    def get_labels(self):
+    def get_pr_labels(self):
         pass
 
     def _get_pr_comments_url(self):

pr_agent/git_providers/codecommit_provider.py

@@ -216,7 +216,7 @@ class CodeCommitProvider(GitProvider):
     def publish_labels(self, labels):
         return [""]  # not implemented yet
 
-    def get_labels(self):
+    def get_pr_labels(self):
         return [""]  # not implemented yet
 
     def remove_initial_comment(self):
@@ -229,9 +229,6 @@ class CodeCommitProvider(GitProvider):
         # https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/codecommit/client/post_comment_for_compared_commit.html
         raise NotImplementedError("CodeCommit provider does not support publishing inline comments yet")
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError("CodeCommit provider does not support creating inline comments yet")
-
     def publish_inline_comments(self, comments: list[dict]):
         raise NotImplementedError("CodeCommit provider does not support publishing inline comments yet")
 

pr_agent/git_providers/gerrit_provider.py

@@ -207,7 +207,7 @@ class GerritProvider(GitProvider):
         Comment = namedtuple('Comment', ['body'])
         return Comments([Comment(c['message']) for c in reversed(comments)])
 
-    def get_labels(self):
+    def get_pr_labels(self):
         raise NotImplementedError(
             'Getting labels is not implemented for the gerrit provider')
 
@@ -380,11 +380,6 @@ class GerritProvider(GitProvider):
             'Publishing inline comments is not implemented for the gerrit '
             'provider')
 
-    def create_inline_comment(self, body: str, relevant_file: str,
-                              relevant_line_in_file: str):
-        raise NotImplementedError(
-            'Creating inline comments is not implemented for the gerrit '
-            'provider')
 
     def publish_labels(self, labels):
         # Not applicable to the local git provider,

pr_agent/git_providers/git_provider.py

@@ -74,15 +74,47 @@ class GitProvider(ABC):
 
     def get_user_description(self) -> str:
         description = (self.get_pr_description_full() or "").strip()
+        description_lowercase = description.lower()
+
         # if the existing description wasn't generated by the pr-agent, just return it as-is
-        if not any(description.startswith(header) for header in ("## PR Type", "## PR Description")):
+        if not self._is_generated_by_pr_agent(description_lowercase):
             return description
-        # if the existing description was generated by the pr-agent, but it doesn't contain the user description,
+
+        # if the existing description was generated by the pr-agent, but it doesn't contain a user description,
         # return nothing (empty string) because it means there is no user description
-        if "## User Description:" not in description:
+        user_description_header = "## user description"
+        if user_description_header not in description_lowercase:
             return ""
+
         # otherwise, extract the original user description from the existing pr-agent description and return it
-        return description.split("## User Description:", 1)[1].strip()
+        # user_description_start_position = description_lowercase.find(user_description_header) + len(user_description_header)
+        # return description[user_description_start_position:].split("\n", 1)[-1].strip()
+
+        # the 'user description' is in the beginning. extract and return it
+        possible_headers = self._possible_headers()
+        start_position = description_lowercase.find(user_description_header) + len(user_description_header)
+        end_position = len(description)
+        for header in possible_headers: # try to clip at the next header
+            if header != user_description_header and header in description_lowercase:
+                end_position = min(end_position, description_lowercase.find(header))
+        if end_position != len(description) and end_position > start_position:
+            original_user_description = description[start_position:end_position].strip()
+            if original_user_description.endswith("___"):
+                original_user_description = original_user_description[:-3].strip()
+        else:
+            original_user_description = description.split("___")[0].strip()
+            if original_user_description.lower().startswith(user_description_header):
+                original_user_description = original_user_description[len(user_description_header):].strip()
+
+        return original_user_description
+
+    def _possible_headers(self):
+        return ("## user description", "## pr type", "## pr description", "## pr labels", "## type", "## description",
+                "## labels", "### 🤖 generated by pr agent")
+
+    def _is_generated_by_pr_agent(self, description_lowercase: str) -> bool:
+        possible_headers = self._possible_headers()
+        return any(description_lowercase.startswith(header) for header in possible_headers)
 
     @abstractmethod
     def get_repo_settings(self):
@@ -106,9 +138,9 @@ class GitProvider(ABC):
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
         pass
 
-    @abstractmethod
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        pass
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
+                              absolute_position: int = None):
+        raise NotImplementedError("This git provider does not support creating inline comments yet")
 
     @abstractmethod
     def publish_inline_comments(self, comments: list[dict]):
@@ -135,7 +167,10 @@ class GitProvider(ABC):
         pass
 
     @abstractmethod
-    def get_labels(self):
+    def get_pr_labels(self):
+        pass
+
+    def get_repo_labels(self):
         pass
 
     @abstractmethod

pr_agent/git_providers/github_provider.py

@@ -206,8 +206,12 @@ class GithubProvider(GitProvider):
         self.publish_inline_comments([self.create_inline_comment(body, relevant_file, relevant_line_in_file)])
 
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        position, absolute_position = find_line_number_of_relevant_line_in_file(self.diff_files, relevant_file.strip('`'), relevant_line_in_file)
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str,
+                              absolute_position: int = None):
+        position, absolute_position = find_line_number_of_relevant_line_in_file(self.diff_files,
+                                                                                relevant_file.strip('`'),
+                                                                                relevant_line_in_file,
+                                                                                absolute_position)
         if position == -1:
             if get_settings().config.verbosity_level >= 2:
                 get_logger().info(f"Could not find position for {relevant_file} {relevant_line_in_file}")
@@ -461,13 +465,17 @@ class GithubProvider(GitProvider):
         except Exception as e:
             get_logger().exception(f"Failed to publish labels, error: {e}")
 
-    def get_labels(self):
+    def get_pr_labels(self):
         try:
             return [label.name for label in self.pr.labels]
         except Exception as e:
             get_logger().exception(f"Failed to get labels, error: {e}")
             return []
 
+    def get_repo_labels(self):
+        labels = self.repo_obj.get_labels()
+        return [label for label in labels]
+
     def get_commit_messages(self):
         """
         Retrieves the commit messages of a pull request.

pr_agent/git_providers/gitlab_provider.py

@@ -183,7 +183,7 @@ class GitLabProvider(GitProvider):
         self.send_inline_comment(body, edit_type, found, relevant_file, relevant_line_in_file, source_line_no,
                                  target_file, target_line_no)
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
+    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str, absolute_position: int = None):
         raise NotImplementedError("Gitlab provider does not support creating inline comments yet")
 
     def create_inline_comments(self, comments: list[dict]):
@@ -211,7 +211,11 @@ class GitLabProvider(GitProvider):
                 pos_obj['new_line'] = target_line_no - 1
                 pos_obj['old_line'] = source_line_no - 1
             get_logger().debug(f"Creating comment in {self.id_mr} with body {body} and position {pos_obj}")
+            try:
                 self.mr.discussions.create({'body': body, 'position': pos_obj})
+            except Exception as e:
+                get_logger().debug(
+                    f"Failed to create comment in {self.id_mr} with position {pos_obj} (probably not a '+' line)")
 
     def get_relevant_diff(self, relevant_file: str, relevant_line_in_file: int) -> Optional[dict]:
         changes = self.mr.changes()  # Retrieve the changes for the merge request once
@@ -404,9 +408,12 @@ class GitLabProvider(GitProvider):
     def publish_inline_comments(self, comments: list[dict]):
         pass
 
-    def get_labels(self):
+    def get_pr_labels(self):
         return self.mr.labels
 
+    def get_repo_labels(self):
+        return self.gl.projects.get(self.id_project).labels.list()
+
     def get_commit_messages(self):
         """
         Retrieves the commit messages of a pull request.

pr_agent/git_providers/local_git_provider.py

@@ -121,9 +121,6 @@ class LocalGitProvider(GitProvider):
     def publish_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
         raise NotImplementedError('Publishing inline comments is not implemented for the local git provider')
 
-    def create_inline_comment(self, body: str, relevant_file: str, relevant_line_in_file: str):
-        raise NotImplementedError('Creating inline comments is not implemented for the local git provider')
-
     def publish_inline_comments(self, comments: list[dict]):
         raise NotImplementedError('Publishing inline comments is not implemented for the local git provider')
 
@@ -178,5 +175,5 @@ class LocalGitProvider(GitProvider):
     def get_issue_comments(self):
         raise NotImplementedError('Getting issue comments is not implemented for the local git provider')
 
-    def get_labels(self):
+    def get_pr_labels(self):
         raise NotImplementedError('Getting labels is not implemented for the local git provider')

pr_agent/servers/bitbucket_app.py

@@ -16,8 +16,13 @@ from starlette_context.middleware import RawContextMiddleware
 
 from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.config_loader import get_settings, global_settings
+from pr_agent.git_providers.utils import apply_repo_settings
 from pr_agent.log import LoggingFormat, get_logger, setup_logger
 from pr_agent.secret_providers import get_secret_provider
+from pr_agent.servers.github_action_runner import get_setting_or_env, is_true
+from pr_agent.tools.pr_code_suggestions import PRCodeSuggestions
+from pr_agent.tools.pr_description import PRDescription
+from pr_agent.tools.pr_reviewer import PRReviewer
 
 setup_logger(fmt=LoggingFormat.JSON)
 router = APIRouter()
@@ -89,8 +94,20 @@ async def handle_github_webhooks(background_tasks: BackgroundTasks, request: Req
                 pr_url = data["data"]["pullrequest"]["links"]["html"]["href"]
                 log_context["api_url"] = pr_url
                 log_context["event"] = "pull_request"
+                if pr_url:
                     with get_logger().contextualize(**log_context):
-                    await agent.handle_request(pr_url, "review")
+                        apply_repo_settings(pr_url)
+                        auto_review = get_setting_or_env("BITBUCKET_APP.AUTO_REVIEW", None)
+                        if auto_review is None or is_true(auto_review):  # by default, auto review is enabled
+                            await PRReviewer(pr_url).run()
+                        auto_improve = get_setting_or_env("BITBUCKET_APP.AUTO_IMPROVE", None)
+                        if is_true(auto_improve):  # by default, auto improve is disabled
+                            await PRCodeSuggestions(pr_url).run()
+                        auto_describe = get_setting_or_env("BITBUCKET_APP.AUTO_DESCRIBE", None)
+                        if is_true(auto_describe):  # by default, auto describe is disabled
+                            await PRDescription(pr_url).run()
+                # with get_logger().contextualize(**log_context):
+                #     await agent.handle_request(pr_url, "review")
             elif event == "pullrequest:comment_created":
                 pr_url = data["data"]["pullrequest"]["links"]["html"]["href"]
                 log_context["api_url"] = pr_url

pr_agent/servers/bitbucket_server_webhook.py

@@ -1,4 +1,5 @@
 import json
+import os
 
 import uvicorn
 from fastapi import APIRouter, FastAPI
@@ -13,35 +14,55 @@ from starlette_context.middleware import RawContextMiddleware
 from pr_agent.agent.pr_agent import PRAgent
 from pr_agent.config_loader import get_settings
 from pr_agent.log import get_logger
+from pr_agent.servers.utils import verify_signature
 
 router = APIRouter()
 
 
-def handle_request(background_tasks: BackgroundTasks, url: str, body: str, log_context: dict):
+def handle_request(
+    background_tasks: BackgroundTasks, url: str, body: str, log_context: dict
+):
     log_context["action"] = body
-    log_context["event"] = "pull_request" if body == "review" else "comment"
     log_context["api_url"] = url
     with get_logger().contextualize(**log_context):
         background_tasks.add_task(PRAgent().handle_request, url, body)
 
 
-@router.post("/webhook")
+@router.post("/")
 async def handle_webhook(background_tasks: BackgroundTasks, request: Request):
     log_context = {"server_type": "bitbucket_server"}
     data = await request.json()
     get_logger().info(json.dumps(data))
 
-    pr_id = data['pullRequest']['id']
-    repository_name = data['pullRequest']['toRef']['repository']['slug']
-    project_name = data['pullRequest']['toRef']['repository']['project']['key']
+    webhook_secret = get_settings().get("BITBUCKET_SERVER.WEBHOOK_SECRET", None)
+    if webhook_secret:
+        body_bytes = await request.body()
+        signature_header = request.headers.get("x-hub-signature", None)
+        verify_signature(body_bytes, webhook_secret, signature_header)
+
+    pr_id = data["pullRequest"]["id"]
+    repository_name = data["pullRequest"]["toRef"]["repository"]["slug"]
+    project_name = data["pullRequest"]["toRef"]["repository"]["project"]["key"]
     bitbucket_server = get_settings().get("BITBUCKET_SERVER.URL")
     pr_url = f"{bitbucket_server}/projects/{project_name}/repos/{repository_name}/pull-requests/{pr_id}"
 
     log_context["api_url"] = pr_url
     log_context["event"] = "pull_request"
 
-    handle_request(background_tasks, pr_url, "review", log_context)
-    return JSONResponse(status_code=status.HTTP_200_OK, content=jsonable_encoder({"message": "success"}))
+    if data["eventKey"] == "pr:opened":
+        body = "review"
+    elif data["eventKey"] == "pr:comment:added":
+        body = data["comment"]["text"]
+    else:
+        return JSONResponse(
+            status_code=status.HTTP_400_BAD_REQUEST,
+            content=json.dumps({"message": "Unsupported event"}),
+        )
+
+    handle_request(background_tasks, pr_url, body, log_context)
+    return JSONResponse(
+        status_code=status.HTTP_200_OK, content=jsonable_encoder({"message": "success"})
+    )
 
 
 @router.get("/")
@@ -50,15 +71,10 @@ async def root():
 
 
 def start():
-    bitbucket_server_url = get_settings().get("BITBUCKET_SERVER.URL", None)
-    if not bitbucket_server_url:
-        raise ValueError("BITBUCKET_SERVER.URL is not set")
-    get_settings().config.git_provider = "bitbucket_server"
-    middleware = [Middleware(RawContextMiddleware)]
-    app = FastAPI(middleware=middleware)
+    app = FastAPI(middleware=[Middleware(RawContextMiddleware)])
     app.include_router(router)
-    uvicorn.run(app, host="0.0.0.0", port=3000)
+    uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", "3000")))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     start()

pr_agent/servers/github_app.py

@@ -125,11 +125,15 @@ async def handle_request(body: Dict[str, Any], event: str):
             await _perform_commands("pr_commands", agent, body, api_url, log_context)
 
     # handle pull_request event with synchronize action - "push trigger" for new commits
-    elif event == 'pull_request' and action == 'synchronize' and get_settings().github_app.handle_push_trigger:
+    elif event == 'pull_request' and action == 'synchronize':
         pull_request, api_url = _check_pull_request_event(action, body, log_context, bot_user)
         if not (pull_request and api_url):
             return {}
 
+        apply_repo_settings(api_url)
+        if not get_settings().github_app.handle_push_trigger:
+            return {}
+
         # TODO: do we still want to get the list of commits to filter bot/merge commits?
         before_sha = body.get("before")
         after_sha = body.get("after")

pr_agent/servers/help.py

@@ -1,11 +1,12 @@
-commands_text = "> **/review**: Request a review of your Pull Request.   \n" \
-                "> **/describe**: Update the PR title and description based on the contents of the PR.   \n" \
-                "> **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback.   \n" \
-                "> **/ask \\<QUESTION\\>**: Ask a question about the PR.   \n" \
-                "> **/update_changelog**: Update the changelog based on the PR's contents.   \n" \
-                "> **/add_docs**: Generate docstring for new components introduced in the PR.   \n" \
-                "> **/generate_labels**: Generate labels for the PR based on the PR's contents.   \n" \
-                "> see the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details.\n\n" \
+commands_text = "> - **/review**: Request a review of your Pull Request.   \n" \
+                "> - **/describe**: Update the PR title and description based on the contents of the PR.   \n" \
+                "> - **/improve [--extended]**: Suggest code improvements. Extended mode provides a higher quality feedback.   \n" \
+                "> - **/ask \\<QUESTION\\>**: Ask a question about the PR.   \n" \
+                "> - **/update_changelog**: Update the changelog based on the PR's contents.   \n" \
+                "> - **/add_docs** 💎: Generate docstring for new components introduced in the PR.   \n" \
+                "> - **/generate_labels** 💎: Generate labels for the PR based on the PR's contents.   \n" \
+                "> - **/analyze** 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.   \n\n" \
+                ">See the [tools guide](https://github.com/Codium-ai/pr-agent/blob/main/docs/TOOLS_GUIDE.md) for more details.\n" \
                 ">To edit any configuration parameter from the [configuration.toml](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml), add --config_path=new_value.  \n" \
                 ">For example: /review --pr_reviewer.extra_instructions=\"focus on the file: ...\"    \n" \
                 ">To list the possible configuration parameters, add a **/config** comment.   \n" \

pr_agent/settings/.secrets_template.toml

@@ -65,6 +65,11 @@ personal_access_token = ""
 # For Bitbucket personal/repository bearer token
 bearer_token = ""
 
+[bitbucket_server]
+# For Bitbucket Server bearer token
+auth_token = ""
+webhook_secret = ""
+
 # For Bitbucket app
 app_key = ""
 base_url = ""

pr_agent/settings/configuration.toml

@@ -7,6 +7,7 @@ publish_output_progress=true
 verbosity_level=0 # 0,1,2
 use_extra_bad_extensions=false
 use_repo_settings_file=true
+use_global_settings_file=true
 ai_timeout=180
 max_description_tokens = 500
 max_commits_tokens = 500
@@ -22,11 +23,14 @@ require_score_review=false
 require_tests_review=true
 require_security_review=true
 require_estimate_effort_to_review=true
+# soc2
+require_soc2_ticket=false
+soc2_ticket_prompt="Does the PR description include a link to ticket in a project management system (e.g., Jira, Asana, Trello, etc.) ?"
 # general options
 num_code_suggestions=4
 inline_code_comments = false
 ask_and_reflect=false
-automatic_review=true
+#automatic_review=true
 remove_previous_review_comment=false
 persistent_comment=true
 extra_instructions = ""
@@ -37,6 +41,7 @@ enable_review_labels_effort=false
 require_all_thresholds_for_incremental_review=false
 minimal_commits_for_incremental_review=0
 minimal_minutes_for_incremental_review=0
+enable_help_text=true # Determines whether to include help text in the PR review. Enabled by default.
 
 [pr_description] # /describe #
 publish_labels=true
@@ -46,11 +51,10 @@ keep_original_user_title=false
 use_bullet_points=true
 extra_instructions = ""
 enable_pr_type=true
-enable_file_walkthrough=false
-enable_semantic_files_types=true
 final_update_message = true
-
-
+## changes walkthrough section
+enable_semantic_files_types=true
+collapsible_file_list='adaptive' # true, false, 'adaptive'
 # markers
 use_description_markers=false
 include_generated_by_header=true
@@ -62,9 +66,11 @@ include_generated_by_header=true
 [pr_code_suggestions] # /improve #
 num_code_suggestions=4
 summarize = false
+include_improved_code = true
 extra_instructions = ""
 rank_suggestions = false
 # params for '/improve --extended' mode
+auto_extended_mode=false
 num_code_suggestions_per_chunk=8
 rank_extended_suggestions = true
 max_number_of_calls = 5
@@ -78,6 +84,8 @@ docs_style = "Sphinx Style" # "Google Style with Args, Returns, Attributes...etc
 push_changelog_changes=false
 extra_instructions = ""
 
+[pr_analyze] # /analyze #
+
 [pr_config] # /config #
 
 [github]
@@ -103,7 +111,7 @@ duplicate_requests_cache_ttl = 60  # in seconds
 handle_pr_actions = ['opened', 'reopened', 'ready_for_review', 'review_requested']
 pr_commands = [
     "/describe --pr_description.add_original_user_description=true --pr_description.keep_original_user_title=true",
-    "/auto_review",
+    "/review",
 ]
 # settings for "pull_request" event with "synchronize" action - used to detect and handle push triggers for new commits
 handle_push_trigger = false
@@ -143,6 +151,12 @@ magic_word = "AutoReview"
 # Polling interval
 polling_interval_seconds = 30
 
+[bitbucket_app]
+#auto_review = true    # set as config var in .pr_agent.toml
+#auto_describe = true  # set as config var in .pr_agent.toml
+#auto_improve = true   # set as config var in .pr_agent.toml
+
+
 [local]
 # LocalGitProvider settings - uncomment to use paths other than default
 # description_path= "path/to/description.md"
@@ -158,6 +172,11 @@ polling_interval_seconds = 30
 # token to authenticate in the patch server
 # patch_server_token = ""
 
+[bitbucket_server]
+# URL to the BitBucket Server instance
+# url = "https://git.bitbucket.com"
+url = ""
+
 [litellm]
 #use_client = false
 
@@ -165,8 +184,12 @@ polling_interval_seconds = 30
 skip_comments = false
 force_update_dataset = false
 max_issues_to_scan = 500
+vectordb = "pinecone"
 
 [pinecone]
 # fill and place in .secrets.toml
 #api_key = ...
 # environment = "gcp-starter"
+
+[lancedb]
+uri = "./lancedb"

pr_agent/settings/pr_add_docs.toml

@@ -35,7 +35,7 @@ Specific instructions:
 - Try to identify edited/added code components (classes/functions/methods...) that are undocumented, and generate {{ docs_for_language }} for each one.
 - If there are documented (any type of {{ language }} documentation) code components in the PR, Don't generate {{ docs_for_language }} for them.
 - Ignore code components that don't appear fully in the '__new hunk__' section. For example, you must see the component header and body.
-- Make sure the {{ docs_for_language }} starts and ends with standart {{ language }} {{ docs_for_language }} signs.
+- Make sure the {{ docs_for_language }} starts and ends with standard {{ language }} {{ docs_for_language }} signs.
 - The {{ docs_for_language }} should be in standard format.
 - Provide the exact line number (inclusive) where the {{ docs_for_language }} should be added.
 
@@ -69,6 +69,7 @@ Code Documentation:
         - after
       description: |-
         The {{ docs_for_language }} placement relative to the relevant line (code component).
+        For example, in Python the docs are placed after the function signature, but in Java they are placed before.
     documentation:
       type: string
       description: |-

pr_agent/settings/pr_code_suggestions_prompts.toml

@@ -32,13 +32,13 @@ __old hunk__
 
 Specific instructions:
 - Provide up to {{ num_code_suggestions }} code suggestions. Try to provide diverse and insightful suggestions.
-- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on best practices, code readability, maintainability, enhancments, performance, and other aspects.
+- Prioritize suggestions that address major problems, issues and bugs in the code. As a second priority, suggestions should focus on enhancement, best practice, performance, maintainability, and other aspects.
 - Don't suggest to add docstring, type hints, or comments.
 - Suggestions should refer only to code from the '__new hunk__' sections, and focus on new lines of code (lines starting with '+').
 - Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the '__new hunk__' code.
-- For each suggestion, make sure to take into consideration also the context, meaning the lines before and after the relevant code.
 - Provide the exact line numbers range (inclusive) for each suggestion.
 - Assume there is additional relevant code, that is not included in the diff.
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 
 
 {%- if extra_instructions %}
@@ -49,65 +49,41 @@ Extra instructions from the user:
 ======
 {%- endif %}
 
+The output must be a YAML object equivalent to type PRCodeSuggestions, according to the following Pydantic definitions:
+=====
+class CodeSuggestion(BaseModel):
+    relevant_file: str = Field(description="the relevant file full path")
+    suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
+    existing_code: str = Field(description="a code snippet, showing the relevant code lines from a '__new hunk__' section. It must be contiguous, correctly formatted and indented, and without line numbers")
+    relevant_lines_start: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion starts (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
+    relevant_lines_end: int = Field(description="The relevant line number, from a '__new hunk__' section, where the suggestion ends (inclusive). Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above")
+    improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant lines in '__new hunk__' code. Replacement suggestions should be complete, correctly formatted and indented, and without line numbers")
+    label: str = Field(description="a single label for the suggestion, to help the user understand the suggestion type. For example: 'security', 'bug', 'performance', 'enhancement', 'possible issue', 'best practice', 'maintainability', etc. Other labels are also allowed")
+
+class PRCodeSuggestions(BaseModel):
+    code_suggestions: List[CodeSuggestion]
+=====
 
-You must use the following YAML schema to format your answer:
-```yaml
-Code suggestions:
-  type: array
-  minItems: 1
-  maxItems: {{ num_code_suggestions }}
-  uniqueItems: true
-  items:
-    relevant file:
-      type: string
-      description: the relevant file full path
-    suggestion content:
-      type: string
-      description: |-
-        a concrete suggestion for meaningfully improving the new PR code.
-    existing code:
-      type: string
-      description: |-
-        a code snippet showing the relevant code lines from a '__new hunk__' section.
-        It must be contiguous, correctly formatted and indented, and without line numbers.
-    relevant lines start:
-      type: integer
-      description: |-
-        The relevant line number from a '__new hunk__' section where the suggestion starts (inclusive).
-        Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above.
-    relevant lines end:
-      type: integer
-      description: |-
-        The relevant line number from a '__new hunk__' section where the suggestion ends (inclusive).
-        Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above.
-    improved code:
-      type: string
-      description: |-
-        a new code snippet that can be used to replace the relevant lines in '__new hunk__' code.
-        Replacement suggestions should be complete, correctly formatted and indented, and without line numbers.
-```
 
 Example output:
 ```yaml
-Code suggestions:
-- relevant file: |-
+code_suggestions:
+- relevant_file: |-
     src/file1.py
-  suggestion content: |-
+  suggestion_content: |-
     Add a docstring to func1()
-  existing code: |-
+  existing_code: |-
     def func1():
-  relevant lines start: |-
-    12
-  relevant lines end: |-
-    12
-  improved code: |-
+  relevant_lines_start: 12
+  relevant_lines_end: 12
+  improved_code: |-
     ...
+  label: |-
     ...
 ```
 
 
 Each YAML output MUST be after a newline, indented, with block scalar indicator ('|-').
-Don't repeat the prompt in the answer, and avoid outputting the 'type' and 'description' fields.
 """
 
 user="""PR Info:

pr_agent/settings/pr_custom_labels.toml

@@ -30,7 +30,7 @@ class Label(str, Enum):
 {%- endif %}
 
 class Labels(BaseModel):
-    labels: List[Label] = Field(min_items=0, description="custom labels that describe the PR. Return the label value, not the name.")
+    labels: List[Label] =  Field(min_items=0, description="choose the relevant custom labels that describe the PR content, and return their keys. Use the value field of the Label object to better understand the label meaning.")
 ======
 
 

pr_agent/settings/pr_description_prompts.toml

@@ -1,10 +1,15 @@
 [pr_description_prompt]
 system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR).
-Your task is to provide a full description for the PR content - title, type, description, and main files walkthrough.
+{%- if enable_custom_labels %}
+Your task is to provide a full description for the PR content - files walkthrough, title, type, description and labels.
+{%- else %}
+Your task is to provide a full description for the PR content - files walkthrough, title, type, and description.
+{%- endif %}
 - Focus on the new PR code (lines starting with '+').
 - Keep in mind that the 'Previous title', 'Previous description' and 'Commit messages' sections may be partial, simplistic, non-informative or out of date. Hence, compare them to the PR diff code, and use them only as a reference.
 - The generated title and description should prioritize the most significant changes.
 - If needed, each YAML output should be in block scalar indicator ('|-')
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 
 {%- if extra_instructions %}
 
@@ -30,13 +35,8 @@ class PRType(str, Enum):
 
 {%- endif %}
 
-{%- if enable_file_walkthrough %}
-class FileWalkthrough(BaseModel):
-    filename: str = Field(description="the relevant file full path")
-    changes_in_file: str = Field(description="minimal and concise summary of the changes in the relevant file")
-{%- endif %}
-
 {%- if enable_semantic_files_types %}
+
 Class FileDescription(BaseModel):
     filename: str = Field(description="the relevant file full path")
     changes_summary: str = Field(description="minimal and concise summary of the changes in the relevant file")
@@ -44,17 +44,14 @@ Class FileDescription(BaseModel):
 {%- endif %}
 
 Class PRDescription(BaseModel):
-    title: str = Field(description="an informative title for the PR, describing its main theme")
-    type: List[PRType] = Field(description="one or more types that describe the PR type. Return the label value, not the name.")
-    description: str = Field(description="an informative and concise description of the PR. {%- if use_bullet_points %} Use bullet points.{% endif %}")
-{%- if enable_custom_labels %}
-    labels: List[Label] = Field(min_items=0, description="custom labels that describe the PR. Return the label value, not the name.")
-{%- endif %}
-{%- if enable_file_walkthrough %}
-    main_files_walkthrough: List[FileWalkthrough] = Field(max_items=10)
-{%- endif %}
+    type: List[PRType] = Field(description="one or more types that describe the PR content. Return the label member value (e.g. 'Bug fix', not 'bug_fix')")
 {%- if enable_semantic_files_types %}
-    pr_files[List[FileDescription]] = Field(max_items=15")
+    pr_files[List[FileDescription]] = Field(max_items=15, description="a list of the files in the PR, and their changes summary.")
+{%- endif %}
+    description: str = Field(description="an informative and concise description of the PR. Use bullet points. Display first the most significant changes.")
+    title: str = Field(description="an informative title for the PR, describing its main theme")
+{%- if enable_custom_labels %}
+    labels: List[Label] =  Field(min_items=0, description="choose the relevant custom labels that describe the PR content, and return their keys. Use the value field of the Label object to better understand the label meaning.")
 {%- endif %}
 =====
 
@@ -62,23 +59,9 @@ Class PRDescription(BaseModel):
 Example output:
 
 ```yaml
-title: |-
-  ...
 type:
 - ...
 - ...
-{%- if enable_custom_labels %}
-labels:
-- ...
-- ...
-{%- endif %}
-description: |-
-  ...
-{%- if enable_file_walkthrough %}
-main_files_walkthrough:
-- ...
-- ...
-{%- endif %}
 {%- if enable_semantic_files_types %}
 pr_files:
 - filename: |
@@ -89,6 +72,17 @@ pr_files:
     ...
 ...
 {%- endif %}
+description: |-
+  ...
+title: |-
+  ...
+{%- if enable_custom_labels %}
+labels:
+- |
+  ...
+- |
+  ...
+{%- endif %}
 ```
 
 Answer should be a valid YAML, and nothing else. Each YAML output MUST be after a newline, with proper indent, and block scalar indicator ('|-')

pr_agent/settings/pr_reviewer_prompts.toml

@@ -32,6 +32,7 @@ Code suggestions guidelines:
 - Avoid making suggestions that have already been implemented in the PR code. For example, if you want to add logs, or change a variable to const, or anything else, make sure it isn't already in the PR code.
 - Don't suggest to add docstring, type hints, or comments.
 - Suggestions should focus on the new code added in the PR diff (lines starting with '+')
+- When quoting variables or names from the code, use backticks (`) instead of single quote (').
 {%- endif %}
 
 {%- if extra_instructions %}

pr_agent/tools/pr_add_docs.py

@@ -1,10 +1,12 @@
 import copy
 import textwrap
+from functools import partial
 from typing import Dict
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import load_yaml
@@ -15,14 +17,15 @@ from pr_agent.log import get_logger
 
 
 class PRAddDocs:
-    def __init__(self, pr_url: str, cli_mode=False, args: list = None):
+    def __init__(self, pr_url: str, cli_mode=False, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
 
         self.git_provider = get_git_provider()(pr_url)
         self.main_language = get_main_pr_language(
             self.git_provider.get_languages(), self.git_provider.get_files()
         )
 
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.patches_diff = None
         self.prediction = None
         self.cli_mode = cli_mode

pr_agent/tools/pr_code_suggestions.py

@@ -1,9 +1,11 @@
 import copy
 import textwrap
+from functools import partial
 from typing import Dict, List
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, get_pr_multi_diffs, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import load_yaml
@@ -14,7 +16,8 @@ from pr_agent.log import get_logger
 
 
 class PRCodeSuggestions:
-    def __init__(self, pr_url: str, cli_mode=False, args: list = None):
+    def __init__(self, pr_url: str, cli_mode=False, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
 
         self.git_provider = get_git_provider()(pr_url)
         self.main_language = get_main_pr_language(
@@ -23,7 +26,7 @@ class PRCodeSuggestions:
 
         # extended mode
         try:
-            self.is_extended = any(["extended" in arg for arg in args])
+            self.is_extended = self._get_is_extended(args or [])
         except:
             self.is_extended = False
         if self.is_extended:
@@ -31,7 +34,7 @@ class PRCodeSuggestions:
         else:
             num_code_suggestions = get_settings().pr_code_suggestions.num_code_suggestions
 
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.patches_diff = None
         self.prediction = None
         self.cli_mode = cli_mode
@@ -62,14 +65,14 @@ class PRCodeSuggestions:
                 data = self._prepare_pr_code_suggestions()
             else:
                 data = await retry_with_fallback_models(self._prepare_prediction_extended)
-            if (not data) or (not 'Code suggestions' in data):
+            if (not data) or (not 'code_suggestions' in data):
                 get_logger().info('No code suggestions found for PR.')
                 return
 
             if (not self.is_extended and get_settings().pr_code_suggestions.rank_suggestions) or \
                     (self.is_extended and get_settings().pr_code_suggestions.rank_extended_suggestions):
                 get_logger().info('Ranking Suggestions...')
-                data['Code suggestions'] = await self.rank_suggestions(data['Code suggestions'])
+                data['code_suggestions'] = await self.rank_suggestions(data['code_suggestions'])
 
             if get_settings().config.publish_output:
                 get_logger().info('Pushing PR code suggestions...')
@@ -106,48 +109,80 @@ class PRCodeSuggestions:
         response, finish_reason = await self.ai_handler.chat_completion(model=model, temperature=0.2,
                                                                         system=system_prompt, user=user_prompt)
 
+        if get_settings().config.verbosity_level >= 2:
+            get_logger().info(f"\nAI response:\n{response}")
+
         return response
 
     def _prepare_pr_code_suggestions(self) -> Dict:
         review = self.prediction.strip()
-        data = load_yaml(review)
+        data = load_yaml(review,
+                         keys_fix_yaml=["relevant_file", "suggestion_content", "existing_code", "improved_code"])
         if isinstance(data, list):
-            data = {'Code suggestions': data}
+            data = {'code_suggestions': data}
+
+        # remove invalid suggestions
+        suggestion_list = []
+        for i, suggestion in enumerate(data['code_suggestions']):
+            if suggestion['existing_code'] != suggestion['improved_code']:
+                suggestion_list.append(suggestion)
+            else:
+                get_logger().debug(
+                    f"Skipping suggestion {i + 1}, because existing code is equal to improved code {suggestion['existing_code']}")
+        data['code_suggestions'] = suggestion_list
+
         return data
 
     def push_inline_code_suggestions(self, data):
         code_suggestions = []
 
-        if not data['Code suggestions']:
+        if not data['code_suggestions']:
             get_logger().info('No suggestions found to improve this PR.')
             return self.git_provider.publish_comment('No suggestions found to improve this PR.')
 
-        for d in data['Code suggestions']:
+        for d in data['code_suggestions']:
             try:
                 if get_settings().config.verbosity_level >= 2:
                     get_logger().info(f"suggestion: {d}")
-                relevant_file = d['relevant file'].strip()
-                relevant_lines_start = int(d['relevant lines start'])  # absolute position
-                relevant_lines_end = int(d['relevant lines end'])
-                content = d['suggestion content']
-                new_code_snippet = d['improved code']
+                relevant_file = d['relevant_file'].strip()
+                relevant_lines_start = int(d['relevant_lines_start'])  # absolute position
+                relevant_lines_end = int(d['relevant_lines_end'])
+                content = d['suggestion_content'].rstrip()
+                new_code_snippet = d['improved_code'].rstrip()
+                label = d['label'].strip()
 
                 if new_code_snippet:
                     new_code_snippet = self.dedent_code(relevant_file, relevant_lines_start, new_code_snippet)
 
-                body = f"**Suggestion:** {content}\n```suggestion\n" + new_code_snippet + "\n```"
+                if get_settings().pr_code_suggestions.include_improved_code:
+                    body = f"**Suggestion:** {content} [{label}]\n```suggestion\n" + new_code_snippet + "\n```"
                     code_suggestions.append({'body': body, 'relevant_file': relevant_file,
                                              'relevant_lines_start': relevant_lines_start,
                                              'relevant_lines_end': relevant_lines_end})
+                else:
+                    if self.git_provider.is_supported("create_inline_comment"):
+                        body = f"**Suggestion:** {content} [{label}]"
+                        comment = self.git_provider.create_inline_comment(body, relevant_file, "",
+                                                                          absolute_position=relevant_lines_end)
+                        if comment:
+                            code_suggestions.append(comment)
+                    else:
+                        get_logger().error("Inline comments are not supported by the git provider")
             except Exception:
                 if get_settings().config.verbosity_level >= 2:
                     get_logger().info(f"Could not parse suggestion: {d}")
 
+        if get_settings().pr_code_suggestions.include_improved_code:
             is_successful = self.git_provider.publish_code_suggestions(code_suggestions)
+        else:
+            is_successful = self.git_provider.publish_inline_comments(code_suggestions)
         if not is_successful:
             get_logger().info("Failed to publish code suggestions, trying to publish each suggestion separately")
             for code_suggestion in code_suggestions:
+                if get_settings().pr_code_suggestions.include_improved_code:
                     self.git_provider.publish_code_suggestions([code_suggestion])
+                else:
+                    self.git_provider.publish_inline_comments([code_suggestion])
 
     def dedent_code(self, relevant_file, relevant_lines_start, new_code_snippet):
         try:  # dedent code snippet
@@ -171,6 +206,16 @@ class PRCodeSuggestions:
 
         return new_code_snippet
 
+    def _get_is_extended(self, args: list[str]) -> bool:
+        """Check if extended mode should be enabled by the `--extended` flag or automatically according to the configuration"""
+        if any(["extended" in arg for arg in args]):
+            get_logger().info("Extended mode is enabled by the `--extended` flag")
+            return True
+        if get_settings().pr_code_suggestions.auto_extended_mode:
+            get_logger().info("Extended mode is enabled automatically based on the configuration toggle")
+            return True
+        return False
+
     async def _prepare_prediction_extended(self, model: str) -> dict:
         get_logger().info('Getting PR diff...')
         patches_diff_list = get_pr_multi_diffs(self.git_provider, self.token_handler, model,
@@ -189,8 +234,8 @@ class PRCodeSuggestions:
         for prediction in prediction_list:
             self.prediction = prediction
             data_per_chunk = self._prepare_pr_code_suggestions()
-            if "Code suggestions" in data:
-                data["Code suggestions"].extend(data_per_chunk["Code suggestions"])
+            if "code_suggestions" in data:
+                data["code_suggestions"].extend(data_per_chunk["code_suggestions"])
             else:
                 data.update(data_per_chunk)
         self.data = data
@@ -208,11 +253,8 @@ class PRCodeSuggestions:
         """
 
         suggestion_list = []
-        # remove invalid suggestions
-        for i, suggestion in enumerate(data):
-            if suggestion['existing code'] != suggestion['improved code']:
+        for suggestion in data:
             suggestion_list.append(suggestion)
-
         data_sorted = [[]] * len(suggestion_list)
 
         try:
@@ -239,7 +281,13 @@ class PRCodeSuggestions:
                 data_sorted[importance_order - 1] = suggestion_list[suggestion_number - 1]
 
             if get_settings().pr_code_suggestions.final_clip_factor != 1:
-                new_len = int(0.5 + len(data_sorted) * get_settings().pr_code_suggestions.final_clip_factor)
+                max_len = max(
+                    len(data_sorted),
+                    get_settings().pr_code_suggestions.num_code_suggestions,
+                    get_settings().pr_code_suggestions.num_code_suggestions_per_chunk,
+                )
+                new_len = int(0.5 + max_len * get_settings().pr_code_suggestions.final_clip_factor)
+                if new_len < len(data_sorted):
                     data_sorted = data_sorted[:new_len]
         except Exception as e:
             if get_settings().config.verbosity_level >= 1:
@@ -258,24 +306,25 @@ class PRCodeSuggestions:
                 for ext in extensions:
                     extension_to_language[ext] = language
 
-            for s in data['Code suggestions']:
+            for s in data['code_suggestions']:
                 try:
-                    extension_s = s['relevant file'].rsplit('.')[-1]
-                    code_snippet_link = self.git_provider.get_line_link(s['relevant file'], s['relevant lines start'],
-                                                                        s['relevant lines end'])
-                    data_markdown += f"\n💡 Suggestion:\n\n**{s['suggestion content']}**\n\n"
+                    extension_s = s['relevant_file'].rsplit('.')[-1]
+                    code_snippet_link = self.git_provider.get_line_link(s['relevant_file'], s['relevant_lines_start'],
+                                                                        s['relevant_lines_end'])
+                    label = s['label'].strip()
+                    data_markdown += f"\n💡 [{label}]\n\n**{s['suggestion_content'].rstrip().rstrip()}**\n\n"
                     if code_snippet_link:
-                        data_markdown += f" File: [{s['relevant file']} ({s['relevant lines start']}-{s['relevant lines end']})]({code_snippet_link})\n\n"
+                        data_markdown += f" File: [{s['relevant_file']} ({s['relevant_lines_start']}-{s['relevant_lines_end']})]({code_snippet_link})\n\n"
                     else:
-                        data_markdown += f"File: {s['relevant file']} ({s['relevant lines start']}-{s['relevant lines end']})\n\n"
+                        data_markdown += f"File: {s['relevant_file']} ({s['relevant_lines_start']}-{s['relevant_lines_end']})\n\n"
                     if self.git_provider.is_supported("gfm_markdown"):
                         data_markdown += "<details> <summary> Example code:</summary>\n\n"
                         data_markdown += f"___\n\n"
                     language_name = "python"
                     if extension_s and (extension_s in extension_to_language):
                         language_name = extension_to_language[extension_s]
-                    data_markdown += f"Existing code:\n```{language_name}\n{s['existing code']}\n```\n"
-                    data_markdown += f"Improved code:\n```{language_name}\n{s['improved code']}\n```\n"
+                    data_markdown += f"Existing code:\n```{language_name}\n{s['existing_code'].rstrip()}\n```\n"
+                    data_markdown += f"Improved code:\n```{language_name}\n{s['improved_code'].rstrip()}\n```\n"
                     if self.git_provider.is_supported("gfm_markdown"):
                         data_markdown += "</details>\n"
                     data_markdown += "\n___\n\n"
@@ -284,5 +333,3 @@ class PRCodeSuggestions:
             self.git_provider.publish_comment(data_markdown)
         except Exception as e:
             get_logger().info(f"Failed to publish summarized code suggestions, error: {e}")
-
-

pr_agent/tools/pr_config.py

@@ -7,7 +7,7 @@ class PRConfig:
     """
     The PRConfig class is responsible for listing all configuration options available for the user.
     """
-    def __init__(self, pr_url: str, args=None):
+    def __init__(self, pr_url: str, args=None, ai_handler=None):
         """
         Initialize the PRConfig object with the necessary attributes and objects to comment on a pull request.
 

pr_agent/tools/pr_description.py

@@ -1,10 +1,12 @@
 import copy
 import re
+from functools import partial
 from typing import List, Tuple
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import load_yaml, set_custom_labels, get_user_labels
@@ -15,7 +17,8 @@ from pr_agent.log import get_logger
 
 
 class PRDescription:
-    def __init__(self, pr_url: str, args: list = None):
+    def __init__(self, pr_url: str, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         """
         Initialize the PRDescription object with the necessary attributes and objects for generating a PR description
         using an AI model.
@@ -36,7 +39,7 @@ class PRDescription:
             get_settings().pr_description.enable_semantic_files_types = False
 
         # Initialize the AI handler
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
     
         # Initialize the variables dictionary
         self.vars = {
@@ -45,12 +48,10 @@ class PRDescription:
             "description": self.git_provider.get_pr_description(full=False),
             "language": self.main_pr_language,
             "diff": "",  # empty diff for initial calculation
-            "use_bullet_points": get_settings().pr_description.use_bullet_points,
             "extra_instructions": get_settings().pr_description.extra_instructions,
             "commit_messages_str": self.git_provider.get_commit_messages(),
             "enable_custom_labels": get_settings().config.enable_custom_labels,
             "custom_labels_class": "",  # will be filled if necessary in 'set_custom_labels' function
-            "enable_file_walkthrough": get_settings().pr_description.enable_file_walkthrough,
             "enable_semantic_files_types": get_settings().pr_description.enable_semantic_files_types,
         }
 
@@ -102,11 +103,12 @@ class PRDescription:
             if get_settings().config.publish_output:
                 get_logger().info(f"Pushing answer {self.pr_id}")
                 if get_settings().pr_description.publish_description_as_comment:
+                    get_logger().info(f"Publishing answer as comment")
                     self.git_provider.publish_comment(full_markdown_description)
                 else:
                     self.git_provider.publish_description(pr_title, pr_body)
                     if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
-                        current_labels = self.git_provider.get_labels()
+                        current_labels = self.git_provider.get_pr_labels()
                         user_labels = get_user_labels(current_labels)
                         self.git_provider.publish_labels(pr_labels + user_labels)
 
@@ -158,7 +160,8 @@ class PRDescription:
         variables["diff"] = self.patches_diff  # update diff
 
         environment = Environment(undefined=StrictUndefined)
-        set_custom_labels(variables)
+        set_custom_labels(variables, self.git_provider)
+        self.variables = variables
         system_prompt = environment.from_string(get_settings().pr_description_prompt.system).render(variables)
         user_prompt = environment.from_string(get_settings().pr_description_prompt.user).render(variables)
 
@@ -185,6 +188,22 @@ class PRDescription:
         if get_settings().pr_description.add_original_user_description and self.user_description:
             self.data["User Description"] = self.user_description
 
+        # re-order keys
+        if 'User Description' in self.data:
+            self.data['User Description'] = self.data.pop('User Description')
+        if 'title' in self.data:
+            self.data['title'] = self.data.pop('title')
+        if 'type' in self.data:
+            self.data['type'] = self.data.pop('type')
+        if 'labels' in self.data:
+            self.data['labels'] = self.data.pop('labels')
+        if 'description' in self.data:
+            self.data['description'] = self.data.pop('description')
+        if 'pr_files' in self.data:
+            self.data['pr_files'] = self.data.pop('pr_files')
+
+
+
 
     def _prepare_labels(self) -> List[str]:
         pr_types = []
@@ -200,6 +219,16 @@ class PRDescription:
                 pr_types = self.data['type']
             elif type(self.data['type']) == str:
                 pr_types = self.data['type'].split(',')
+
+        # convert lowercase labels to original case
+        try:
+            if "labels_minimal_to_labels_dict" in self.variables:
+                d: dict = self.variables["labels_minimal_to_labels_dict"]
+                for i, label_i in enumerate(pr_types):
+                    if label_i in d:
+                        pr_types[i] = d[label_i]
+        except Exception as e:
+            get_logger().error(f"Error converting labels to original case {self.pr_id}: {e}")
         return pr_types
 
     def _prepare_pr_answer_with_markers(self) -> Tuple[str, str]:
@@ -221,16 +250,15 @@ class PRDescription:
             summary = f"{ai_header}{ai_summary}"
             body = body.replace('pr_agent:summary', summary)
 
-        if not re.search(r'<!--\s*pr_agent:walkthrough\s*-->', body):
-            ai_walkthrough = self.data.get('PR Main Files Walkthrough')
-            if ai_walkthrough:
-                walkthrough = str(ai_header)
-                for file in ai_walkthrough:
-                    filename = file['filename'].replace("'", "`")
-                    description = file['changes in file'].replace("'", "`")
-                    walkthrough += f'- `{filename}`: {description}\n'
-
-                body = body.replace('pr_agent:walkthrough', walkthrough)
+        ai_walkthrough = self.data.get('pr_files')
+        if ai_walkthrough and not re.search(r'<!--\s*pr_agent:walkthrough\s*-->', body):
+            try:
+                walkthrough_gfm = ""
+                walkthrough_gfm = self.process_pr_files_prediction(walkthrough_gfm, self.file_label_dict)
+                body = body.replace('pr_agent:walkthrough', walkthrough_gfm)
+            except Exception as e:
+                get_logger().error(f"Failing to process walkthrough {self.pr_id}: {e}")
+                body = body.replace('pr_agent:walkthrough', "")
 
         return title, body
 
@@ -269,7 +297,7 @@ class PRDescription:
         for idx, (key, value) in enumerate(self.data.items()):
             if key == 'pr_files':
                 value = self.file_label_dict
-                key_publish = "PR changes walkthrough"
+                key_publish = "Changes walkthrough"
             else:
                 key_publish = key.rstrip(':').replace("_", " ").capitalize()
             pr_body += f"## {key_publish}\n"
@@ -290,7 +318,7 @@ class PRDescription:
                     value = ', '.join(v for v in value)
                 pr_body += f"{value}\n"
             if idx < len(self.data) - 1:
-                pr_body += "\n___\n"
+                pr_body += "\n\n___\n\n"
 
         if get_settings().config.verbosity_level >= 2:
             get_logger().info(f"title:\n{title}\n{pr_body}")
@@ -303,7 +331,7 @@ class PRDescription:
             try:
                 filename = file['filename'].replace("'", "`").replace('"', '`')
                 changes_summary = file['changes_summary']
-                label = file['label']
+                label = file.get('label')
                 if label not in self.file_label_dict:
                     self.file_label_dict[label] = []
                 self.file_label_dict[label].append((filename, changes_summary))
@@ -312,10 +340,18 @@ class PRDescription:
                 pass
 
     def process_pr_files_prediction(self, pr_body, value):
+        # logic for using collapsible file list
+        use_collapsible_file_list = get_settings().pr_description.collapsible_file_list
+        num_files = 0
+        if value:
+            for semantic_label in value.keys():
+                num_files += len(value[semantic_label])
+        if use_collapsible_file_list == "adaptive":
+            use_collapsible_file_list = num_files > 8
+
         if not self.git_provider.is_supported("gfm_markdown"):
             get_logger().info(f"Disabling semantic files types for {self.pr_id} since gfm_markdown is not supported")
             return pr_body
-
         try:
             pr_body += "<table>"
             header = f"Relevant files"
@@ -327,7 +363,11 @@ class PRDescription:
                 s_label = semantic_label.strip("'").strip('"')
                 pr_body += f"""<tr><td><strong>{s_label.capitalize()}</strong></td>"""
                 list_tuples = value[semantic_label]
+
+                if use_collapsible_file_list:
                     pr_body += f"""<td><details><summary>{len(list_tuples)} files</summary><table>"""
+                else:
+                    pr_body += f"""<td><table>"""
                 for filename, file_change_description in list_tuples:
                     filename = filename.replace("'", "`")
                     filename_publish = filename.split("/")[-1]
@@ -357,7 +397,8 @@ class PRDescription:
       <summary><strong>{filename_publish}</strong></summary>
       <ul>
         {filename}<br><br>
-        <strong>{file_change_description}</strong>
+
+**{file_change_description}**
 </ul>
     </details>
   </td>
@@ -365,7 +406,10 @@ class PRDescription:
 
 </tr>                    
 """
+                if use_collapsible_file_list:
                     pr_body += """</table></details></td></tr>"""
+                else:
+                    pr_body += """</table></td></tr>"""
             pr_body += """</tr></tbody></table>"""
 
         except Exception as e:

pr_agent/tools/pr_generate_labels.py

@@ -1,10 +1,12 @@
 import copy
 import re
+from functools import partial
 from typing import List, Tuple
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import load_yaml, set_custom_labels, get_user_labels
@@ -15,7 +17,8 @@ from pr_agent.log import get_logger
 
 
 class PRGenerateLabels:
-    def __init__(self, pr_url: str, args: list = None):
+    def __init__(self, pr_url: str, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         """
         Initialize the PRGenerateLabels object with the necessary attributes and objects for generating labels
         corresponding to the PR using an AI model.
@@ -31,7 +34,7 @@ class PRGenerateLabels:
         self.pr_id = self.git_provider.get_pr_id()
 
         # Initialize the AI handler
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
     
         # Initialize the variables dictionary
         self.vars = {
@@ -40,7 +43,6 @@ class PRGenerateLabels:
             "description": self.git_provider.get_pr_description(full=False),
             "language": self.main_pr_language,
             "diff": "",  # empty diff for initial calculation
-            "use_bullet_points": get_settings().pr_description.use_bullet_points,
             "extra_instructions": get_settings().pr_description.extra_instructions,
             "commit_messages_str": self.git_provider.get_commit_messages(),
             "enable_custom_labels": get_settings().config.enable_custom_labels,
@@ -82,7 +84,7 @@ class PRGenerateLabels:
             if get_settings().config.publish_output:
                 get_logger().info(f"Pushing labels {self.pr_id}")
 
-                current_labels = self.git_provider.get_labels()
+                current_labels = self.git_provider.get_pr_labels()
                 user_labels = get_user_labels(current_labels)
                 pr_labels = pr_labels + user_labels
 
@@ -132,7 +134,8 @@ class PRGenerateLabels:
         variables["diff"] = self.patches_diff  # update diff
 
         environment = Environment(undefined=StrictUndefined)
-        set_custom_labels(variables)
+        set_custom_labels(variables, self.git_provider)
+        self.variables = variables
         system_prompt = environment.from_string(get_settings().pr_custom_labels_prompt.system).render(variables)
         user_prompt = environment.from_string(get_settings().pr_custom_labels_prompt.user).render(variables)
 
@@ -168,4 +171,14 @@ class PRGenerateLabels:
             elif type(self.data['labels']) == str:
                 pr_types = self.data['labels'].split(',')
 
+        # convert lowercase labels to original case
+        try:
+            if "labels_minimal_to_labels_dict" in self.variables:
+                d: dict = self.variables["labels_minimal_to_labels_dict"]
+                for i, label_i in enumerate(pr_types):
+                    if label_i in d:
+                        pr_types[i] = d[label_i]
+        except Exception as e:
+            get_logger().error(f"Error converting labels to original case {self.pr_id}: {e}")
+
         return pr_types

pr_agent/tools/pr_information_from_user.py

@@ -1,8 +1,10 @@
 import copy
+from functools import partial
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.config_loader import get_settings
@@ -12,12 +14,13 @@ from pr_agent.log import get_logger
 
 
 class PRInformationFromUser:
-    def __init__(self, pr_url: str, args: list = None):
+    def __init__(self, pr_url: str, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         self.git_provider = get_git_provider()(pr_url)
         self.main_pr_language = get_main_pr_language(
             self.git_provider.get_languages(), self.git_provider.get_files()
         )
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.vars = {
             "title": self.git_provider.pr.title,
             "branch": self.git_provider.get_pr_branch(),

pr_agent/tools/pr_questions.py

@@ -1,8 +1,10 @@
 import copy
+from functools import partial
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.config_loader import get_settings
@@ -12,13 +14,13 @@ from pr_agent.log import get_logger
 
 
 class PRQuestions:
-    def __init__(self, pr_url: str, args=None):
+    def __init__(self, pr_url: str, args=None, ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         question_str = self.parse_args(args)
         self.git_provider = get_git_provider()(pr_url)
         self.main_pr_language = get_main_pr_language(
             self.git_provider.get_languages(), self.git_provider.get_files()
         )
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.question_str = question_str
         self.vars = {
             "title": self.git_provider.pr.title,

pr_agent/tools/pr_reviewer.py

@@ -1,13 +1,15 @@
 import copy
 import datetime
 from collections import OrderedDict
+from functools import partial
 from typing import List, Tuple
 
 import yaml
 from jinja2 import Environment, StrictUndefined
 from yaml import SafeLoader
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.algo.utils import convert_to_markdown, load_yaml, try_fix_yaml, set_custom_labels, get_user_labels
@@ -22,13 +24,16 @@ class PRReviewer:
     """
     The PRReviewer class is responsible for reviewing a pull request and generating feedback using an AI model.
     """
-    def __init__(self, pr_url: str, is_answer: bool = False, is_auto: bool = False, args: list = None):
+    def __init__(self, pr_url: str, is_answer: bool = False, is_auto: bool = False, args: list = None,
+                 ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
         """
         Initialize the PRReviewer object with the necessary attributes and objects to review a pull request.
 
         Args:
             pr_url (str): The URL of the pull request to be reviewed.
             is_answer (bool, optional): Indicates whether the review is being done in answer mode. Defaults to False.
+            is_auto (bool, optional): Indicates whether the review is being done in automatic mode. Defaults to False.
+            ai_handler (BaseAiHandler): The AI handler to be used for the review. Defaults to None.
             args (list, optional): List of arguments passed to the PRReviewer class. Defaults to None.
         """
         self.parse_args(args) # -i command
@@ -43,7 +48,7 @@ class PRReviewer:
 
         if self.is_answer and not self.git_provider.is_supported("get_issue_comments"):
             raise Exception(f"Answer mode is not supported for {get_settings().config.git_provider} for now")
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.patches_diff = None
         self.prediction = None
 
@@ -98,9 +103,9 @@ class PRReviewer:
         """
 
         try:
-            if self.is_auto and not get_settings().pr_reviewer.automatic_review:
-                get_logger().info(f'Automatic review is disabled {self.pr_url}')
-                return None
+            # if self.is_auto and not get_settings().pr_reviewer.automatic_review:
+            #     get_logger().info(f'Automatic review is disabled {self.pr_url}')
+            #     return None
             if self.incremental.is_incremental and not self._can_run_incremental_review():
                 return None
 
@@ -246,17 +251,14 @@ class PRReviewer:
         markdown_text = convert_to_markdown(data, self.git_provider.is_supported("gfm_markdown"))
         user = self.git_provider.get_user_id()
 
-        # Add help text if not in CLI mode
-        if not get_settings().get("CONFIG.CLI_MODE", False):
-            markdown_text += "\n### How to use\n"
-            if self.git_provider.is_supported("gfm_markdown"):
-                markdown_text += "\n <details> <summary> Instructions</summary>\n\n"
+        # Add help text if gfm_markdown is supported
+        if self.git_provider.is_supported("gfm_markdown") and get_settings().pr_reviewer.enable_help_text:
+            markdown_text += "\n\n<details> <summary><strong>✨ Usage tips:</strong></summary><hr> \n\n"
             bot_user = "[bot]" if get_settings().github_app.override_deployment_type else get_settings().github_app.bot_user
-            if user and bot_user not in user:
+            if user and bot_user not in user and not get_settings().get("CONFIG.CLI_MODE", False):
                 markdown_text += bot_help_text(user)
             else:
                 markdown_text += actions_help_text
-            if self.git_provider.is_supported("gfm_markdown"):
             markdown_text += "\n</details>\n"
 
         # Add custom labels from the review prediction (effort, security)
@@ -392,10 +394,13 @@ class PRReviewer:
                     if security_concerns_bool:
                         review_labels.append('Possible security concern')
 
-                current_labels = self.git_provider.get_labels()
+                current_labels = self.git_provider.get_pr_labels()
+                if current_labels:
                     current_labels_filtered = [label for label in current_labels if
                                                not label.lower().startswith('review effort [1-5]:') and not label.lower().startswith(
                                                    'possible security concern')]
+                else:
+                    current_labels_filtered = []
                 if current_labels or review_labels:
                     get_logger().info(f"Setting review labels: {review_labels + current_labels_filtered}")
                     self.git_provider.publish_labels(review_labels + current_labels_filtered)

pr_agent/tools/pr_similar_issue.py

@@ -5,6 +5,7 @@ from typing import List
 import openai
 import pandas as pd
 import pinecone
+import lancedb
 from pinecone_datasets import Dataset, DatasetMetadata
 from pydantic import BaseModel, Field
 
@@ -19,7 +20,7 @@ MODEL = "text-embedding-ada-002"
 
 
 class PRSimilarIssue:
-    def __init__(self, issue_url: str, args: list = None):
+    def __init__(self, issue_url: str, ai_handler, args: list = None):
         if get_settings().config.git_provider != "github":
             raise Exception("Only github is supported for similar issue tool")
 
@@ -35,6 +36,7 @@ class PRSimilarIssue:
         repo_name_for_index = self.repo_name_for_index = repo_obj.full_name.lower().replace('/', '-').replace('_/', '-')
         index_name = self.index_name = "codium-ai-pr-agent-issues"
 
+        if get_settings().pr_similar_issue.vectordb == "pinecone":
             # assuming pinecone api key and environment are set in secrets file
             try:
                 api_key = get_settings().pinecone.api_key
@@ -105,6 +107,68 @@ class PRSimilarIssue:
                 else:
                     get_logger().info('No new issues to update')
         
+        elif get_settings().pr_similar_issue.vectordb == "lancedb":
+            self.db = lancedb.connect(get_settings().lancedb.uri)
+            self.table = None
+
+            run_from_scratch = False
+            if run_from_scratch:  # for debugging
+                if index_name in self.db.table_names():
+                    get_logger().info('Removing Table...')
+                    self.db.drop_table(index_name)
+                    get_logger().info('Done')
+
+            ingest = True
+            if index_name not in self.db.table_names():
+                run_from_scratch = True
+                ingest = False
+            else:
+                if get_settings().pr_similar_issue.force_update_dataset:
+                    ingest = True
+                else:
+                    self.table = self.db[index_name]
+                    res = self.table.search().limit(len(self.table)).where(f"id='example_issue_{repo_name_for_index}'").to_list()
+                    get_logger().info("result: ", res)
+                    if res[0].get("vector"):
+                        ingest = False
+
+            if run_from_scratch or ingest:  # indexing the entire repo
+                get_logger().info('Indexing the entire repo...')
+
+                get_logger().info('Getting issues...')
+                issues = list(repo_obj.get_issues(state='all'))
+                get_logger().info('Done')
+
+                self._update_table_with_issues(issues, repo_name_for_index, ingest=ingest)
+            else:  # update table if needed
+                issues_to_update = []
+                issues_paginated_list = repo_obj.get_issues(state='all')
+                counter = 1
+                for issue in issues_paginated_list:
+                    if issue.pull_request:
+                        continue
+                    issue_str, comments, number = self._process_issue(issue)
+                    issue_key = f"issue_{number}"
+                    issue_id = issue_key + "." + "issue"
+                    res = self.table.search().limit(len(self.table)).where(f"id='{issue_id}'").to_list()
+                    is_new_issue = True
+                    for r in res:
+                        if r['metadata']['repo'] == repo_name_for_index:
+                            is_new_issue = False
+                            break
+                    if is_new_issue:
+                        counter += 1
+                        issues_to_update.append(issue)
+                    else:
+                        break
+
+                if issues_to_update:
+                    get_logger().info(f'Updating index with {counter} new issues...')
+                    self._update_table_with_issues(issues_to_update, repo_name_for_index, ingest=True)
+                else:
+                    get_logger().info('No new issues to update')
+        
+
     async def run(self):
         get_logger().info('Getting issue...')
         repo_name, original_issue_number = self.git_provider._parse_issue_url(self.issue_url.split('=')[-1])
@@ -116,14 +180,18 @@ class PRSimilarIssue:
         get_logger().info('Querying...')
         res = openai.Embedding.create(input=[issue_str], engine=MODEL)
         embeds = [record['embedding'] for record in res['data']]
+
+        relevant_issues_number_list = []
+        relevant_comment_number_list = []
+        score_list = []
+        
+        if get_settings().pr_similar_issue.vectordb == "pinecone":
             pinecone_index = pinecone.Index(index_name=self.index_name)
             res = pinecone_index.query(embeds[0],
                                     top_k=5,
                                     filter={"repo": self.repo_name_for_index},
                                     include_metadata=True).to_dict()
-        relevant_issues_number_list = []
-        relevant_comment_number_list = []
-        score_list = []
+        
             for r in res['matches']:
                 # skip example issue
                 if 'example_issue_' in r["id"]:
@@ -146,8 +214,35 @@ class PRSimilarIssue:
                 score_list.append(str("{:.2f}".format(r['score'])))
             get_logger().info('Done')
 
+        elif get_settings().pr_similar_issue.vectordb == "lancedb":
+            res = self.table.search(embeds[0]).where(f"metadata.repo='{self.repo_name_for_index}'", prefilter=True).to_list()
+            
+            for r in res:
+                # skip example issue
+                if 'example_issue_' in r["id"]:
+                    continue
+                
+                try:
+                    issue_number = int(r["id"].split('.')[0].split('_')[-1])
+                except:
+                    get_logger().debug(f"Failed to parse issue number from {r['id']}")
+                    continue
+
+                if original_issue_number == issue_number:
+                    continue
+                if issue_number not in relevant_issues_number_list:
+                    relevant_issues_number_list.append(issue_number)
+                
+                if 'comment' in r["id"]:
+                    relevant_comment_number_list.append(int(r["id"].split('.')[1].split('_')[-1]))
+                else:
+                    relevant_comment_number_list.append(-1)
+                score_list.append(str("{:.2f}".format(1-r['_distance'])))
+            get_logger().info('Done')
+        
         get_logger().info('Publishing response...')
         similar_issues_str = "### Similar Issues\n___\n\n"
+
         for i, issue_number_similar in enumerate(relevant_issues_number_list):
             issue = self.git_provider.repo_obj.get_issue(issue_number_similar)
             title = issue.title
@@ -266,6 +361,96 @@ class PRSimilarIssue:
             time.sleep(5)  # wait for pinecone to finalize upserting before querying
         get_logger().info('Done')
 
+    def _update_table_with_issues(self, issues_list, repo_name_for_index, ingest=False):
+        get_logger().info('Processing issues...')
+
+        corpus = Corpus()
+        example_issue_record = Record(
+            id=f"example_issue_{repo_name_for_index}",
+            text="example_issue",
+            metadata=Metadata(repo=repo_name_for_index)
+        )
+        corpus.append(example_issue_record)
+
+        counter = 0
+        for issue in issues_list:
+            if issue.pull_request:
+                continue
+
+            counter += 1
+            if counter % 100 == 0:
+                get_logger().info(f"Scanned {counter} issues")
+            if counter >= self.max_issues_to_scan:
+                get_logger().info(f"Scanned {self.max_issues_to_scan} issues, stopping")
+                break
+
+            issue_str, comments, number = self._process_issue(issue)
+            issue_key = f"issue_{number}"
+            username = issue.user.login
+            created_at = str(issue.created_at)
+            if len(issue_str) < 8000 or \
+                    self.token_handler.count_tokens(issue_str) < get_max_tokens(MODEL):  # fast reject first
+                issue_record = Record(
+                    id=issue_key + "." + "issue",
+                    text=issue_str,
+                    metadata=Metadata(repo=repo_name_for_index,
+                                        username=username,
+                                        created_at=created_at,
+                                        level=IssueLevel.ISSUE)
+                )
+                corpus.append(issue_record)
+                if comments:
+                    for j, comment in enumerate(comments):
+                        comment_body = comment.body
+                        num_words_comment = len(comment_body.split())
+                        if num_words_comment < 10 or not isinstance(comment_body, str):
+                            continue
+
+                        if len(comment_body) < 8000 or \
+                                self.token_handler.count_tokens(comment_body) < MAX_TOKENS[MODEL]:
+                            comment_record = Record(
+                                id=issue_key + ".comment_" + str(j + 1),
+                                text=comment_body,
+                                metadata=Metadata(repo=repo_name_for_index,
+                                                    username=username,  # use issue username for all comments
+                                                    created_at=created_at,
+                                                    level=IssueLevel.COMMENT)
+                            )
+                            corpus.append(comment_record)
+        df = pd.DataFrame(corpus.dict()["documents"])
+        get_logger().info('Done')
+
+        get_logger().info('Embedding...')
+        openai.api_key = get_settings().openai.key
+        list_to_encode = list(df["text"].values)
+        try:
+            res = openai.Embedding.create(input=list_to_encode, engine=MODEL)
+            embeds = [record['embedding'] for record in res['data']]
+        except:
+            embeds = []
+            get_logger().error('Failed to embed entire list, embedding one by one...')
+            for i, text in enumerate(list_to_encode):
+                try:
+                    res = openai.Embedding.create(input=[text], engine=MODEL)
+                    embeds.append(res['data'][0]['embedding'])
+                except:
+                    embeds.append([0] * 1536)
+        df["vector"] = embeds
+        get_logger().info('Done')
+
+        if not ingest:
+            get_logger().info('Creating table from scratch...')
+            self.table = self.db.create_table(self.index_name, data=df, mode="overwrite")
+            time.sleep(15)  
+        else:
+            get_logger().info('Ingesting in Table...')
+            if self.index_name not in self.db.table_names():
+                self.table.add(df)
+            else:
+                get_logger().info(f"Table {self.index_name} doesn't exists!")
+            time.sleep(5)  
+        get_logger().info('Done')
+
 
 class IssueLevel(str, Enum):
     ISSUE = "issue"

pr_agent/tools/pr_update_changelog.py

@@ -1,11 +1,13 @@
 import copy
 from datetime import date
+from functools import partial
 from time import sleep
 from typing import Tuple
 
 from jinja2 import Environment, StrictUndefined
 
-from pr_agent.algo.ai_handler import AiHandler
+from pr_agent.algo.ai_handlers.base_ai_handler import BaseAiHandler
+from pr_agent.algo.ai_handlers.litellm_ai_handler import LiteLLMAIHandler
 from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
 from pr_agent.algo.token_handler import TokenHandler
 from pr_agent.config_loader import get_settings
@@ -17,7 +19,7 @@ CHANGELOG_LINES = 50
 
 
 class PRUpdateChangelog:
-    def __init__(self, pr_url: str, cli_mode=False, args=None):
+    def __init__(self, pr_url: str, cli_mode=False, args=None, ai_handler: partial[BaseAiHandler,] = LiteLLMAIHandler):
 
         self.git_provider = get_git_provider()(pr_url)
         self.main_language = get_main_pr_language(
@@ -25,7 +27,7 @@ class PRUpdateChangelog:
         )
         self.commit_changelog = get_settings().pr_update_changelog.push_changelog_changes
         self._get_changlog_file()  # self.changelog_file_str
-        self.ai_handler = AiHandler()
+        self.ai_handler = ai_handler()
         self.patches_diff = None
         self.prediction = None
         self.cli_mode = cli_mode

pyproject.toml

@@ -17,7 +17,7 @@ maintainers = [
 ]
 description = "CodiumAI PR-Agent is an open-source tool to automatically analyze a pull request and provide several types of feedback"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 keywords = ["ai", "tool", "developer", "review", "agent"]
 license = {file = "LICENSE", name = "Apache 2.0 License"}
 classifiers = [

requirements.txt

@@ -14,6 +14,7 @@ msrest==0.7.1
 openai==0.27.8
 pinecone-client
 pinecone-datasets @ git+https://github.com/mrT23/pinecone-datasets.git@main
+lancedb==0.3.4
 pytest==7.4.0
 PyGithub==1.59.*
 PyYAML==6.0.1
@@ -23,3 +24,4 @@ starlette-context==0.3.6
 tiktoken==0.5.2
 ujson==5.8.0
 uvicorn==0.22.0
+# langchain==0.0.349 # uncomment this to support language LangChainOpenAIHandler

tests/unittest/test_convert_to_markdown.py

@@ -71,7 +71,7 @@ class TestConvertToMarkdown:
 - 📌 **Type of PR:** Test type\n\
 - 🧪 **Relevant tests added:** no\n\
 - ✨ **Focused PR:** Yes\n\
--  **General PR suggestions:** general suggestion...\n\n\n- <details><summary> 🤖 Code feedback:</summary>\n\n  - **Code example:**\n    - **Before:**\n        ```\n        Code before\n        ```\n    - **After:**\n        ```\n        Code after\n        ```\n\n  - **Code example:**\n    - **Before:**\n        ```\n        Code before 2\n        ```\n    - **After:**\n        ```\n        Code after 2\n        ```\n\n</details>\
+-  **General PR suggestions:** general suggestion...\n\n\n<details><summary> <strong>🤖 Code feedback:</strong></summary>  - **Code example:**\n    - **Before:**\n        ```\n        Code before\n        ```\n    - **After:**\n        ```\n        Code after\n        ```\n\n  - **Code example:**\n    - **Before:**\n        ```\n        Code before 2\n        ```\n    - **After:**\n        ```\n        Code after 2\n        ```\n\n</details>\
 """
         assert convert_to_markdown(input_data).strip() == expected_output.strip()
 

tests/unittest/test_try_fix_yaml.py

@@ -19,6 +19,19 @@ class TestTryFixYaml:
         expected_output = {"relevant line": "value: 3"}
         assert try_fix_yaml(review_text) == expected_output
 
+    # The function extracts YAML snippet
+    def test_extract_snippet(self):
+        review_text = '''\
+Here is the answer in YAML format:
+
+```yaml
+name: John Smith
+age: 35
+```
+'''
+        expected_output = {'name': 'John Smith', 'age': 35}
+        assert try_fix_yaml(review_text) == expected_output
+
     # The function removes the last line(s) of the YAML string and successfully parses the YAML string.
     def test_remove_last_line(self):
         review_text = "key: value\nextra invalid line\n"