Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/ai/src/api/openai-completions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -809,7 +809,7 @@ function addCacheControlToLastConversationMessage(
): void {
for (let i = messages.length - 1; i >= 0; i--) {
const message = messages[i];
if (message.role === "user" || message.role === "assistant") {
if (message.role === "user" || message.role === "assistant" || message.role === "tool") {
if (addCacheControlToMessage(message, cacheControl)) {
return;
}
Expand Down Expand Up @@ -840,7 +840,7 @@ function addCacheControlToMessage(
message: ChatCompletionMessageParam,
cacheControl: OpenAICompatCacheControl,
): boolean {
if (message.role === "user" || message.role === "assistant") {
if (message.role === "user" || message.role === "assistant" || message.role === "tool") {
return addCacheControlToTextContent(message, cacheControl);
}
return false;
Expand All @@ -850,6 +850,7 @@ function addCacheControlToTextContent(
message:
| ChatCompletionInstructionMessageParam
| ChatCompletionAssistantMessageParam
| ChatCompletionToolMessageParam
| Extract<ChatCompletionMessageParam, { role: "user" }>,
cacheControl: OpenAICompatCacheControl,
): boolean {
Expand Down
46 changes: 44 additions & 2 deletions packages/ai/test/openai-completions-cache-control-format.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Type } from "typebox";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { stream as streamOpenAICompletions } from "../src/api/openai-completions.ts";
import { getModel } from "../src/compat.ts";
import type { Model } from "../src/types.ts";
import type { Message, Model } from "../src/types.ts";

interface CacheControl {
type: "ephemeral";
Expand Down Expand Up @@ -74,14 +74,15 @@ vi.mock("openai", () => {
async function capturePayload(
model: Model<"openai-completions">,
options?: { cacheRetention?: "none" | "short" | "long" },
messages?: Message[],
): Promise<CapturedParams> {
const timestamp = Date.now();

await streamOpenAICompletions(
model,
{
systemPrompt: "System prompt",
messages: [{ role: "user", content: "Hello", timestamp }],
messages: messages ?? [{ role: "user", content: "Hello", timestamp }],
tools: [
{
name: "read",
Expand Down Expand Up @@ -158,6 +159,47 @@ describe("openai-completions cacheControlFormat", () => {
expectAnthropicCacheMarkers(params);
});

it("moves the conversation cache marker to a tool result", async () => {
const model = getModel("openrouter", "anthropic/claude-sonnet-4");
const timestamp = Date.now();
const params = await capturePayload(model, undefined, [
{ role: "user", content: "Read the file", timestamp },
{
role: "assistant",
content: [{ type: "toolCall", id: "call_1", name: "read", arguments: { path: "README.md" } }],
api: "openai-completions",
provider: "openrouter",
model: model.id,
usage: {
input: 0,
output: 0,
cacheRead: 0,
cacheWrite: 0,
totalTokens: 0,
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0, total: 0 },
},
stopReason: "toolUse",
timestamp,
},
{
role: "toolResult",
toolCallId: "call_1",
toolName: "read",
content: [{ type: "text", text: "file contents" }],
isError: false,
timestamp,
},
]);

const userMessage = params.messages.find((message) => message.role === "user");
expect(userMessage?.content).toBe("Read the file");

const toolMessage = params.messages[params.messages.length - 1];
expect(toolMessage.role).toBe("tool");
expect(Array.isArray(toolMessage.content)).toBe(true);
expect((toolMessage.content as TextPart[])[0]?.cache_control).toEqual({ type: "ephemeral" });
});

it("omits Anthropic-style cache markers when cacheRetention is none", async () => {
const model: Model<"openai-completions"> = {
id: "custom-qwen",
Expand Down