feat: Add Reasoning Effort setting for OpenAI Compatible provider (#2906)

Author: mr-ryan-james

.changeset/odd-ligers-press.md

@@ -0,0 +1,5 @@
+---
+"roo-cline": minor
+---
+
+Add Reasoning Effort setting for OpenAI Compatible provider

package-lock.json

@@ -469,6 +469,7 @@
 		"@types/jest": "^29.5.14",
 		"@types/mocha": "^10.0.10",
 		"@types/node": "20.x",
+		"@types/node-cache": "^4.1.3",
 		"@types/node-ipc": "^9.2.3",
 		"@types/string-similarity": "^4.0.2",
 		"@typescript-eslint/eslint-plugin": "^7.14.1",

package.json

@@ -1,3 +1,5 @@
+// npx jest src/api/providers/__tests__/openai.test.ts
+
 import { OpenAiHandler } from "../openai"
 import { ApiHandlerOptions } from "../../../shared/api"
 import { Anthropic } from "@anthropic-ai/sdk"
@@ -155,6 +157,39 @@ describe("OpenAiHandler", () => {
 			expect(textChunks).toHaveLength(1)
 			expect(textChunks[0].text).toBe("Test response")
 		})
+		it("should include reasoning_effort when reasoning effort is enabled", async () => {
+			const reasoningOptions: ApiHandlerOptions = {
+				...mockOptions,
+				enableReasoningEffort: true,
+				openAiCustomModelInfo: { contextWindow: 128_000, supportsPromptCache: false, reasoningEffort: "high" },
+			}
+			const reasoningHandler = new OpenAiHandler(reasoningOptions)
+			const stream = reasoningHandler.createMessage(systemPrompt, messages)
+			// Consume the stream to trigger the API call
+			for await (const _chunk of stream) {
+			}
+			// Assert the mockCreate was called with reasoning_effort
+			expect(mockCreate).toHaveBeenCalled()
+			const callArgs = mockCreate.mock.calls[0][0]
+			expect(callArgs.reasoning_effort).toBe("high")
+		})
+
+		it("should not include reasoning_effort when reasoning effort is disabled", async () => {
+			const noReasoningOptions: ApiHandlerOptions = {
+				...mockOptions,
+				enableReasoningEffort: false,
+				openAiCustomModelInfo: { contextWindow: 128_000, supportsPromptCache: false },
+			}
+			const noReasoningHandler = new OpenAiHandler(noReasoningOptions)
+			const stream = noReasoningHandler.createMessage(systemPrompt, messages)
+			// Consume the stream to trigger the API call
+			for await (const _chunk of stream) {
+			}
+			// Assert the mockCreate was called without reasoning_effort
+			expect(mockCreate).toHaveBeenCalled()
+			const callArgs = mockCreate.mock.calls[0][0]
+			expect(callArgs.reasoning_effort).toBeUndefined()
+		})
 	})
 
 	describe("error handling", () => {

src/api/providers/__tests__/openai.test.ts

@@ -87,6 +87,7 @@ type ProviderSettings = {
 	openAiUseAzure?: boolean | undefined
 	azureApiVersion?: string | undefined
 	openAiStreamingEnabled?: boolean | undefined
+	enableReasoningEffort?: boolean | undefined
 	ollamaModelId?: string | undefined
 	ollamaBaseUrl?: string | undefined
 	vsCodeLmModelSelector?:

src/exports/roo-code.d.ts

@@ -88,6 +88,7 @@ type ProviderSettings = {
 	openAiUseAzure?: boolean | undefined
 	azureApiVersion?: string | undefined
 	openAiStreamingEnabled?: boolean | undefined
+	enableReasoningEffort?: boolean | undefined
 	ollamaModelId?: string | undefined
 	ollamaBaseUrl?: string | undefined
 	vsCodeLmModelSelector?:

src/exports/types.ts

@@ -355,6 +355,7 @@ export const providerSettingsSchema = z.object({
 	openAiUseAzure: z.boolean().optional(),
 	azureApiVersion: z.string().optional(),
 	openAiStreamingEnabled: z.boolean().optional(),
+	enableReasoningEffort: z.boolean().optional(),
 	// Ollama
 	ollamaModelId: z.string().optional(),
 	ollamaBaseUrl: z.string().optional(),
@@ -453,6 +454,7 @@ const providerSettingsRecord: ProviderSettingsRecord = {
 	openAiUseAzure: undefined,
 	azureApiVersion: undefined,
 	openAiStreamingEnabled: undefined,
+	enableReasoningEffort: undefined,
 	// Ollama
 	ollamaModelId: undefined,
 	ollamaBaseUrl: undefined,

src/schemas/index.ts

@@ -13,6 +13,7 @@ describe("enhancePrompt", () => {
 		apiProvider: "openai",
 		openAiApiKey: "test-key",
 		openAiBaseUrl: "https://api.openai.com/v1",
+		enableReasoningEffort: false,
 	}
 
 	beforeEach(() => {
@@ -97,6 +98,7 @@ describe("enhancePrompt", () => {
 			apiProvider: "openrouter",
 			openRouterApiKey: "test-key",
 			openRouterModelId: "test-model",
+			enableReasoningEffort: false,
 		}
 
 		// Mock successful enhancement

src/utils/__tests__/enhance-prompt.test.ts

@@ -1,13 +1,12 @@
 import React, { memo, useCallback, useEffect, useMemo, useState } from "react"
-import { useAppTranslation } from "@/i18n/TranslationContext"
-import { Trans } from "react-i18next"
-import { getRequestyAuthUrl, getOpenRouterAuthUrl, getGlamaAuthUrl } from "@src/oauth/urls"
 import { useDebounce, useEvent } from "react-use"
+import { Trans } from "react-i18next"
 import { LanguageModelChatSelector } from "vscode"
 import { Checkbox } from "vscrui"
 import { VSCodeLink, VSCodeRadio, VSCodeRadioGroup, VSCodeTextField } from "@vscode/webview-ui-toolkit/react"
 import { ExternalLinkIcon } from "@radix-ui/react-icons"
 
+import { ReasoningEffort as ReasoningEffortType } from "@roo/schemas"
 import {
 	ApiConfiguration,
 	ModelInfo,
@@ -21,21 +20,22 @@ import {
 	ApiProvider,
 } from "@roo/shared/api"
 import { ExtensionMessage } from "@roo/shared/ExtensionMessage"
-import { AWS_REGIONS } from "@roo/shared/aws_regions"
 
 import { vscode } from "@src/utils/vscode"
 import { validateApiConfiguration, validateModelId, validateBedrockArn } from "@src/utils/validate"
-import { useRouterModels } from "@/components/ui/hooks/useRouterModels"
-import { useSelectedModel } from "@/components/ui/hooks/useSelectedModel"
+import { useAppTranslation } from "@src/i18n/TranslationContext"
+import { useRouterModels } from "@src/components/ui/hooks/useRouterModels"
+import { useSelectedModel } from "@src/components/ui/hooks/useSelectedModel"
 import {
 	useOpenRouterModelProviders,
 	OPENROUTER_DEFAULT_PROVIDER_NAME,
 } from "@src/components/ui/hooks/useOpenRouterModelProviders"
 import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue, Button } from "@src/components/ui"
+import { getRequestyAuthUrl, getOpenRouterAuthUrl, getGlamaAuthUrl } from "@src/oauth/urls"
 
 import { VSCodeButtonLink } from "../common/VSCodeButtonLink"
 
-import { MODELS_BY_PROVIDER, PROVIDERS, VERTEX_REGIONS, REASONING_MODELS } from "./constants"
+import { MODELS_BY_PROVIDER, PROVIDERS, VERTEX_REGIONS, REASONING_MODELS, AWS_REGIONS } from "./constants"
 import { ModelInfoView } from "./ModelInfoView"
 import { ModelPicker } from "./ModelPicker"
 import { ApiErrorMessage } from "./ApiErrorMessage"
@@ -851,6 +851,41 @@ const ApiOptions = ({
 						)}
 					</div>
 
+					<div className="flex flex-col gap-1">
+						<Checkbox
+							checked={apiConfiguration.enableReasoningEffort ?? false}
+							onChange={(checked: boolean) => {
+								setApiConfigurationField("enableReasoningEffort", checked)
+
+								if (!checked) {
+									const { reasoningEffort: _, ...openAiCustomModelInfo } =
+										apiConfiguration.openAiCustomModelInfo || openAiModelInfoSaneDefaults
+
+									setApiConfigurationField("openAiCustomModelInfo", openAiCustomModelInfo)
+								}
+							}}>
+							{t("settings:providers.setReasoningLevel")}
+						</Checkbox>
+						{!!apiConfiguration.enableReasoningEffort && (
+							<ReasoningEffort
+								apiConfiguration={{
+									...apiConfiguration,
+									reasoningEffort: apiConfiguration.openAiCustomModelInfo?.reasoningEffort,
+								}}
+								setApiConfigurationField={(field, value) => {
+									if (field === "reasoningEffort") {
+										const openAiCustomModelInfo =
+											apiConfiguration.openAiCustomModelInfo || openAiModelInfoSaneDefaults
+
+										setApiConfigurationField("openAiCustomModelInfo", {
+											...openAiCustomModelInfo,
+											reasoningEffort: value as ReasoningEffortType,
+										})
+									}
+								}}
+							/>
+						)}
+					</div>
 					<div className="flex flex-col gap-3">
 						<div className="text-sm text-vscode-descriptionForeground whitespace-pre-line">
 							{t("settings:providers.customModel.capabilities")}