|
| 1 | +/*--------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | + * Licensed under the MIT License. See License.txt in the project root for license information. |
| 4 | + *--------------------------------------------------------------------------------------------*/ |
| 5 | +import { env, QuickPick, QuickPickItem, QuickPickItemKind, Uri, window, workspace } from 'vscode'; |
| 6 | +import { IInstantiationService, ServicesAccessor } from '../../../../../util/vs/platform/instantiation/common/instantiation'; |
| 7 | +import { ConfigKey, getConfig } from '../../lib/src/config'; |
| 8 | +import { CopilotConfigPrefix } from '../../lib/src/constants'; |
| 9 | +import { ICompletionsContextService } from '../../lib/src/context'; |
| 10 | +import { AsyncCompletionManager } from '../../lib/src/ghostText/asyncCompletions'; |
| 11 | +import { CompletionsCache } from '../../lib/src/ghostText/completionsCache'; |
| 12 | +import { Logger, LogTarget } from '../../lib/src/logger'; |
| 13 | +import { AvailableModelsManager, ModelItem } from '../../lib/src/openai/model'; |
| 14 | +import { telemetry, TelemetryData } from '../../lib/src/telemetry'; |
| 15 | +const logger = new Logger('modelPicker'); |
| 16 | + |
| 17 | +interface ModelPickerItem extends Omit<ModelItem, 'preview' | 'tokenizer'>, QuickPickItem { |
| 18 | + // Distinguish between items in the quick pick |
| 19 | + type: 'model' | 'separator' | 'learn-more'; |
| 20 | +} |
| 21 | + |
| 22 | +// Separator and learn-more links are always shown in the quick pick |
| 23 | +const defaultModelPickerItems: ModelPickerItem[] = [ |
| 24 | + // Add separator after the models |
| 25 | + { |
| 26 | + label: '', |
| 27 | + kind: QuickPickItemKind.Separator, |
| 28 | + modelId: 'separator', |
| 29 | + type: 'separator' as const, |
| 30 | + alwaysShow: true, |
| 31 | + }, |
| 32 | + // Add "Learn more" item at the end |
| 33 | + { |
| 34 | + modelId: 'learn-more', |
| 35 | + label: 'Learn more $(link-external)', |
| 36 | + description: '', |
| 37 | + alwaysShow: true, |
| 38 | + type: 'learn-more' as const, |
| 39 | + }, |
| 40 | +]; |
| 41 | + |
| 42 | +export class ModelPickerManager { |
| 43 | + // URL for information about Copilot models |
| 44 | + private readonly MODELS_INFO_URL = 'https://aka.ms/CopilotCompletionsModelPickerLearnMore'; |
| 45 | + |
| 46 | + get models(): ModelItem[] { |
| 47 | + return this._ctx.get(AvailableModelsManager).getGenericCompletionModels(); |
| 48 | + } |
| 49 | + |
| 50 | + private getDefaultModelId(): string { |
| 51 | + return this._ctx.get(AvailableModelsManager).getDefaultModelId(); |
| 52 | + } |
| 53 | + |
| 54 | + constructor( |
| 55 | + @IInstantiationService private readonly _instantiationService: IInstantiationService, |
| 56 | + @ICompletionsContextService private readonly _ctx: ICompletionsContextService |
| 57 | + ) { } |
| 58 | + |
| 59 | + async setUserSelectedCompletionModel(modelId: string | null) { |
| 60 | + return workspace |
| 61 | + .getConfiguration(CopilotConfigPrefix) |
| 62 | + .update(ConfigKey.UserSelectedCompletionModel, modelId ?? '', true); |
| 63 | + } |
| 64 | + |
| 65 | + async handleModelSelection(quickpickList: QuickPick<ModelPickerItem>) { |
| 66 | + const model = quickpickList.activeItems[0]; |
| 67 | + if (model === undefined) { |
| 68 | + return; |
| 69 | + } |
| 70 | + quickpickList.hide(); |
| 71 | + |
| 72 | + // Open up the link |
| 73 | + if (model.type === 'learn-more') { |
| 74 | + await env.openExternal(Uri.parse(this.MODELS_INFO_URL)); |
| 75 | + this._instantiationService.invokeFunction(telemetry, 'modelPicker.learnMoreClicked'); |
| 76 | + return; |
| 77 | + } |
| 78 | + |
| 79 | + await this.selectModel(model); |
| 80 | + } |
| 81 | + |
| 82 | + async selectModel(model: ModelPickerItem) { |
| 83 | + const currentModel = this._instantiationService.invokeFunction(getUserSelectedModelConfiguration); |
| 84 | + |
| 85 | + if (currentModel !== model.modelId) { |
| 86 | + this._ctx.get(CompletionsCache).clear(); |
| 87 | + this._ctx.get(AsyncCompletionManager).clear(); |
| 88 | + } |
| 89 | + |
| 90 | + const modelSelection = model.modelId === this.getDefaultModelId() ? null : model.modelId; |
| 91 | + await this.setUserSelectedCompletionModel(modelSelection); |
| 92 | + const logTarget = this._ctx.get(LogTarget); |
| 93 | + if (modelSelection === null) { |
| 94 | + logger.info(logTarget, `User selected default model; setting null`); |
| 95 | + } else { |
| 96 | + logger.info(logTarget, `Selected model: ${model.modelId}`); |
| 97 | + } |
| 98 | + |
| 99 | + this._instantiationService.invokeFunction( |
| 100 | + telemetry, |
| 101 | + 'modelPicker.modelSelected', |
| 102 | + TelemetryData.createAndMarkAsIssued({ |
| 103 | + engineName: modelSelection ?? 'default', |
| 104 | + }) |
| 105 | + ); |
| 106 | + } |
| 107 | + |
| 108 | + private modelsForModelPicker(): [string | null, ModelPickerItem[]] { |
| 109 | + const currentModelSelection = this._instantiationService.invokeFunction(getUserSelectedModelConfiguration); |
| 110 | + const items: ModelPickerItem[] = this.models.map(model => { |
| 111 | + return { |
| 112 | + modelId: model.modelId, |
| 113 | + label: `${model.label}${model.preview ? ' (Preview)' : ''}`, |
| 114 | + description: `(${model.modelId})`, |
| 115 | + alwaysShow: model.modelId === this.getDefaultModelId(), |
| 116 | + type: 'model' as const, |
| 117 | + }; |
| 118 | + }); |
| 119 | + |
| 120 | + return [currentModelSelection, items]; |
| 121 | + } |
| 122 | + |
| 123 | + showModelPicker(): QuickPick<ModelPickerItem> { |
| 124 | + const [currentModelSelection, items] = this.modelsForModelPicker(); |
| 125 | + |
| 126 | + const quickPick = window.createQuickPick<ModelPickerItem>(); |
| 127 | + quickPick.title = 'Change Completions Model'; |
| 128 | + quickPick.items = [...items, ...defaultModelPickerItems]; |
| 129 | + quickPick.onDidAccept(() => this.handleModelSelection(quickPick)); |
| 130 | + |
| 131 | + const currentModelOrDefault = currentModelSelection ?? this.getDefaultModelId(); |
| 132 | + |
| 133 | + // set the currently selected model as active |
| 134 | + const selectedItem = quickPick.items.find(item => item.modelId === currentModelOrDefault); |
| 135 | + if (selectedItem) { |
| 136 | + quickPick.activeItems = [selectedItem]; |
| 137 | + } |
| 138 | + |
| 139 | + quickPick.show(); |
| 140 | + return quickPick; |
| 141 | + } |
| 142 | +} |
| 143 | + |
| 144 | +function getUserSelectedModelConfiguration(accessor: ServicesAccessor): string | null { |
| 145 | + const value = getConfig<string | null>(accessor, ConfigKey.UserSelectedCompletionModel); |
| 146 | + return typeof value === 'string' && value.length > 0 ? value : null; |
| 147 | +} |
0 commit comments