Skip to content

Similar issues

Overview

The similar issue tool retrieves the most similar issues to the current issue. It can be invoked manually by commenting on any PR:

/similar_issue

Example usage

similar_issue_original_issue

similar_issue_comment

similar_issue

Note that to perform retrieval, the similar_issue tool indexes all the repo previous issues (once).

Selecting a Vector Database

Configure your preferred database by changing the pr_similar_issue parameter in configuration.toml file.

Available Options

Choose from the following Vector Databases:

  1. LanceDB
  2. Pinecone
  3. Qdrant

Pinecone Configuration

To use Pinecone with the similar issue tool, add these credentials to .secrets.toml (or set as environment variables):

[pinecone]
api_key = "..."
environment = "..."

These parameters can be obtained by registering to Pinecone.

Qdrant Configuration

To use Qdrant with the similar issue tool, add these credentials to .secrets.toml (or set as environment variables):

[qdrant]
url = "https://YOUR-QDRANT-URL" # e.g., https://xxxxxxxx-xxxxxxxx.eu-central-1-0.aws.cloud.qdrant.io
api_key = "..."

Then select Qdrant in configuration.toml:

[pr_similar_issue]
vectordb = "qdrant"

You can get a free managed Qdrant instance from Qdrant Cloud.

How to use

  • To invoke the 'similar issue' tool from CLI, run: python3 cli.py --issue_url=... similar_issue

  • To invoke the 'similar' issue tool via online usage, comment on a PR: /similar_issue

  • You can also enable the 'similar issue' tool to run automatically when a new issue is opened, by adding it to the pr_commands list in the github_app section

Footer