From 81172441c60c0c6be10cf9afef69fb25e31e6a03 Mon Sep 17 00:00:00 2001 From: Gary Tokman Date: Wed, 18 Nov 2026 23:07:18 -0500 Subject: [PATCH] Sort request body keys so prompt caches can hit Requests were encoded with a plain JSONEncoder, so the same tools and messages came out in a different key order each time. Providers whose prompt cache matches an exact prefix (OpenAI's, Azure's) never hit: every call was billed as a cache write. Co-Authored-By: Claude Opus 5.5 --- .../Models/OpenAILanguageModel.swift | 16 ++++++++++++---- .../OpenAILanguageModelTests.swift | 6 ++++++ 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/Sources/AnyLanguageModel/Models/OpenAILanguageModel.swift b/Sources/AnyLanguageModel/Models/OpenAILanguageModel.swift index a309a804..652d5eca 100644 --- a/Sources/AnyLanguageModel/Models/OpenAILanguageModel.swift +++ b/Sources/AnyLanguageModel/Models/OpenAILanguageModel.swift @@ -29,6 +29,15 @@ public struct OpenAILanguageModel: LanguageModel, ProfileRequestIdentifiedLangua /// The default base URL for OpenAI's API. public static let defaultBaseURL = URL(string: "https://api.openai.com/v1/")! + /// A request body, its keys sorted: the same tools and messages encode to the same bytes + /// every time, so a provider's prompt cache, which matches an exact prefix (OpenAI's, Azure's), + /// can hit. Unsorted, dictionary order differs per request. + static func encodeBody(_ value: some Encodable) throws -> Data { + let encoder = JSONEncoder() + encoder.outputFormatting = .sortedKeys + return try encoder.encode(value) + } + /// The OpenAI API variant to use. public enum APIVariant: Sendable { /// When selected, use the Chat Completions API. @@ -591,7 +600,7 @@ public struct OpenAILanguageModel: LanguageModel, ProfileRequestIdentifiedLangua ) let url = baseURL.appendingPathComponent("chat/completions") - let body = try JSONEncoder().encode(params) + let body = try Self.encodeBody(params) let resp: ChatCompletions.Response = try await transport.fetch( HTTPRequest(method: .post, url: url, headerFields: buildHeaders()), body: body @@ -768,8 +777,7 @@ public struct OpenAILanguageModel: LanguageModel, ProfileRequestIdentifiedLangua stream: false ) - let encoder = JSONEncoder() - let body = try encoder.encode(params) + let body = try Self.encodeBody(params) let resp: Responses.Response = try await transport.fetch( HTTPRequest(method: .post, url: url, headerFields: buildHeaders()), body: body @@ -973,7 +981,7 @@ public struct OpenAILanguageModel: LanguageModel, ProfileRequestIdentifiedLangua includeUsage: baseURL.host == Self.defaultBaseURL.host ) } - let body = try JSONEncoder().encode(params) + let body = try Self.encodeBody(params) let url = baseURL.appendingPathComponent(path) let headers: HTTPFields = buildHeaders() var toolCalls: [OpenAIToolCall] = [] diff --git a/Tests/AnyLanguageModelTests/OpenAILanguageModelTests.swift b/Tests/AnyLanguageModelTests/OpenAILanguageModelTests.swift index e0b8552d..e0e51875 100644 --- a/Tests/AnyLanguageModelTests/OpenAILanguageModelTests.swift +++ b/Tests/AnyLanguageModelTests/OpenAILanguageModelTests.swift @@ -21,6 +21,12 @@ struct OpenAILanguageModelTests { } } + @Test func requestBodyKeysAreSorted() throws { + let value = ["zeta": 1, "alpha": 2, "mu": 3, "beta": 4, "omega": 5] + let body = try OpenAILanguageModel.encodeBody(value) + #expect(String(decoding: body, as: UTF8.self) == #"{"alpha":2,"beta":4,"mu":3,"omega":5,"zeta":1}"#) + } + @Suite("OpenAILanguageModel Chat Completions API", .enabled(if: openaiAPIKey?.isEmpty == false)) struct ChatCompletionsTests { private let apiKey = openaiAPIKey!