Get recommendations

io.moderne.ai.research.GetRecommendations

This recipe calls an AI model to get recommendations for modernizing the code base by looking at a sample of method declarations.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-ai-search

• version: 0.14.1

Options

Type	Name	Description	Example
Boolean	randomSampling	Do random sampling or use clusters based on embeddings to sample.
int	numberOfCenters	Optional. Number of diverse centers to sample if you don't do random sampling per repository.	3

Data Tables

Recommendations

Collects the recommendations based on sampled methods.

Column Name	Description
Name	Name of the class or method
Lantency	Latency in seconds to get recommendations
Token size	Estimated token size for input and output
Recommendation	The recommendations based on the method

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.GetRecommendationsExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.GetRecommendationsExample
displayName: Get recommendations example
recipeList:
  - io.moderne.ai.research.GetRecommendations:
      randomSampling: null
      numberOfCenters: 3

Now that com.yourorg.GetRecommendationsExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-ai-search:0.14.1 in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

plugins {
    id("org.openrewrite.rewrite") version("6.16.1")
}

rewrite {
    activeRecipe("com.yourorg.GetRecommendationsExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-ai-search:0.14.1")
}

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.34.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.GetRecommendationsExample</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-ai-search</artifactId>
            <version>0.14.1</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe GetRecommendationsExample

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.