feat(js): allow naming generates

bin/check_license

@@ -61,6 +61,8 @@ $HOME/go/bin/addlicense \
   -ignore '**/pnpm-lock.yaml' \
   -ignore '.nx/**/*' \
   -ignore '.trunk/**/*' \
+  -ignore '**/*.toml' \
+  -ignore '**/*.nix' \
   "$TOP_DIR"
 
 uv run --directory "${PY_DIR}" liccheck

genkit-tools/common/src/types/model.ts

@@ -403,5 +403,7 @@ export const GenerateActionOptionsSchema = z.object({
   returnToolRequests: z.boolean().optional(),
   /** Maximum number of tool call iterations that can be performed in a single generate call (default 5). */
   maxTurns: z.number().optional(),
+  /** Custom step name for this generate call to display in trace views. Defaults to "generate". */
+  stepName: z.string().optional(),
 });
 export type GenerateActionOptions = z.infer<typeof GenerateActionOptionsSchema>;

genkit-tools/genkit-schema.json

@@ -735,6 +735,9 @@
         },
         "maxTurns": {
           "type": "number"
+        },
+        "stepName": {
+          "type": "string"
         }
       },
       "required": [

js/ai/src/generate.ts

@@ -170,6 +170,8 @@ export interface GenerateOptions<
   context?: ActionContext;
   /** Abort signal for the generate request. */
   abortSignal?: AbortSignal;
+  /** Custom step name for this generate call to display in trace views. Defaults to "generate". */
+  stepName?: string;
   /**
    * Additional metadata describing the GenerateOptions, used by tooling. If
    * this is an instance of a rendered dotprompt, will contain any prompt
@@ -500,6 +502,7 @@ export async function toGenerateActionOptions<
     },
     returnToolRequests: options.returnToolRequests,
     maxTurns: options.maxTurns,
+    stepName: options.stepName,
   };
   // if config is empty and it was not explicitly passed in, we delete it, don't want {}
   if (Object.keys(params.config).length === 0 && !options.config) {

js/ai/src/generate/action.ts

@@ -123,14 +123,14 @@ export async function generateHelper(
     registry,
     {
       metadata: {
-        name: 'generate',
+        name: options.rawRequest.stepName || 'generate',
       },
       labels: {
         [SPAN_TYPE_ATTR]: 'util',
       },
     },
     async (metadata) => {
-      metadata.name = 'generate';
+      metadata.name = options.rawRequest.stepName || 'generate';
       metadata.input = options.rawRequest;
       const output = await generate(registry, {
         rawRequest: options.rawRequest,

js/ai/src/model-types.ts

@@ -406,5 +406,7 @@ export const GenerateActionOptionsSchema = z.object({
   returnToolRequests: z.boolean().optional(),
   /** Maximum number of tool call iterations that can be performed in a single generate call (default 5). */
   maxTurns: z.number().optional(),
+  /** Custom step name for this generate call to display in trace views. Defaults to "generate". */
+  stepName: z.string().optional(),
 });
 export type GenerateActionOptions = z.infer<typeof GenerateActionOptionsSchema>;

js/ai/tests/generate/generate_test.ts

@@ -571,4 +571,27 @@ describe('generate', () => {
       );
     });
   });
+
+  it('should use custom stepName parameter in tracing', async () => {
+    const response = await generate(registry, {
+      model: 'echo',
+      prompt: 'Testing custom step name',
+      stepName: 'test-generate-custom',
+    });
+    assert.deepEqual(
+      response.messages.map((m) => m.content[0].text),
+      ['Testing custom step name', 'Testing custom step name']
+    );
+  });
+
+  it('should default to "generate" name when no stepName is provided', async () => {
+    const response = await generate(registry, {
+      model: 'echo',
+      prompt: 'Testing default step name',
+    });
+    assert.deepEqual(
+      response.messages.map((m) => m.content[0].text),
+      ['Testing default step name', 'Testing default step name']
+    );
+  });
 });

js/testapps/basic-gemini/src/index.ts

@@ -40,6 +40,7 @@ export const jokeFlow = ai.defineFlow(
   },
   async () => {
     const llmResponse = await ai.generate({
+      stepName: 'joke-creator',
       model: gemini15Flash,
       config: {
         temperature: 2,

py/packages/genkit/src/genkit/core/typing.py

@@ -920,6 +920,7 @@ class GenerateActionOptions(BaseModel):
     resume: Resume | None = None
     return_tool_requests: bool | None = Field(None, alias='returnToolRequests')
     max_turns: float | None = Field(None, alias='maxTurns')
+    step_name: str | None = Field(None, alias='stepName')
 
 
 class GenerateRequest(BaseModel):

py/plugins/compat-oai/src/genkit/plugins/compat_oai/openai_plugin.py

@@ -16,6 +16,7 @@
 
 
 """OpenAI OpenAI API Compatible Plugin for Genkit."""
+
 from functools import cached_property
 from typing import Any, Callable
 
@@ -172,17 +173,17 @@ def _define_openai_model(self, ai: GenkitRegistry, name: str) -> None:
     def list_actions(self) -> list[ActionMetadata]:
         """Generate a list of available actions or models.
 
-                Returns:
-                    list[ActionMetadata]: A list of ActionMetadata objects, each with the following attributes:
-                        - name (str): The name of the action or model.
-                        - kind (ActionKind): The type or category of the action.
-                        - info (dict): The metadata dictionary describing the model configuration and properties.
-                        - config_schema (type): The schema class used for validating the model's configuration.
+        Returns:
+            list[ActionMetadata]: A list of ActionMetadata objects, each with the following attributes:
+                - name (str): The name of the action or model.
+                - kind (ActionKind): The type or category of the action.
+                - info (dict): The metadata dictionary describing the model configuration and properties.
+                - config_schema (type): The schema class used for validating the model's configuration.
         """
 
         actions = []
         models_ = self._openai_client.models.list()
-        models: list[Model]  = models_.data
+        models: list[Model] = models_.data
         # Print each model
         for model in models:
             _name = model.id
@@ -216,8 +217,6 @@ def list_actions(self) -> list[ActionMetadata]:
         return actions
 
 
-
-
 def openai_model(name: str) -> str:
     """Returns a string representing the OpenAI model name to use with Genkit.
 

py/plugins/compat-oai/tests/test_plugin.py

@@ -83,7 +83,7 @@ def test_openai_plugin_list_actions() -> None:
         Model(id='gpt-3.5-turbo', created=1677610602, object='model', owned_by='openai'),
         Model(id='o4-mini-deep-research-2025-06-26', created=1750866121, object='model', owned_by='system'),
         Model(id='codex-mini-latest', created=1746673257, object='model', owned_by='system'),
-        Model(id='text-embedding-ada-002', created=1671217299, object='model', owned_by='openai-internal')
+        Model(id='text-embedding-ada-002', created=1671217299, object='model', owned_by='openai-internal'),
     ]
     plugin = OpenAI(api_key='test-key')
     mock_client = MagicMock()
@@ -94,7 +94,7 @@ def test_openai_plugin_list_actions() -> None:
 
     plugin._openai_client = mock_client
 
-    actions: list[ActionMetadata ] = plugin.list_actions
+    actions: list[ActionMetadata] = plugin.list_actions
     mock_client.models.list.assert_called_once()
     _ = plugin.list_actions
     mock_client.models.list.assert_called_once()