Get embeddings for code snippets in code

io.moderne.ai.research.GetCodeEmbedding

This recipe calls an AI model to get an embedding for either classes or methods which can then be used for downstream tasks.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-ai-search

• version: 0.14.1

Options

Type	Name	Description	Example
String	codeSnippetType	Choose whether you want to get an embedding for the classes or methods. Valid options: methods, classes	methods

Data Tables

Embeddings

Collects the embeddings for either each classes or methods.

Column Name	Description
Source	Source
Name	Name of the class or method
Embedding	The embedding for the code snippet

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.GetCodeEmbeddingExample. 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.GetCodeEmbeddingExample
displayName: Get embeddings for code snippets in code example
recipeList:
  - io.moderne.ai.research.GetCodeEmbedding:
      codeSnippetType: methods

Now that com.yourorg.GetCodeEmbeddingExample 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.GetCodeEmbeddingExample")
}

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.GetCodeEmbeddingExample</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 GetCodeEmbeddingExample

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.

Contributors

juju, Tim te Beek