Support structured outputs (JSON schema) per message, passed through to provider
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 38/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- java, typescript
调研方向
从 sendMessage 或等效 API 开始,跟踪每条消息的选项如何传递到 OpenAI 和 Anthropic provider 的请求中。然后继续跟踪 assistant-message 完成和流式处理路径,以及 preToolUse hook 和 raw-HTTP 拦截器。完成的标准是 responseFormat 得以保留、structuredOutput 暴露在 assistant message 上、不支持的 provider 报告清晰的错误,并且涵盖列出的验收标准。
由索引模型根据 Issue 内容生成。
描述
Summary
The Copilot SDK should expose first-class support for structured outputs (JSON schema–constrained responses) when targeting model providers that natively support the feature — OpenAI (response_format: { type: "json_schema", ... }) and Anthropic (structured output / tool-schema). The schema must be settable per message and passed through unchanged to the provider.
Motivation
The primary use case is deterministic agent flows that operate on the output of Copilot Studio agents.
In Copilot Studio, an agent turn is frequently a step inside a larger orchestrated agent flow — its output is not just rendered to a user, it's fed into:
- Agent flows that expect specific fields in the output
- Routing/branching logic that switches on a category, intent, or decision
These consumers require stable, schema-validated JSON from the agent turn. Today the SDK only emits free-form assistant text, which forces every agent flow to either:
- Post-parse model prose with regex / JSON-extraction heuristics — brittle and silently breaks when the model rephrases.
- Coerce JSON via a fake single-tool tool-call — adds a round-trip per turn, pollutes tool-use telemetry, and confuses
preToolUsehooks and authoring UX. - Rewrite the outgoing HTTP body in an LLM interceptor to inject
response_format— fights the SDK's own retry/streaming logic and is unsupported.
Both OpenAI and Anthropic already accept a JSON schema directly on the request. The SDK is the only layer blocking Copilot Studio from getting deterministic agent output end-to-end.
Proposed API
Structured output must be per message, because different turns in an agent flow need different schemas (classify → plan → extract → summarize).
await session.sendMessage({
content: "Classify this support ticket.",
responseFormat: {
type: "json_schema",
schema: {
name: "TicketClassification",
strict: true,
schema: {
type: "object",
properties: {
category: { type: "string", enum: ["billing", "technical", "other"] },
priority: { type: "string", enum: ["low", "medium", "high"] },
summary: { type: "string" }
},
required: ["category", "priority", "summary"],
additionalProperties: false
}
}
}
});
Requirements
- Per-message setting —
responseFormataccepted onsendMessage/ equivalent. Optional; absent ⇒ current behavior. - Schema passthrough — Forwarded verbatim to the provider request:
- OpenAI BYOM:
response_format: { type: "json_schema", json_schema: <schema> } - Anthropic BYOM: equivalent structured output / tool-schema mechanism
- OpenAI BYOM:
- Typed result on the assistant message — Parsed JSON exposed on the resulting message (e.g.,
message.structuredOutput) so agent flows can bind to fields without re-parsing. - Streaming compatible — Final structured payload available on turn completion.
- Hook/interceptor friendly —
preToolUsehooks and raw-HTTP interceptors observe the schema in the outgoing body unchanged. - Provider capability check — Clear error if the target provider does not support structured output (rather than silently dropping the field).
Non-goals
- Inventing a new schema dialect — accept JSON Schema as the providers do.
- Cross-provider schema translation beyond what each provider natively accepts.
Acceptance criteria
-
responseFormat(JSON schema) accepted on per-message send APIs - Forwarded verbatim to OpenAI and Anthropic provider requests
- Sructured payload exposed on the resulting assistant message
- Works with streaming and with existing hook/interceptor surfaces
- Clear error when targeting a provider that doesn't support it
References
- OpenAI Structured Outputs: https://platform.openai.com/docs/guides/structured-outputs
- Anthropic structured output / tool schemas: https://docs.anthropic.com/en/docs/build-with-claude/tool-use
- 主要语言
- Java
- 星标
- 10.5k
- 派生
- 1.5k
- 平均合并
- 1 天 9 小时
- 30 天内合并 PR
- 130
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
github/copilot-sdk 的其他 Issue
-
agentic-workflows
难度 2/5 1-3 小时 新手友好度 65/100
github/copilot-sdk#2760 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
github/copilot-sdk#2759 ·
-
documentation
难度 1/5 1 小时以内 新手友好度 85/100
github/copilot-sdk#2758 ·
-
agentic-workflows
难度 2/5 1-3 小时 新手友好度 68/100
github/copilot-sdk#2709 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 78/100
github/copilot-sdk#2673 ·
查看 github/copilot-sdk 的全部 Issue
相似的 Issue
-
certification
难度 1/5 1 小时以内 新手友好度 80/100
-
难度 2/5 1-3 小时 新手友好度 75/100
-
[BUG] ECR GetAuthorizationToken returns a proxyEndpoint for the default region, not the request's 未关闭bug ecr
难度 2/5 1-3 小时 新手友好度 75/100
-
Needs: Triage Type: Feature request
难度 2/5 1-3 小时 新手友好度 70/100
AntennaPod/AntennaPod#8794 ·
-
awaiting triage bug Causes friction Hop Gui P1 P2 Transforms
难度 2/5 1-3 小时 新手友好度 75/100