blob: e104c7f4714aef520a51a502382c3ed75ed5c0eb [file] [log] [blame]
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -07001package oai
2
3import (
4 "cmp"
5 "context"
6 "encoding/json"
7 "errors"
8 "fmt"
9 "log/slog"
10 "math/rand/v2"
11 "net/http"
Philip Zeyliger72252cb2025-05-10 17:00:08 -070012 "strings"
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070013 "time"
14
15 "github.com/sashabaranov/go-openai"
16 "sketch.dev/llm"
17)
18
19const (
20 DefaultMaxTokens = 8192
21
22 OpenAIURL = "https://api.openai.com/v1"
23 FireworksURL = "https://api.fireworks.ai/inference/v1"
24 LlamaCPPURL = "http://localhost:8080/v1"
25 TogetherURL = "https://api.together.xyz/v1"
26 GeminiURL = "https://generativelanguage.googleapis.com/v1beta/openai/"
Josh Bleecher Snyderfa667032025-05-07 14:13:27 -070027 MistralURL = "https://api.mistral.ai/v1"
Josh Bleecher Snyder2edd62e2025-07-14 12:44:51 -070028 MoonshotURL = "https://api.moonshot.ai/v1"
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070029
30 // Environment variable names for API keys
31 OpenAIAPIKeyEnv = "OPENAI_API_KEY"
32 FireworksAPIKeyEnv = "FIREWORKS_API_KEY"
33 TogetherAPIKeyEnv = "TOGETHER_API_KEY"
34 GeminiAPIKeyEnv = "GEMINI_API_KEY"
Josh Bleecher Snyderfa667032025-05-07 14:13:27 -070035 MistralAPIKeyEnv = "MISTRAL_API_KEY"
Josh Bleecher Snyder2edd62e2025-07-14 12:44:51 -070036 MoonshotAPIKeyEnv = "MOONSHOT_API_KEY"
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070037)
38
39type Model struct {
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070040 UserName string // provided by the user to identify this model (e.g. "gpt4.1")
41 ModelName string // provided to the service provide to specify which model to use (e.g. "gpt-4.1-2025-04-14")
42 URL string
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070043 APIKeyEnv string // environment variable name for the API key
44 IsReasoningModel bool // whether this model is a reasoning model (e.g. O3, O4-mini)
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070045}
46
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070047var (
48 DefaultModel = GPT41
49
50 GPT41 = Model{
51 UserName: "gpt4.1",
52 ModelName: "gpt-4.1-2025-04-14",
53 URL: OpenAIURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070054 APIKeyEnv: OpenAIAPIKeyEnv,
55 }
56
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070057 GPT4o = Model{
58 UserName: "gpt4o",
59 ModelName: "gpt-4o-2024-08-06",
60 URL: OpenAIURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070061 APIKeyEnv: OpenAIAPIKeyEnv,
62 }
63
64 GPT4oMini = Model{
65 UserName: "gpt4o-mini",
66 ModelName: "gpt-4o-mini-2024-07-18",
67 URL: OpenAIURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070068 APIKeyEnv: OpenAIAPIKeyEnv,
69 }
70
71 GPT41Mini = Model{
72 UserName: "gpt4.1-mini",
73 ModelName: "gpt-4.1-mini-2025-04-14",
74 URL: OpenAIURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070075 APIKeyEnv: OpenAIAPIKeyEnv,
76 }
77
78 GPT41Nano = Model{
79 UserName: "gpt4.1-nano",
80 ModelName: "gpt-4.1-nano-2025-04-14",
81 URL: OpenAIURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070082 APIKeyEnv: OpenAIAPIKeyEnv,
83 }
84
85 O3 = Model{
86 UserName: "o3",
87 ModelName: "o3-2025-04-16",
88 URL: OpenAIURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070089 APIKeyEnv: OpenAIAPIKeyEnv,
90 IsReasoningModel: true,
91 }
92
93 O4Mini = Model{
94 UserName: "o4-mini",
95 ModelName: "o4-mini-2025-04-16",
96 URL: OpenAIURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -070097 APIKeyEnv: OpenAIAPIKeyEnv,
98 IsReasoningModel: true,
99 }
100
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700101 Gemini25Flash = Model{
102 UserName: "gemini-flash-2.5",
103 ModelName: "gemini-2.5-flash-preview-04-17",
104 URL: GeminiURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700105 APIKeyEnv: GeminiAPIKeyEnv,
106 }
107
108 Gemini25Pro = Model{
109 UserName: "gemini-pro-2.5",
110 ModelName: "gemini-2.5-pro-preview-03-25",
111 URL: GeminiURL,
112 // GRRRR. Really??
113 // Input is: $1.25, prompts <= 200k tokens, $2.50, prompts > 200k tokens
114 // Output is: $10.00, prompts <= 200k tokens, $15.00, prompts > 200k
115 // Caching is: $0.31, prompts <= 200k tokens, $0.625, prompts > 200k, $4.50 / 1,000,000 tokens per hour
116 // Whatever that means. Are we caching? I have no idea.
117 // How do you always manage to be the annoying one, Google?
118 // I'm not complicating things just for you.
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700119 APIKeyEnv: GeminiAPIKeyEnv,
120 }
121
122 TogetherDeepseekV3 = Model{
123 UserName: "together-deepseek-v3",
124 ModelName: "deepseek-ai/DeepSeek-V3",
125 URL: TogetherURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700126 APIKeyEnv: TogetherAPIKeyEnv,
127 }
128
Josh Bleecher Snyderd1bd5192025-06-02 14:10:52 -0700129 TogetherDeepseekR1 = Model{
130 UserName: "together-deepseek-r1",
131 ModelName: "deepseek-ai/DeepSeek-R1",
132 URL: TogetherURL,
Josh Bleecher Snyderd1bd5192025-06-02 14:10:52 -0700133 APIKeyEnv: TogetherAPIKeyEnv,
134 }
135
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700136 TogetherLlama4Maverick = Model{
137 UserName: "together-llama4-maverick",
138 ModelName: "meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8",
139 URL: TogetherURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700140 APIKeyEnv: TogetherAPIKeyEnv,
141 }
142
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700143 FireworksLlama4Maverick = Model{
144 UserName: "fireworks-llama4-maverick",
145 ModelName: "accounts/fireworks/models/llama4-maverick-instruct-basic",
146 URL: FireworksURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700147 APIKeyEnv: FireworksAPIKeyEnv,
148 }
149
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700150 TogetherLlama3_3_70B = Model{
151 UserName: "together-llama3-70b",
152 ModelName: "meta-llama/Llama-3.3-70B-Instruct-Turbo",
153 URL: TogetherURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700154 APIKeyEnv: TogetherAPIKeyEnv,
155 }
156
157 TogetherMistralSmall = Model{
158 UserName: "together-mistral-small",
159 ModelName: "mistralai/Mistral-Small-24B-Instruct-2501",
160 URL: TogetherURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700161 APIKeyEnv: TogetherAPIKeyEnv,
162 }
163
Josh Bleecher Snyder3e213082025-05-02 13:22:02 -0700164 TogetherQwen3 = Model{
165 UserName: "together-qwen3",
166 ModelName: "Qwen/Qwen3-235B-A22B-fp8-tput",
167 URL: TogetherURL,
Josh Bleecher Snyder3e213082025-05-02 13:22:02 -0700168 APIKeyEnv: TogetherAPIKeyEnv,
169 }
170
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700171 TogetherGemma2 = Model{
172 UserName: "together-gemma2",
173 ModelName: "google/gemma-2-27b-it",
174 URL: TogetherURL,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700175 APIKeyEnv: TogetherAPIKeyEnv,
176 }
177
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700178 LlamaCPP = Model{
179 UserName: "llama.cpp",
180 ModelName: "llama.cpp local model",
181 URL: LlamaCPPURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700182 }
183
184 FireworksDeepseekV3 = Model{
185 UserName: "fireworks-deepseek-v3",
186 ModelName: "accounts/fireworks/models/deepseek-v3-0324",
187 URL: FireworksURL,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700188 APIKeyEnv: FireworksAPIKeyEnv,
189 }
Josh Bleecher Snyderfa667032025-05-07 14:13:27 -0700190
Josh Bleecher Snyder2edd62e2025-07-14 12:44:51 -0700191 MoonshotKimiK2 = Model{
192 UserName: "moonshot-kimi-k2",
193 ModelName: "moonshot-v1-auto",
194 URL: MoonshotURL,
195 APIKeyEnv: MoonshotAPIKeyEnv,
196 }
197
Josh Bleecher Snyderfa667032025-05-07 14:13:27 -0700198 MistralMedium = Model{
199 UserName: "mistral-medium-3",
200 ModelName: "mistral-medium-latest",
201 URL: MistralURL,
Josh Bleecher Snyderfa667032025-05-07 14:13:27 -0700202 APIKeyEnv: MistralAPIKeyEnv,
203 }
Josh Bleecher Snyder1a648f32025-05-21 17:15:04 +0000204
205 DevstralSmall = Model{
206 UserName: "devstral-small",
207 ModelName: "devstral-small-latest",
208 URL: MistralURL,
Josh Bleecher Snyder1a648f32025-05-21 17:15:04 +0000209 APIKeyEnv: MistralAPIKeyEnv,
210 }
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700211)
212
213// Service provides chat completions.
214// Fields should not be altered concurrently with calling any method on Service.
215type Service struct {
216 HTTPC *http.Client // defaults to http.DefaultClient if nil
217 APIKey string // optional, if not set will try to load from env var
218 Model Model // defaults to DefaultModel if zero value
219 MaxTokens int // defaults to DefaultMaxTokens if zero
220 Org string // optional - organization ID
Josh Bleecher Snyder57afbca2025-07-23 13:29:59 -0700221 DumpLLM bool // whether to dump request/response text to files for debugging; defaults to false
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700222}
223
224var _ llm.Service = (*Service)(nil)
225
226// ModelsRegistry is a registry of all known models with their user-friendly names.
227var ModelsRegistry = []Model{
228 GPT41,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700229 GPT41Mini,
230 GPT41Nano,
231 GPT4o,
232 GPT4oMini,
233 O3,
234 O4Mini,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700235 Gemini25Flash,
236 Gemini25Pro,
237 TogetherDeepseekV3,
Josh Bleecher Snyderd1bd5192025-06-02 14:10:52 -0700238 TogetherDeepseekR1,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700239 TogetherLlama4Maverick,
240 TogetherLlama3_3_70B,
241 TogetherMistralSmall,
Josh Bleecher Snyder3e213082025-05-02 13:22:02 -0700242 TogetherQwen3,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700243 TogetherGemma2,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700244 LlamaCPP,
245 FireworksDeepseekV3,
Josh Bleecher Snyder2edd62e2025-07-14 12:44:51 -0700246 MoonshotKimiK2,
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700247 FireworksLlama4Maverick,
248 MistralMedium,
Josh Bleecher Snyder1a648f32025-05-21 17:15:04 +0000249 DevstralSmall,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700250}
251
252// ListModels returns a list of all available models with their user-friendly names.
253func ListModels() []string {
254 var names []string
255 for _, model := range ModelsRegistry {
256 if model.UserName != "" {
257 names = append(names, model.UserName)
258 }
259 }
260 return names
261}
262
263// ModelByUserName returns a model by its user-friendly name.
264// Returns nil if no model with the given name is found.
265func ModelByUserName(name string) *Model {
266 for _, model := range ModelsRegistry {
267 if model.UserName == name {
268 return &model
269 }
270 }
271 return nil
272}
273
274var (
275 fromLLMRole = map[llm.MessageRole]string{
276 llm.MessageRoleAssistant: "assistant",
277 llm.MessageRoleUser: "user",
278 }
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700279 fromLLMToolChoiceType = map[llm.ToolChoiceType]string{
280 llm.ToolChoiceTypeAuto: "auto",
281 llm.ToolChoiceTypeAny: "any",
282 llm.ToolChoiceTypeNone: "none",
283 llm.ToolChoiceTypeTool: "function", // OpenAI uses "function" instead of "tool"
284 }
285 toLLMRole = map[string]llm.MessageRole{
286 "assistant": llm.MessageRoleAssistant,
287 "user": llm.MessageRoleUser,
288 }
289 toLLMStopReason = map[string]llm.StopReason{
290 "stop": llm.StopReasonStopSequence,
291 "length": llm.StopReasonMaxTokens,
292 "tool_calls": llm.StopReasonToolUse,
293 "function_call": llm.StopReasonToolUse, // Map both to ToolUse
294 "content_filter": llm.StopReasonStopSequence, // No direct equivalent
295 }
296)
297
298// fromLLMContent converts llm.Content to the format expected by OpenAI.
299func fromLLMContent(c llm.Content) (string, []openai.ToolCall) {
300 switch c.Type {
301 case llm.ContentTypeText:
302 return c.Text, nil
303 case llm.ContentTypeToolUse:
304 // For OpenAI, tool use is sent as a null content with tool_calls in the message
305 return "", []openai.ToolCall{
306 {
307 Type: openai.ToolTypeFunction,
308 ID: c.ID, // Use the content ID if provided
309 Function: openai.FunctionCall{
310 Name: c.ToolName,
311 Arguments: string(c.ToolInput),
312 },
313 },
314 }
315 case llm.ContentTypeToolResult:
316 // Tool results in OpenAI are sent as a separate message with tool_call_id
Philip Zeyliger72252cb2025-05-10 17:00:08 -0700317 // OpenAI doesn't support multiple content items or images in tool results
318 // Combine all text content into a single string
319 var resultText string
320 if len(c.ToolResult) > 0 {
321 // Collect all text from content objects
322 texts := make([]string, 0, len(c.ToolResult))
323 for _, result := range c.ToolResult {
324 if result.Text != "" {
325 texts = append(texts, result.Text)
326 }
327 }
328 resultText = strings.Join(texts, "\n")
329 }
330 return resultText, nil
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700331 default:
332 // For thinking or other types, convert to text
333 return c.Text, nil
334 }
335}
336
337// fromLLMMessage converts llm.Message to OpenAI ChatCompletionMessage format
338func fromLLMMessage(msg llm.Message) []openai.ChatCompletionMessage {
339 // For OpenAI, we need to handle tool results differently than regular messages
340 // Each tool result becomes its own message with role="tool"
341
342 var messages []openai.ChatCompletionMessage
343
344 // Check if this is a regular message or contains tool results
345 var regularContent []llm.Content
346 var toolResults []llm.Content
347
348 for _, c := range msg.Content {
349 if c.Type == llm.ContentTypeToolResult {
350 toolResults = append(toolResults, c)
351 } else {
352 regularContent = append(regularContent, c)
353 }
354 }
355
356 // Process tool results as separate messages, but first
357 for _, tr := range toolResults {
Philip Zeyliger72252cb2025-05-10 17:00:08 -0700358 // Convert toolresult array to a string for OpenAI
359 var toolResultContent string
360 if len(tr.ToolResult) > 0 {
361 // For now, just use the first text content in the array
362 toolResultContent = tr.ToolResult[0].Text
363 }
364
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700365 m := openai.ChatCompletionMessage{
366 Role: "tool",
Philip Zeyliger72252cb2025-05-10 17:00:08 -0700367 Content: cmp.Or(toolResultContent, " "), // Use empty space if empty to avoid omitempty issues
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700368 ToolCallID: tr.ToolUseID,
369 }
370 messages = append(messages, m)
371 }
372 // Process regular content second
373 if len(regularContent) > 0 {
374 m := openai.ChatCompletionMessage{
375 Role: fromLLMRole[msg.Role],
376 }
377
378 // For assistant messages that contain tool calls
379 var toolCalls []openai.ToolCall
380 var textContent string
381
382 for _, c := range regularContent {
383 content, tools := fromLLMContent(c)
384 if len(tools) > 0 {
385 toolCalls = append(toolCalls, tools...)
386 } else if content != "" {
387 if textContent != "" {
388 textContent += "\n"
389 }
390 textContent += content
391 }
392 }
393
394 m.Content = textContent
395 m.ToolCalls = toolCalls
396
397 messages = append(messages, m)
398 }
399
400 return messages
401}
402
403// fromLLMToolChoice converts llm.ToolChoice to the format expected by OpenAI.
404func fromLLMToolChoice(tc *llm.ToolChoice) any {
405 if tc == nil {
406 return nil
407 }
408
409 if tc.Type == llm.ToolChoiceTypeTool && tc.Name != "" {
410 return openai.ToolChoice{
411 Type: openai.ToolTypeFunction,
412 Function: openai.ToolFunction{
413 Name: tc.Name,
414 },
415 }
416 }
417
418 // For non-specific tool choice, just use the string
419 return fromLLMToolChoiceType[tc.Type]
420}
421
422// fromLLMTool converts llm.Tool to the format expected by OpenAI.
423func fromLLMTool(t *llm.Tool) openai.Tool {
424 return openai.Tool{
425 Type: openai.ToolTypeFunction,
426 Function: &openai.FunctionDefinition{
427 Name: t.Name,
428 Description: t.Description,
429 Parameters: t.InputSchema,
430 },
431 }
432}
433
434// fromLLMSystem converts llm.SystemContent to an OpenAI system message.
435func fromLLMSystem(systemContent []llm.SystemContent) []openai.ChatCompletionMessage {
436 if len(systemContent) == 0 {
437 return nil
438 }
439
440 // Combine all system content into a single system message
441 var systemText string
442 for i, content := range systemContent {
443 if i > 0 && systemText != "" && content.Text != "" {
444 systemText += "\n"
445 }
446 systemText += content.Text
447 }
448
449 if systemText == "" {
450 return nil
451 }
452
453 return []openai.ChatCompletionMessage{
454 {
455 Role: "system",
456 Content: systemText,
457 },
458 }
459}
460
461// toRawLLMContent converts a raw content string from OpenAI to llm.Content.
462func toRawLLMContent(content string) llm.Content {
463 return llm.Content{
464 Type: llm.ContentTypeText,
465 Text: content,
466 }
467}
468
469// toToolCallLLMContent converts a tool call from OpenAI to llm.Content.
470func toToolCallLLMContent(toolCall openai.ToolCall) llm.Content {
471 // Generate a content ID if needed
472 id := toolCall.ID
473 if id == "" {
474 // Create a deterministic ID based on the function name if no ID is provided
475 id = "tc_" + toolCall.Function.Name
476 }
477
478 return llm.Content{
479 ID: id,
480 Type: llm.ContentTypeToolUse,
481 ToolName: toolCall.Function.Name,
482 ToolInput: json.RawMessage(toolCall.Function.Arguments),
483 }
484}
485
486// toToolResultLLMContent converts a tool result message from OpenAI to llm.Content.
487func toToolResultLLMContent(msg openai.ChatCompletionMessage) llm.Content {
488 return llm.Content{
Philip Zeyliger72252cb2025-05-10 17:00:08 -0700489 Type: llm.ContentTypeToolResult,
490 ToolUseID: msg.ToolCallID,
491 ToolResult: []llm.Content{{
492 Type: llm.ContentTypeText,
493 Text: msg.Content,
494 }},
495 ToolError: false, // OpenAI doesn't specify errors explicitly
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700496 }
497}
498
499// toLLMContents converts message content from OpenAI to []llm.Content.
500func toLLMContents(msg openai.ChatCompletionMessage) []llm.Content {
501 var contents []llm.Content
502
503 // If this is a tool response, handle it separately
504 if msg.Role == "tool" && msg.ToolCallID != "" {
505 return []llm.Content{toToolResultLLMContent(msg)}
506 }
507
508 // If there's text content, add it
509 if msg.Content != "" {
510 contents = append(contents, toRawLLMContent(msg.Content))
511 }
512
513 // If there are tool calls, add them
514 for _, tc := range msg.ToolCalls {
515 contents = append(contents, toToolCallLLMContent(tc))
516 }
517
518 // If empty, add an empty text content
519 if len(contents) == 0 {
520 contents = append(contents, llm.Content{
521 Type: llm.ContentTypeText,
522 Text: "",
523 })
524 }
525
526 return contents
527}
528
529// toLLMUsage converts usage information from OpenAI to llm.Usage.
Josh Bleecher Snyder59bb27d2025-06-05 07:32:10 -0700530func (s *Service) toLLMUsage(au openai.Usage, headers http.Header) llm.Usage {
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700531 // fmt.Printf("raw usage: %+v / %v / %v\n", au, au.PromptTokensDetails, au.CompletionTokensDetails)
532 in := uint64(au.PromptTokens)
533 var inc uint64
534 if au.PromptTokensDetails != nil {
535 inc = uint64(au.PromptTokensDetails.CachedTokens)
536 }
537 out := uint64(au.CompletionTokens)
538 u := llm.Usage{
539 InputTokens: in,
540 CacheReadInputTokens: inc,
541 CacheCreationInputTokens: in,
542 OutputTokens: out,
543 }
Josh Bleecher Snyder59bb27d2025-06-05 07:32:10 -0700544 u.CostUSD = llm.CostUSDFromResponse(headers)
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700545 return u
546}
547
548// toLLMResponse converts the OpenAI response to llm.Response.
549func (s *Service) toLLMResponse(r *openai.ChatCompletionResponse) *llm.Response {
550 // fmt.Printf("Raw response\n")
551 // enc := json.NewEncoder(os.Stdout)
552 // enc.SetIndent("", " ")
553 // enc.Encode(r)
554 // fmt.Printf("\n")
555
556 if len(r.Choices) == 0 {
557 return &llm.Response{
558 ID: r.ID,
559 Model: r.Model,
560 Role: llm.MessageRoleAssistant,
Josh Bleecher Snyder59bb27d2025-06-05 07:32:10 -0700561 Usage: s.toLLMUsage(r.Usage, r.Header()),
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700562 }
563 }
564
565 // Process the primary choice
566 choice := r.Choices[0]
567
568 return &llm.Response{
569 ID: r.ID,
570 Model: r.Model,
571 Role: toRoleFromString(choice.Message.Role),
572 Content: toLLMContents(choice.Message),
573 StopReason: toStopReason(string(choice.FinishReason)),
Josh Bleecher Snyder59bb27d2025-06-05 07:32:10 -0700574 Usage: s.toLLMUsage(r.Usage, r.Header()),
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700575 }
576}
577
578// toRoleFromString converts a role string to llm.MessageRole.
579func toRoleFromString(role string) llm.MessageRole {
580 if role == "tool" || role == "system" || role == "function" {
581 return llm.MessageRoleAssistant // Map special roles to assistant for consistency
582 }
583 if mr, ok := toLLMRole[role]; ok {
584 return mr
585 }
586 return llm.MessageRoleUser // Default to user if unknown
587}
588
589// toStopReason converts a finish reason string to llm.StopReason.
590func toStopReason(reason string) llm.StopReason {
591 if sr, ok := toLLMStopReason[reason]; ok {
592 return sr
593 }
594 return llm.StopReasonStopSequence // Default
595}
596
Philip Zeyligerb8a8f352025-06-02 07:39:37 -0700597// TokenContextWindow returns the maximum token context window size for this service
598func (s *Service) TokenContextWindow() int {
599 model := cmp.Or(s.Model, DefaultModel)
600
601 // OpenAI models generally have 128k context windows
602 // Some newer models have larger windows, but 128k is a safe default
603 switch model.ModelName {
604 case "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14":
605 return 200000 // 200k for newer GPT-4.1 models
606 case "gpt-4o-2024-08-06", "gpt-4o-mini-2024-07-18":
607 return 128000 // 128k for GPT-4o models
608 case "o3-2025-04-16", "o3-mini-2025-04-16":
609 return 200000 // 200k for O3 models
610 default:
611 // Default for unknown models
612 return 128000
613 }
614}
615
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700616// Do sends a request to OpenAI using the go-openai package.
617func (s *Service) Do(ctx context.Context, ir *llm.Request) (*llm.Response, error) {
618 // Configure the OpenAI client
619 httpc := cmp.Or(s.HTTPC, http.DefaultClient)
620 model := cmp.Or(s.Model, DefaultModel)
621
622 // TODO: do this one during Service setup? maybe with a constructor instead?
623 config := openai.DefaultConfig(s.APIKey)
624 if model.URL != "" {
625 config.BaseURL = model.URL
626 }
627 if s.Org != "" {
628 config.OrgID = s.Org
629 }
630 config.HTTPClient = httpc
631
632 client := openai.NewClientWithConfig(config)
633
634 // Start with system messages if provided
635 var allMessages []openai.ChatCompletionMessage
636 if len(ir.System) > 0 {
637 sysMessages := fromLLMSystem(ir.System)
638 allMessages = append(allMessages, sysMessages...)
639 }
640
641 // Add regular and tool messages
642 for _, msg := range ir.Messages {
643 msgs := fromLLMMessage(msg)
644 allMessages = append(allMessages, msgs...)
645 }
646
647 // Convert tools
648 var tools []openai.Tool
649 for _, t := range ir.Tools {
650 tools = append(tools, fromLLMTool(t))
651 }
652
653 // Create the OpenAI request
654 req := openai.ChatCompletionRequest{
655 Model: model.ModelName,
656 Messages: allMessages,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700657 Tools: tools,
658 ToolChoice: fromLLMToolChoice(ir.ToolChoice), // TODO: make fromLLMToolChoice return an error when a perfect translation is not possible
659 }
Josh Bleecher Snyder8236cbc2025-05-09 09:57:57 -0700660 if model.IsReasoningModel {
661 req.MaxCompletionTokens = cmp.Or(s.MaxTokens, DefaultMaxTokens)
662 } else {
663 req.MaxTokens = cmp.Or(s.MaxTokens, DefaultMaxTokens)
664 }
Josh Bleecher Snyder57afbca2025-07-23 13:29:59 -0700665 // Dump request if enabled
666 if s.DumpLLM {
667 if reqJSON, err := json.MarshalIndent(req, "", " "); err == nil {
668 // Construct the chat completions URL
669 baseURL := cmp.Or(model.URL, OpenAIURL)
670 url := baseURL + "/chat/completions"
671 if err := llm.DumpToFile("request", url, reqJSON); err != nil {
672 slog.WarnContext(ctx, "failed to dump openai request to file", "error", err)
673 }
674 }
675 }
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700676
677 // Retry mechanism
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000678 backoff := []time.Duration{1 * time.Second, 2 * time.Second, 5 * time.Second, 10 * time.Second, 15 * time.Second}
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700679
680 // retry loop
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000681 var errs error // accumulated errors across all attempts
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700682 for attempts := 0; ; attempts++ {
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000683 if attempts > 10 {
684 return nil, fmt.Errorf("openai request failed after %d attempts: %w", attempts, errs)
685 }
686 if attempts > 0 {
687 sleep := backoff[min(attempts, len(backoff)-1)] + time.Duration(rand.Int64N(int64(time.Second)))
688 slog.WarnContext(ctx, "openai request sleep before retry", "sleep", sleep, "attempts", attempts)
689 time.Sleep(sleep)
690 }
691
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700692 resp, err := client.CreateChatCompletion(ctx, req)
693
694 // Handle successful response
695 if err == nil {
Josh Bleecher Snyder57afbca2025-07-23 13:29:59 -0700696 // Dump response if enabled
697 if s.DumpLLM {
698 if respJSON, jsonErr := json.MarshalIndent(resp, "", " "); jsonErr == nil {
699 if dumpErr := llm.DumpToFile("response", "", respJSON); dumpErr != nil {
700 slog.WarnContext(ctx, "failed to dump openai response to file", "error", dumpErr)
701 }
702 }
703 }
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700704 return s.toLLMResponse(&resp), nil
705 }
706
707 // Handle errors
708 var apiErr *openai.APIError
709 if ok := errors.As(err, &apiErr); !ok {
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000710 // Not an OpenAI API error, return immediately with accumulated errors
711 return nil, errors.Join(errs, err)
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700712 }
713
714 switch {
715 case apiErr.HTTPStatusCode >= 500:
716 // Server error, try again with backoff
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000717 slog.WarnContext(ctx, "openai_request_failed", "error", apiErr.Error(), "status_code", apiErr.HTTPStatusCode)
718 errs = errors.Join(errs, fmt.Errorf("status %d: %s", apiErr.HTTPStatusCode, apiErr.Error()))
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700719 continue
720
721 case apiErr.HTTPStatusCode == 429:
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000722 // Rate limited, accumulate error and retry
723 slog.WarnContext(ctx, "openai_request_rate_limited", "error", apiErr.Error())
724 errs = errors.Join(errs, fmt.Errorf("status %d (rate limited): %s", apiErr.HTTPStatusCode, apiErr.Error()))
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700725 continue
726
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000727 case apiErr.HTTPStatusCode >= 400 && apiErr.HTTPStatusCode < 500:
728 // Client error, probably unrecoverable
729 slog.WarnContext(ctx, "openai_request_failed", "error", apiErr.Error(), "status_code", apiErr.HTTPStatusCode)
730 return nil, errors.Join(errs, fmt.Errorf("status %d: %s", apiErr.HTTPStatusCode, apiErr.Error()))
731
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700732 default:
Josh Bleecher Snyder38411992025-05-16 17:51:03 +0000733 // Other error, accumulate and retry
734 slog.WarnContext(ctx, "openai_request_failed", "error", apiErr.Error(), "status_code", apiErr.HTTPStatusCode)
735 errs = errors.Join(errs, fmt.Errorf("status %d: %s", apiErr.HTTPStatusCode, apiErr.Error()))
736 continue
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700737 }
738 }
739}