@ai-sdk/harness 1.0.72 → 1.0.74

package/src/agent/harness-agent.ts

@@ -2,7 +2,9 @@ import { HarnessCapabilityUnsupportedError } from '../errors/harness-capability-
 import type {
   HarnessV1Bootstrap,
   HarnessV1BuiltinToolFiltering,
+  HarnessV1JSONSchema,
   HarnessV1NetworkSandboxSession,
+  HarnessV1ResponseFormat,
   HarnessV1SandboxProvider,
 } from '../v1';
 import {
@@ -18,6 +20,7 @@ import type {
   AgentCallParameters,
   AgentStreamParameters,
   GenerateTextResult,
+  OutputInterface as Output,
   ReasoningFileOutput,
   ReasoningOutput,
   StopCondition,
@@ -118,11 +121,12 @@ export class HarnessAgent<
   THarness extends HarnessAgentAdapter<any> = HarnessAgentAdapter,
   TUserTools extends ToolSet = {},
   RUNTIME_CONTEXT extends Context = Context,
+  OUTPUT extends Output = never,
 > implements Agent<
   never,
   HarnessAllTools<THarness, TUserTools>,
   RUNTIME_CONTEXT,
-  never
+  OUTPUT
 > {
   readonly version = 'agent-v1' as const;
   readonly id: string | undefined;
@@ -138,7 +142,8 @@ export class HarnessAgent<
   private readonly settings: HarnessAgentSettings<
     THarness,
     TUserTools,
-    RUNTIME_CONTEXT
+    RUNTIME_CONTEXT,
+    OUTPUT
   >;
   private readonly stopConditions: Array<
     StopCondition<HarnessAllTools<THarness, TUserTools>, RUNTIME_CONTEXT>
@@ -151,7 +156,12 @@ export class HarnessAgent<
   private readonly permissionMode: HarnessAgentPermissionMode;
 
   constructor(
-    settings: HarnessAgentSettings<THarness, TUserTools, RUNTIME_CONTEXT>,
+    settings: HarnessAgentSettings<
+      THarness,
+      TUserTools,
+      RUNTIME_CONTEXT,
+      OUTPUT
+    >,
   ) {
     const sandboxConfig = resolveSandboxConfig(settings);
     validateSandboxBootstrapSettings(sandboxConfig);
@@ -400,16 +410,18 @@ export class HarnessAgent<
     GenerateTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >
   > {
     const turnInput = this._resolveTurnInput(options);
     const runtimeContext = {} as RUNTIME_CONTEXT;
+    const responseFormat = await this._resolveResponseFormat();
     const { result, done } = this._startTurn({
       session: options.session,
       turnInput,
       runtimeContext,
       abortSignal: options.abortSignal,
+      responseFormat,
     });
     await done;
     return this._toGenerateResult(result);
@@ -426,16 +438,18 @@ export class HarnessAgent<
     StreamTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >
   > {
     const turnInput = this._resolveTurnInput(options);
     const runtimeContext = {} as RUNTIME_CONTEXT;
+    const responseFormat = await this._resolveResponseFormat();
     const { result } = this._startTurn({
       session: options.session,
       turnInput,
       runtimeContext,
       abortSignal: options.abortSignal,
+      responseFormat,
     });
     return result;
   }
@@ -454,10 +468,11 @@ export class HarnessAgent<
     GenerateTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >
   > {
     const runtimeContext = {} as RUNTIME_CONTEXT;
+    const responseFormat = await this._resolveResponseFormat();
 
     const { result, done } = this._startTurn({
       session: options.session,
@@ -468,6 +483,7 @@ export class HarnessAgent<
       },
       runtimeContext,
       abortSignal: options.abortSignal,
+      responseFormat,
     });
     await done;
     return this._toGenerateResult(result);
@@ -490,10 +506,11 @@ export class HarnessAgent<
     StreamTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >
   > {
     const runtimeContext = {} as RUNTIME_CONTEXT;
+    const responseFormat = await this._resolveResponseFormat();
 
     const { result } = this._startTurn({
       session: options.session,
@@ -504,6 +521,7 @@ export class HarnessAgent<
       },
       runtimeContext,
       abortSignal: options.abortSignal,
+      responseFormat,
     });
     return result;
   }
@@ -521,18 +539,20 @@ export class HarnessAgent<
         };
     runtimeContext: RUNTIME_CONTEXT;
     abortSignal: AbortSignal | undefined;
+    responseFormat: HarnessV1ResponseFormat | undefined;
   }): {
     result: StreamTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >;
     done: Promise<void>;
   } {
     if (input.turnInput.mode === 'continue') {
       return input.session.continueTurn<
         HarnessAllTools<THarness, TUserTools>,
-        RUNTIME_CONTEXT
+        RUNTIME_CONTEXT,
+        OUTPUT
       >({
         instructions: this.settings.instructions,
         tools: this.tools,
@@ -541,6 +561,8 @@ export class HarnessAgent<
         builtinToolFiltering: this.builtinToolFiltering,
         runtimeContext: input.runtimeContext,
         abortSignal: input.abortSignal,
+        responseFormat: input.responseFormat,
+        output: this.settings.output,
         telemetry: this.settings.telemetry,
         stopConditions: this.stopConditions,
         toolApprovalContinuations: input.turnInput.toolApprovalContinuations,
@@ -550,7 +572,8 @@ export class HarnessAgent<
 
     return input.session.promptTurn<
       HarnessAllTools<THarness, TUserTools>,
-      RUNTIME_CONTEXT
+      RUNTIME_CONTEXT,
+      OUTPUT
     >({
       prompt: input.turnInput.prompt,
       instructions: this.settings.instructions,
@@ -560,6 +583,8 @@ export class HarnessAgent<
       builtinToolFiltering: this.builtinToolFiltering,
       runtimeContext: input.runtimeContext,
       abortSignal: input.abortSignal,
+      responseFormat: input.responseFormat,
+      output: this.settings.output,
       telemetry: this.settings.telemetry,
       stopConditions: this.stopConditions,
     });
@@ -677,28 +702,51 @@ export class HarnessAgent<
     streamResult: StreamTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >,
   ): Promise<
     GenerateTextResult<
       HarnessAllTools<THarness, TUserTools>,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >
   > {
     // The stream is already drained by the time generate() calls this helper
     // (done has resolved). `steps` is the single source of truth the result
     // derives everything else from, mirroring core's `generateText` result.
-    const [steps, usage, responseMessages] = await Promise.all([
+    const [steps, usage, responseMessages, output] = await Promise.all([
       streamResult.steps,
       streamResult.usage,
       streamResult.responseMessages,
+      this.settings.output == null
+        ? Promise.resolve(undefined as never)
+        : streamResult.output,
     ]);
 
     return new HarnessGenerateTextResult<
       HarnessAllTools<THarness, TUserTools>,
-      RUNTIME_CONTEXT
-    >({ steps, usage, responseMessages });
+      RUNTIME_CONTEXT,
+      OUTPUT
+    >({ steps, usage, responseMessages, output });
+  }
+
+  private async _resolveResponseFormat(): Promise<
+    HarnessV1ResponseFormat | undefined
+  > {
+    const responseFormat = await this.settings.output?.responseFormat;
+    if (responseFormat == null || responseFormat.type === 'text') {
+      return responseFormat == null ? undefined : { type: 'text' };
+    }
+    return {
+      type: 'json',
+      ...(responseFormat.schema == null
+        ? {}
+        : { schema: responseFormat.schema as HarnessV1JSONSchema }),
+      ...(responseFormat.name == null ? {} : { name: responseFormat.name }),
+      ...(responseFormat.description == null
+        ? {}
+        : { description: responseFormat.description }),
+    };
   }
 }
 
@@ -713,28 +761,31 @@ export class HarnessAgent<
 class HarnessGenerateTextResult<
   TOOLS extends ToolSet,
   RUNTIME_CONTEXT extends Context,
-> implements GenerateTextResult<TOOLS, RUNTIME_CONTEXT, never> {
-  readonly steps: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, never>['steps'];
-  readonly usage: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, never>['usage'];
+  OUTPUT extends Output,
+> implements GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT> {
+  readonly steps: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT>['steps'];
+  readonly usage: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT>['usage'];
   readonly responseMessages: GenerateTextResult<
     TOOLS,
     RUNTIME_CONTEXT,
-    never
+    OUTPUT
   >['responseMessages'];
-  readonly output = undefined as never;
+  readonly output: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT>['output'];
 
   constructor(options: {
-    steps: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, never>['steps'];
-    usage: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, never>['usage'];
+    steps: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT>['steps'];
+    usage: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT>['usage'];
     responseMessages: GenerateTextResult<
       TOOLS,
       RUNTIME_CONTEXT,
-      never
+      OUTPUT
     >['responseMessages'];
+    output: GenerateTextResult<TOOLS, RUNTIME_CONTEXT, OUTPUT>['output'];
   }) {
     this.steps = options.steps;
     this.usage = options.usage;
     this.responseMessages = options.responseMessages;
+    this.output = options.output;
   }
 
   get finalStep() {