Find method invocations that resemble a pattern
io.moderne.ai.research.FindCodeThatResembles
This recipe uses two phase AI approach to find a method invocation that resembles a search string.
Recipe source
This recipe is only available to users of Moderne.
Options
| Type | Name | Description | Example |
|---|---|---|---|
String | resembles | The text, either a natural language description or a code sample, that you are looking for. | HTTP request with Content-Type application/json |
int | k | Since AI based matching has a higher latency than rules based matching, we do a first pass to find the top k methods using embeddings. To narrow the scope, you can specify the top k methods as method filters. | 5 |
License
This recipe is available under the Moderne Proprietary License.
Usage
This recipe has required configuration parameters and can only be run by users of Moderne.
To run this recipe, you will need to provide the Moderne CLI run command with the required options.
Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.FindCodeThatResemblesExample
displayName: Find method invocations that resemble a pattern example
recipeList:
- io.moderne.ai.research.FindCodeThatResembles:
resembles: HTTP request with Content-Type application/json
k: 5
- Moderne CLI
You will need to have configured the Moderne CLI on your machine before you can run the following command.
mod run . --recipe FindCodeThatResembles --recipe-option "resembles=HTTP request with Content-Type application/json" --recipe-option "k=5"
If the recipe is not available locally, then you can install it using:
mod config recipes jar install org.openrewrite.recipe:rewrite-ai-search:0.21.0
See how this recipe works across multiple open-source repositories
Run this recipe on OSS repos at scale with the Moderne SaaS.
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.
Data Tables
Code Search
io.moderne.ai.table.CodeSearch
Searches for method invocations that resemble a natural language query.
| Column Name | Description |
|---|---|
| Source | Source |
| Method | Method invocation |
| Query | Natural language query |
| Result of first models | First two embeddings models result, where -1 means negative match, 0 means unsure, and 1 means positive match. |
| Called second model | True if the generative model was used. |
| Result of second model | Second generative model's result. |
Top-K Method Matcher
io.moderne.ai.table.TopKMethodMatcher
Result from the scanning recipe for top-k method patterns that match the query.
| Column Name | Description |
|---|---|
| Method Pattern | Method invocation pattern. |
| Method Signature | Method invocation signature. |
| Distance | The distance between the query and the method invocation. |
| Query | The natural language search query. |
Embedding performance
io.moderne.ai.table.EmbeddingPerformance
Latency characteristics of uses of embedding models.
| Column Name | Description |
|---|---|
| Source file | The source file that the method call occurred in. |
| Number of requests | The count of requests made to the model. |
| Histogram | The latency histogram of the requests made to the model (counts). The histogram is a non-cumulative fixed distribution of 100 buckets of 0.01 second each. |
| Max latency | The maximum embedding latency. |
Generative model performance
io.moderne.ai.table.GenerativeModelPerformance
Latency characteristics of uses of generative models.
| Column Name | Description |
|---|---|
| Source file | The source file that the method call occurred in. |
| Number of requests | The count of requests made to the model. |
| Histogram | The latency histogram of the requests made to the model (counts). The histogram is a non-cumulative fixed distribution of 100 buckets of 1 second each. |
| Max latency | The maximum embedding latency. |
Suggested method patterns
io.moderne.ai.table.SuggestedMethodPatterns
As the next step after the AI-based searching for method invocations, you may want to do rule-based method searching using the recommended method patterns.
| Column Name | Description |
|---|---|
| Method | Method invocation |
| Method Pattern | Method invocation pattern. |
| Query | The natural language search query. |
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
| Column Name | Description |
|---|---|
| Source path before the run | The source path of the file before the run. null when a source file was created during the run. |
| Source path after the run | A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run. |
| Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
| Recipe that made changes | The specific recipe that made a change. |
| Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
| Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
| Column Name | Description |
|---|---|
| Source path | The file that failed to parse. |
| Recipe that made changes | The specific recipe that made a change. |
| Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
| Column Name | Description |
|---|---|
| The recipe | The recipe whose stats are being measured both individually and cumulatively. |
| Source file count | The number of source files the recipe ran over. |
| Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
| Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
| 99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
| Max scanning time | The max time scanning any one source file. |
| Cumulative edit time | The total time spent across the editing phase of this recipe. |
| 99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
| Max edit time | The max time editing any one source file. |