Skip to content

Commit 299ca48

Browse files
committed
feat(ai): type OpenRouter options on the Responses route
1 parent 4d9e4de commit 299ca48

5 files changed

Lines changed: 128 additions & 22 deletions

File tree

‎packages/ai/src/providers/openrouter.ts‎

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import type { ProviderPackage } from "../provider-package.js"
88
import { SystemOne } from "../protocols/system-one.js"
99
import { OpenAIImages, type OpenAIImageSizing } from "../protocols/openai-images.js"
1010
import { MediaRoute } from "../route/media.js"
11+
import { HttpTransport } from "../route/transport/index.js"
1112
import { OpenAIChat } from "../protocols/openai-chat.js"
1213
import { OpenResponses } from "../protocols/open-responses.js"
1314
import { cacheControl } from "../protocols/utils/cache.js"
@@ -74,6 +75,9 @@ export interface OpenRouterOptions {
7475

7576
export type OpenRouterProviderOptionsInput = OpenRouterOptions
7677

78+
export type OpenRouterResponsesProviderOptionsInput = OpenResponsesProviderOptionsInput &
79+
Pick<OpenRouterOptions, "debug" | "models" | "plugins" | "provider" | "user">
80+
7781
export interface OpenRouterDecisionOptions {
7882
readonly [key: string]: unknown
7983
readonly provider?: OpenRouterProviderRouting
@@ -85,7 +89,7 @@ export interface OpenRouterDecisionOptions {
8589
export type Config = Omit<RouteDefaultsInput, "providerOptions"> &
8690
ProviderAuthOption<"optional"> & {
8791
readonly baseURL?: string
88-
readonly providerOptions?: OpenRouterProviderOptionsInput | OpenResponsesProviderOptionsInput
92+
readonly providerOptions?: OpenRouterProviderOptionsInput | OpenRouterResponsesProviderOptionsInput
8993
}
9094

9195
export type Settings<Options = OpenRouterProviderOptionsInput> = ProviderPackage.Settings &
@@ -94,14 +98,18 @@ export type Settings<Options = OpenRouterProviderOptionsInput> = ProviderPackage
9498
readonly baseURL?: string
9599
}
96100

97-
const Options = Schema.Struct({
98-
usage: lenient(Schema.Union([Schema.Boolean, JsonObject])),
101+
const SharedOptions = Schema.Struct({
99102
models: lenient(Schema.Array(Schema.String)),
100103
provider: lenient(JsonObject),
101104
plugins: lenient(Schema.Array(JsonObject)),
102-
web_search_options: lenient(JsonObject),
103105
debug: lenient(JsonObject),
104106
user: lenient(Schema.String),
107+
})
108+
109+
const Options = Schema.Struct({
110+
...SharedOptions.fields,
111+
usage: lenient(Schema.Union([Schema.Boolean, JsonObject])),
112+
web_search_options: lenient(JsonObject),
105113
reasoning: lenient(JsonObject),
106114
})
107115
const decodeOptions = Schema.decodeUnknownSync(Options)
@@ -166,12 +174,8 @@ const bodyOptions = (body: OpenAIChat.OpenAIChatBody, input: unknown, maxTokens:
166174
...options,
167175
...body,
168176
...(usage !== undefined ? { usage } : {}),
169-
...(known.models !== undefined ? { models: known.models } : {}),
170-
...(known.provider !== undefined ? { provider: known.provider } : {}),
171-
...(known.plugins !== undefined ? { plugins: known.plugins } : {}),
177+
...sharedOptions(known),
172178
...(known.web_search_options !== undefined ? { web_search_options: known.web_search_options } : {}),
173-
...(known.debug !== undefined ? { debug: known.debug } : {}),
174-
...(known.user !== undefined ? { user: known.user } : {}),
175179
...(known.reasoning !== undefined ? { reasoning: fitReasoning(known.reasoning, maxTokens) } : {}),
176180
}
177181
}
@@ -191,6 +195,32 @@ const imageSizing: OpenAIImageSizing = (request) => {
191195
}
192196
}
193197

198+
const sharedOptions = (known: typeof SharedOptions.Type) => ({
199+
...(known.models !== undefined ? { models: known.models } : {}),
200+
...(known.provider !== undefined ? { provider: known.provider } : {}),
201+
...(known.plugins !== undefined ? { plugins: known.plugins } : {}),
202+
...(known.debug !== undefined ? { debug: known.debug } : {}),
203+
...(known.user !== undefined ? { user: known.user } : {}),
204+
})
205+
206+
const OpenRouterResponsesBody = Schema.Struct({
207+
...OpenResponses.OpenResponsesBody.fields,
208+
...SharedOptions.fields,
209+
})
210+
type OpenRouterResponsesBody = Schema.Schema.Type<typeof OpenRouterResponsesBody>
211+
212+
const responsesProtocol = Protocol.make({
213+
id: "openrouter-responses",
214+
body: {
215+
schema: OpenRouterResponsesBody,
216+
from: (request) =>
217+
OpenResponses.fromRequest(request).pipe(
218+
Effect.map((body) => ({ ...body, ...sharedOptions(decodeOptions(request.providerOptions ?? {})) })),
219+
),
220+
},
221+
stream: OpenResponses.protocol.stream,
222+
})
223+
194224
export const route = Route.make({
195225
id: ADAPTER,
196226
provider: id,
@@ -204,9 +234,9 @@ const responsesRoute = Route.make({
204234
id: "openrouter-responses",
205235
provider: id,
206236
providerMetadataKey: "openrouter",
207-
protocol: OpenResponses.protocol,
237+
protocol: responsesProtocol,
208238
endpoint: Endpoint.path("/responses", { baseURL }),
209-
transport: OpenResponses.httpTransport,
239+
transport: HttpTransport.sseJson.with<OpenRouterResponsesBody>(),
210240
defaults: { providerOptions: { store: false, include: ["reasoning.encrypted_content"] } },
211241
})
212242

@@ -247,7 +277,7 @@ export const configure = (input: Config = {}) => {
247277
model: (modelID: string | ModelID) =>
248278
chatRoute.model<OpenRouterProviderOptionsInput>({ id: modelID, compatibility: { supportsPromptCacheKey: true } }),
249279
responses: (modelID: string | ModelID) =>
250-
configuredResponses.model<OpenResponsesProviderOptionsInput>({ id: modelID }),
280+
configuredResponses.model<OpenRouterResponsesProviderOptionsInput>({ id: modelID }),
251281
image,
252282
decision,
253283
configure,
@@ -261,8 +291,8 @@ export const responses = provider.responses
261291
export const model: ProviderPackage.Model<Settings, OpenRouterProviderOptionsInput> = (modelID, settings) =>
262292
configure(config(settings)).model(modelID)
263293
export const responsesModel: ProviderPackage.Model<
264-
Settings<OpenResponsesProviderOptionsInput>,
265-
OpenResponsesProviderOptionsInput
294+
Settings<OpenRouterResponsesProviderOptionsInput>,
295+
OpenRouterResponsesProviderOptionsInput
266296
> = (modelID, settings) => configure(config(settings)).responses(modelID)
267297
export const imageModel = (modelID: string, settings?: Settings) => {
268298
const input = config(settings)
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import type { OpenResponsesProviderOptionsInput } from "../open-responses-options.js"
21
import type { OpenRouter } from "../openrouter.js"
32
export { responsesModel as model } from "../openrouter.js"
4-
export type Settings = OpenRouter.Settings<OpenResponsesProviderOptionsInput>
3+
export type Settings = OpenRouter.Settings<OpenRouter.OpenRouterResponsesProviderOptionsInput>

‎packages/ai/test/provider-options/openrouter.types.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,25 @@ LLM.request({
3131
// @ts-expect-error OpenRouter usage must be boolean or an option record.
3232
providerOptions: { usage: "yes" },
3333
})
34+
35+
const responses = OpenRouter.provider.responses("openai/gpt-5.4")
36+
37+
LLM.request({
38+
model: responses,
39+
prompt: "Hello",
40+
providerOptions: {
41+
reasoningEffort: "low",
42+
models: ["openai/gpt-5.4-mini"],
43+
provider: { only: ["openai"], sort: "future-sort", data_collection: "future-policy" },
44+
plugins: [{ id: "future-plugin", enabled: true }],
45+
debug: { echo_upstream_body: true },
46+
user: "user_123",
47+
},
48+
})
49+
50+
LLM.request({
51+
model: responses,
52+
prompt: "Hello",
53+
// @ts-expect-error OpenRouter fallback models must be a list of model IDs.
54+
providerOptions: { models: "openai/gpt-5.4-mini" },
55+
})

‎packages/ai/test/provider-package.test.ts‎

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,36 @@ describe("provider package entrypoints", () => {
6060

6161
test("maps OpenRouter, DigitalOcean and Venice Responses entrypoints onto provider-owned routes", async () => {
6262
const providers = [
63-
["openrouter", "https://openrouter.ai/api/v1", await import("@opencode/ai/providers/openrouter/responses")],
64-
["digitalocean", "https://inference.do-ai.run/v1", await import("@opencode/ai/providers/digitalocean/responses")],
65-
["venice", "https://api.venice.ai/api/v1", await import("@opencode/ai/providers/venice/responses")],
63+
[
64+
"openrouter",
65+
"https://openrouter.ai/api/v1",
66+
"openrouter-responses",
67+
await import("@opencode/ai/providers/openrouter/responses"),
68+
],
69+
[
70+
"digitalocean",
71+
"https://inference.do-ai.run/v1",
72+
"open-responses",
73+
await import("@opencode/ai/providers/digitalocean/responses"),
74+
],
75+
[
76+
"venice",
77+
"https://api.venice.ai/api/v1",
78+
"open-responses",
79+
await import("@opencode/ai/providers/venice/responses"),
80+
],
6681
] as const
6782
const settings = {
6883
apiKey: "fixture",
6984
headers: { "x-test": "fixture" },
7085
body: { future_option: true },
7186
reasoningEffort: "low",
7287
}
73-
for (const [provider, baseURL, module] of providers) {
88+
for (const [provider, baseURL, protocol, module] of providers) {
7489
const selected = module.model("gpt-5.4", settings)
7590
expect(selected.provider).toBe(provider)
7691
expect(selected.route.id).toBe(`${provider}-responses`)
77-
expect(selected.route.protocol).toBe("open-responses")
92+
expect(selected.route.protocol).toBe(protocol)
7893
expect(selected.route.endpoint).toMatchObject({ baseURL, path: "/responses" })
7994
expect(selected.route.defaults.headers).toEqual(settings.headers)
8095
expect(selected.route.defaults.http?.body).toEqual(settings.body)

‎packages/ai/test/provider/openrouter.test.ts‎

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { LLMClient } from "../../src/route.js"
55
import { compileRequest } from "../../src/route/client.js"
66
import * as OpenRouter from "../../src/providers/openrouter.js"
77
import { it } from "../lib/effect.js"
8-
import { fixedResponse } from "../lib/http.js"
8+
import { dynamicResponse, fixedResponse } from "../lib/http.js"
99
import { sseEvents } from "../lib/sse.js"
1010

1111
describe("OpenRouter", () => {
@@ -391,6 +391,46 @@ describe("OpenRouter", () => {
391391
}),
392392
)
393393

394+
it.effect("sends OpenRouter routing options on the Responses route", () =>
395+
LLMClient.generate(
396+
LLM.request({
397+
model: OpenRouter.configure({
398+
apiKey: "test-key",
399+
providerOptions: {
400+
models: ["openai/gpt-5.4-mini"],
401+
provider: { only: ["openai"], allow_fallbacks: false },
402+
plugins: [{ id: "response-healing" }],
403+
debug: { echo_upstream_body: true },
404+
user: "user_123",
405+
reasoningEffort: "low",
406+
},
407+
}).responses("openai/gpt-5.4"),
408+
prompt: "Hello",
409+
}),
410+
).pipe(
411+
Effect.provide(
412+
dynamicResponse((input) =>
413+
Effect.sync(() => {
414+
expect(input.request.url).toBe("https://openrouter.ai/api/v1/responses")
415+
expect(JSON.parse(input.text)).toMatchObject({
416+
model: "openai/gpt-5.4",
417+
store: false,
418+
reasoning: { effort: "low" },
419+
models: ["openai/gpt-5.4-mini"],
420+
provider: { only: ["openai"], allow_fallbacks: false },
421+
plugins: [{ id: "response-healing" }],
422+
debug: { echo_upstream_body: true },
423+
user: "user_123",
424+
})
425+
return input.respond(sseEvents({ type: "response.completed", response: { id: "resp_1" } }), {
426+
headers: { "content-type": "text/event-stream" },
427+
})
428+
}),
429+
),
430+
),
431+
),
432+
)
433+
394434
it.effect("omits the prompt cache key when caching is disabled", () =>
395435
Effect.gen(function* () {
396436
const prepared = yield* compileRequest(

0 commit comments

Comments
 (0)