Adds Open-AI compatible provider (#4270)

axosoft-ramint · web-flow · commit 1c0401643d10 · 2025-04-30T14:10:40.000-07:00
Moves/renames existing "OpenAICompatibleProvider" base class to "OpenAICompatibleProviderBase"
diff --git a/docs/telemetry-events.md b/docs/telemetry-events.md
@@ -124,7 +124,7 @@
   'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
   'input.length': number,
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string,
   'output.length': number,
   'retry.count': number,
@@ -155,7 +155,7 @@
   'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
   'input.length': number,
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string,
   'output.length': number,
   'retry.count': number,
@@ -185,7 +185,7 @@ or
   'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
   'input.length': number,
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string,
   'output.length': number,
   'retry.count': number,
@@ -214,7 +214,7 @@ or
   'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
   'input.length': number,
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string,
   'output.length': number,
   'retry.count': number,
@@ -243,7 +243,7 @@ or
   'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
   'input.length': number,
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string,
   'output.length': number,
   'retry.count': number,
@@ -272,7 +272,7 @@ or
   'failed.reason': 'user-declined' | 'user-cancelled' | 'error',
   'input.length': number,
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string,
   'output.length': number,
   'retry.count': number,
@@ -295,7 +295,7 @@ or
 ```typescript
 {
   'model.id': string,
-  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openrouter' | 'vscode' | 'xai',
+  'model.provider.id': 'anthropic' | 'deepseek' | 'gemini' | 'github' | 'gitkraken' | 'huggingface' | 'ollama' | 'openai' | 'openaicompatible' | 'openrouter' | 'vscode' | 'xai',
   'model.provider.name': string
 }
 ```
diff --git a/package.json b/package.json
@@ -4047,7 +4047,7 @@
 							"null"
 						],
 						"default": null,
-						"pattern": "^((anthropic|deepseek|gemini|github|huggingface|ollama|openai|openrouter|xai):([\\w.-:]+)|gitkraken|vscode)$",
+						"pattern": "^((anthropic|deepseek|gemini|github|huggingface|ollama|openai|openaicompatible|openrouter|xai):([\\w.-:]+)|gitkraken|vscode)$",
 						"markdownDescription": "Specifies the AI provider and model to use for GitLens' AI features. Should be formatted as `provider:model` (e.g. `openai:gpt-4o` or `anthropic:claude-3-5-sonnet-latest`), `gitkraken` for GitKraken AI provided models, or `vscode` for models provided by the VS Code extension API (e.g. Copilot)",
 						"scope": "window",
 						"order": 10,
@@ -4109,6 +4109,19 @@
 							"preview"
 						]
 					},
+					"gitlens.ai.openaicompatible.url": {
+						"type": [
+							"string",
+							"null"
+						],
+						"default": null,
+						"markdownDescription": "Specifies a custom URL to use for access to an OpenAI-compatible model. Azure URLs should be in the following format: https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}",
+						"scope": "window",
+						"order": 31,
+						"tags": [
+							"preview"
+						]
+					},
 					"gitlens.ai.largePromptWarningThreshold": {
 						"type": "number",
 						"default": 20000,
diff --git a/src/config.ts b/src/config.ts
@@ -250,6 +250,9 @@ interface AIConfig {
 	readonly openai: {
 		readonly url: string | null;
 	};
+	readonly openaicompatible: {
+		readonly url: string | null;
+	};
 	readonly vscode: {
 		readonly model: AIProviderAndModel | null;
 	};
diff --git a/src/constants.ai.ts b/src/constants.ai.ts
@@ -9,6 +9,7 @@ export type AIProviders =
 	| 'huggingface'
 	| 'ollama'
 	| 'openai'
+	| 'openaicompatible'
 	| 'openrouter'
 	| 'vscode'
 	| 'xai';
@@ -38,6 +39,13 @@ export const openAIProviderDescriptor: AIProviderDescriptor<'openai'> = {
 	requiresAccount: true,
 	requiresUserKey: true,
 } as const;
+export const openAICompatibleProviderDescriptor: AIProviderDescriptor<'openaicompatible'> = {
+	id: 'openaicompatible',
+	name: 'OpenAI-Compatible Provider (Azure, etc.)',
+	primary: false,
+	requiresAccount: true,
+	requiresUserKey: true,
+} as const;
 export const anthropicProviderDescriptor: AIProviderDescriptor<'anthropic'> = {
 	id: 'anthropic',
 	name: 'Anthropic',
diff --git a/src/plus/ai/aiProviderService.ts b/src/plus/ai/aiProviderService.ts
@@ -9,6 +9,7 @@ import {
 	gitKrakenProviderDescriptor,
 	huggingFaceProviderDescriptor,
 	ollamaProviderDescriptor,
+	openAICompatibleProviderDescriptor,
 	openAIProviderDescriptor,
 	openRouterProviderDescriptor,
 	vscodeProviderDescriptor,
@@ -148,6 +149,16 @@ const supportedAIProviders = new Map<AIProviders, AIProviderDescriptorWithType>(
 			type: lazy(async () => (await import(/* webpackChunkName: "ai" */ './openaiProvider')).OpenAIProvider),
 		},
 	],
+	[
+		'openaicompatible',
+		{
+			...openAICompatibleProviderDescriptor,
+			type: lazy(
+				async () =>
+					(await import(/* webpackChunkName: "ai" */ './openAICompatibleProvider')).OpenAICompatibleProvider,
+			),
+		},
+	],
 	[
 		'ollama',
 		{
diff --git a/src/plus/ai/anthropicProvider.ts b/src/plus/ai/anthropicProvider.ts
@@ -3,7 +3,7 @@ import type { Response } from '@env/fetch';
 import { anthropicProviderDescriptor as provider } from '../../constants.ai';
 import { AIError, AIErrorReason } from '../../errors';
 import type { AIActionType, AIModel } from './models/model';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 
 type AnthropicModel = AIModel<typeof provider.id>;
 const models: AnthropicModel[] = [
@@ -103,7 +103,7 @@ const models: AnthropicModel[] = [
 	},
 ];
 
-export class AnthropicProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class AnthropicProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/deepSeekProvider.ts b/src/plus/ai/deepSeekProvider.ts
@@ -1,6 +1,6 @@
 import { deepSeekProviderDescriptor as provider } from '../../constants.ai';
 import type { AIModel } from './models/model';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 
 type DeepSeekModel = AIModel<typeof provider.id>;
 const models: DeepSeekModel[] = [
@@ -21,7 +21,7 @@ const models: DeepSeekModel[] = [
 	},
 ];
 
-export class DeepSeekProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class DeepSeekProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/geminiProvider.ts b/src/plus/ai/geminiProvider.ts
@@ -2,7 +2,7 @@ import type { CancellationToken } from 'vscode';
 import type { Response } from '@env/fetch';
 import { geminiProviderDescriptor as provider } from '../../constants.ai';
 import type { AIActionType, AIModel } from './models/model';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 
 type GeminiModel = AIModel<typeof provider.id>;
 const models: GeminiModel[] = [
@@ -111,7 +111,7 @@ const models: GeminiModel[] = [
 	},
 ];
 
-export class GeminiProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class GeminiProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/githubModelsProvider.ts b/src/plus/ai/githubModelsProvider.ts
@@ -3,11 +3,11 @@ import { fetch } from '@env/fetch';
 import { githubProviderDescriptor as provider } from '../../constants.ai';
 import { AIError, AIErrorReason } from '../../errors';
 import type { AIActionType, AIModel } from './models/model';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 
 type GitHubModelsModel = AIModel<typeof provider.id>;
 
-export class GitHubModelsProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class GitHubModelsProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/gitkrakenProvider.ts b/src/plus/ai/gitkrakenProvider.ts
@@ -6,12 +6,12 @@ import { debug } from '../../system/decorators/log';
 import { Logger } from '../../system/logger';
 import { getLogScope } from '../../system/logger.scope';
 import type { AIActionType, AIModel } from './models/model';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 import { ensureAccount } from './utils/-webview/ai.utils';
 
 type GitKrakenModel = AIModel<typeof provider.id>;
 
-export class GitKrakenProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class GitKrakenProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/huggingFaceProvider.ts b/src/plus/ai/huggingFaceProvider.ts
@@ -1,11 +1,11 @@
 import { fetch } from '@env/fetch';
 import { huggingFaceProviderDescriptor as provider } from '../../constants.ai';
 import type { AIModel } from './models/model';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 
 type HuggingFaceModel = AIModel<typeof provider.id>;
 
-export class HuggingFaceProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class HuggingFaceProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/ollamaProvider.ts b/src/plus/ai/ollamaProvider.ts
@@ -4,13 +4,13 @@ import { ollamaProviderDescriptor as provider } from '../../constants.ai';
 import { configuration } from '../../system/-webview/configuration';
 import type { AIActionType, AIModel } from './models/model';
 import type { AIChatMessage, AIRequestResult } from './models/provider';
-import { OpenAICompatibleProvider } from './openAICompatibleProvider';
+import { OpenAICompatibleProviderBase } from './openAICompatibleProviderBase';
 
 type OllamaModel = AIModel<typeof provider.id>;
 
 const defaultBaseUrl = 'http://localhost:11434';
 
-export class OllamaProvider extends OpenAICompatibleProvider<typeof provider.id> {
+export class OllamaProvider extends OpenAICompatibleProviderBase<typeof provider.id> {
 	readonly id = provider.id;
 	readonly name = provider.name;
 	protected readonly descriptor = provider;
diff --git a/src/plus/ai/openAICompatibleProvider.ts b/src/plus/ai/openAICompatibleProvider.ts
diff --git a/src/plus/ai/openAICompatibleProviderBase.ts b/src/plus/ai/openAICompatibleProviderBase.ts
diff --git a/src/plus/ai/openRouterProvider.ts b/src/plus/ai/openRouterProvider.ts
diff --git a/src/plus/ai/openaiProvider.ts b/src/plus/ai/openaiProvider.ts
diff --git a/src/plus/ai/utils/-webview/ai.utils.ts b/src/plus/ai/utils/-webview/ai.utils.ts
diff --git a/src/plus/ai/xaiProvider.ts b/src/plus/ai/xaiProvider.ts
