agent-lattice 0.9.14 → 0.9.16

package/README.md

@@ -56,6 +56,44 @@ Pass `{ stream: false }` to disable model streaming for a query:
 const result = await agent.prompt("Say hello", { stream: false });
 ```
 
+Pass `outputFormat` when you want the model to produce JSON matching a schema:
+
+```ts
+const jsonResult = await agent.prompt("Return JSON only.", {
+  outputFormat: "json",
+});
+
+const result = await agent.prompt("Return the answer to 2 + 2.", {
+  outputFormat: {
+    type: "json_schema",
+    schema: {
+      type: "object",
+      properties: {
+        answer: { type: "number" },
+      },
+      required: ["answer"],
+      additionalProperties: false,
+    },
+  },
+});
+```
+
+When `outputFormat` is set, the SDK verifies that the final answer is a pure
+JSON value. If a compatible provider ignores structured output parameters and
+returns Markdown or prose, the run finishes with an error result.
+
+For GLM/ZAI-compatible providers, use `structuredOutputMode: "json_object"` if
+your `baseURL` is a custom proxy that auto-detection cannot recognize:
+
+```ts
+const agent = createAgent({
+  apiKey: process.env.ZAI_API_KEY,
+  baseURL: "https://api.bigmodel.cn/anthropic",
+  model: "glm-5.2",
+  structuredOutputMode: "json_object",
+});
+```
+
 ## Multimodal Input
 
 Pass Anthropic-compatible content blocks for image or document prompts:

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { DocumentBlockParam, ImageBlockParam, TextBlockParam } from "@anthropic-ai/sdk/resources/messages.mjs";
+import type { BetaJSONOutputFormat } from "@anthropic-ai/sdk/resources/beta/messages/messages.mjs";
 import type { OAuthClientProvider } from "@modelcontextprotocol/sdk/client/auth.js";
 import { type StdioServerParameters } from "@modelcontextprotocol/sdk/client/stdio.js";
 import { type StreamableHTTPClientTransportOptions } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
@@ -149,6 +150,7 @@ export type ModelRequest = {
     messages: ModelMessage[];
     tools: ModelToolDefinition[];
     stream: boolean;
+    outputFormat?: OutputFormat;
     onStreamEvent?: (event: Record<string, unknown>) => void;
     signal?: AbortSignal;
 };
@@ -355,6 +357,7 @@ export type AgentWorkspaceOptions = string | {
 export type AgentOptions<TContext = unknown> = {
     apiKey?: string;
     baseURL?: string;
+    structuredOutputMode?: StructuredOutputMode;
     name?: string;
     model: string;
     systemPrompt?: string;
@@ -375,12 +378,15 @@ export type AgentWorkspaceToolsOptions = {
 };
 export type QueryOptions<TContext = unknown> = {
     stream?: boolean;
+    outputFormat?: OutputFormat;
     signal?: AbortSignal;
     context?: TContext;
     agentRuntime?: AgentRuntimeContext;
     permissions?: RuntimePermissions;
     tracer?: ContextTracer;
 };
+export type OutputFormat = "json" | BetaJSONOutputFormat;
+export type StructuredOutputMode = "auto" | "anthropic" | "json_object";
 export type SDKSystemInitMessage = {
     type: "system";
     subtype: "init";
@@ -453,6 +459,8 @@ export declare class MaxTurnsError extends AgentSDKError {
 }
 export declare class AbortError extends AgentSDKError {
 }
+export declare class StructuredOutputError extends AgentSDKError {
+}
 export declare class ToolPermissionDeniedError extends AgentSDKError {
     readonly denial: PermissionDenial;
     constructor(denial: PermissionDenial);
@@ -512,6 +520,7 @@ export declare function createAgentWorkspaceTools(options?: AgentWorkspaceToolsO
 export declare function query<TContext = unknown>(params: AgentOptions<TContext> & {
     prompt: string;
     stream?: boolean;
+    outputFormat?: OutputFormat;
     signal?: AbortSignal;
     context?: TContext;
 }): AsyncGenerator<SDKMessage>;