Fix #117 workflowName, groupId, traceMetadata passed to Runner are not set (#121)

Author: seratch

.changeset/swift-eyes-heal.md

@@ -0,0 +1,5 @@
+---
+'@openai/agents-core': patch
+---
+
+Fix #117 by adding groupId, metadata to trace data

examples/basic/index.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { Agent, run, tool } from '@openai/agents';
+import { Agent, Runner, tool } from '@openai/agents';
 
 const getWeatherTool = tool({
   name: 'get_weather',
@@ -24,7 +24,14 @@ const agent = new Agent({
 });
 
 async function main() {
-  const result = await run(agent, 'What is the weather in San Francisco?');
+  const runner = new Runner({
+    groupId: 'My group',
+    traceMetadata: { user_id: '123' },
+  });
+  const result = await runner.run(
+    agent,
+    'What is the weather in San Francisco?',
+  );
 
   console.log(result.finalOutput);
 }

packages/agents-core/src/run.ts

@@ -127,7 +127,7 @@ export type RunConfig = {
   /**
    * An optional dictionary of additional metadata to include with the trace.
    */
-  traceMetadata?: Record<string, any>;
+  traceMetadata?: Record<string, string>;
 };
 
 type SharedRunOptions<TContext = undefined> = {
@@ -956,13 +956,21 @@ export class Runner extends RunHooks<any, AgentOutputType<unknown>> {
       });
     }
 
-    return getOrCreateTrace(async () => {
-      if (options?.stream) {
-        return this.#runIndividualStream(agent, input, options);
-      } else {
-        return this.#runIndividualNonStream(agent, input, options);
-      }
-    });
+    return getOrCreateTrace(
+      async () => {
+        if (options?.stream) {
+          return this.#runIndividualStream(agent, input, options);
+        } else {
+          return this.#runIndividualNonStream(agent, input, options);
+        }
+      },
+      {
+        traceId: this.config.traceId,
+        name: this.config.workflowName,
+        groupId: this.config.groupId,
+        metadata: this.config.traceMetadata,
+      },
+    );
   }
 }