Skip to content
Open
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
16 changes: 12 additions & 4 deletions Sources/AnyLanguageModel/Models/OpenAILanguageModel.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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] = []
Expand Down
6 changes: 6 additions & 0 deletions Tests/AnyLanguageModelTests/OpenAILanguageModelTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down