@codingame/monaco-vscode-api 34.1.2 → 35.0.0

package/vscode/src/vs/workbench/contrib/chat/common/languageModels.d.ts

@@ -12,11 +12,14 @@ import { URI } from "../../../../base/common/uri.js";
 import { IContextKeyService } from "../../../../platform/contextkey/common/contextkey.service.js";
 import { ExtensionIdentifier } from "../../../../platform/extensions/common/extensions.js";
 import { ILogService } from "../../../../platform/log/common/log.service.js";
+import { INotificationService } from "../../../../platform/notification/common/notification.service.js";
+import { IOpenerService } from "../../../../platform/opener/common/opener.service.js";
 import { IProductService } from "../../../../platform/product/common/productService.service.js";
 import { IRequestService } from "../../../../platform/request/common/request.service.js";
 import { IQuickInputService } from "../../../../platform/quickinput/common/quickInput.service.js";
 import { ISecretStorageService } from "../../../../platform/secrets/common/secrets.service.js";
 import { IStorageService } from "../../../../platform/storage/common/storage.service.js";
+import { ITelemetryService } from "../../../../platform/telemetry/common/telemetry.service.js";
 import { IExtensionService } from "../../../services/extensions/common/extensions.service.js";
 import { ChatAgentLocation } from "./constants.js";
 import { ILanguageModelsProviderGroup } from "./languageModelsConfiguration.js";
@@ -27,6 +30,19 @@ import { ILanguageModelsService } from "./languageModels.service.js";
  * vendor across the chat stack (see `ILanguageModelProviderDescriptor.isDefault`).
  */
 export declare const COPILOT_VENDOR_ID = "copilot";
+/**
+ * Bucket reported for any non-Copilot provider that is not an in-built BYOK provider, i.e. a model
+ * contributed by a third-party extension. We never report the third-party vendor id directly to avoid
+ * logging potentially identifying values.
+ */
+export declare const THIRD_PARTY_PROVIDER_TELEMETRY_NAME = "3p-extension";
+/**
+ * Normalizes a non-Copilot model vendor into a non-identifying provider name suitable for telemetry:
+ * the in-built BYOK vendor id (e.g. `openai`, `ollama`) when contributed by the built-in Copilot
+ * extensions, or {@link THIRD_PARTY_PROVIDER_TELEMETRY_NAME} otherwise. Returns `undefined` for the
+ * first-party Copilot vendor (or no vendor) so callers skip logging first-party usage.
+ */
+export declare function getByokProviderTelemetryName(vendor: string | undefined, extension: ExtensionIdentifier | undefined): string | undefined;
 export declare enum ChatMessageRole {
     System = 0,
     User = 1,
@@ -157,14 +173,18 @@ export interface ILanguageModelChatMetadata {
     readonly tooltip?: string;
     readonly detail?: string;
     readonly multiplierNumeric?: number;
+    readonly isBYOK?: boolean;
     readonly pricing?: string;
     readonly inputCost?: number;
     readonly cacheCost?: number;
+    readonly cacheWriteCost?: number;
     readonly outputCost?: number;
     readonly longContextInputCost?: number;
     readonly longContextCacheCost?: number;
+    readonly longContextCacheWriteCost?: number;
     readonly longContextOutputCost?: number;
     readonly priceCategory?: string;
+    readonly category?: string;
     readonly family: string;
     readonly maxInputTokens: number;
     readonly maxOutputTokens: number;
@@ -189,16 +209,46 @@ export interface ILanguageModelChatMetadata {
      * when the user is in a session matching this type.
      */
     readonly targetChatSessionType?: string;
+    /**
+     * Optional grouping hint for the model picker. When set, the picker buckets this model
+     * under a sub-group within its vendor, identified by this vendor id — e.g. agent-host models,
+     * which all share one vendor, grouped by their upstream provider — instead of a single
+     * vendor-wide bucket. The display name is resolved from the vendor registry
+     * ({@link ILanguageModelsService.getVendors}), the same source used for every other vendor.
+     * Presentation-only; it does not affect model selection or routing.
+     */
+    readonly modelGroup?: {
+        readonly id: string;
+    };
     /**
      * An optional JSON schema describing the per-model configuration options.
      * Used to validate user-provided per-model configuration in `chatLanguageModels.json`.
      */
     readonly configurationSchema?: ILanguageModelConfigurationSchema;
+    /**
+     * Optional warning text to display in the model picker hover as a warning banner.
+     * The keys are warning categories (e.g. "data_retention") and the values are markdown strings.
+     */
+    readonly warningText?: IStringDictionary<string>;
 }
 export declare namespace ILanguageModelChatMetadata {
     function suitableForAgentMode(metadata: ILanguageModelChatMetadata): boolean;
     function asQualifiedName(metadata: ILanguageModelChatMetadata): string;
     function matchesQualifiedName(name: string, metadata: ILanguageModelChatMetadata): boolean;
+    /**
+     * Documentation link explaining how Auto model selection works.
+     * NOTE: Also defined in extensions/copilot/src/extension/conversation/common/languageModelAccess.ts — keep in sync.
+     */
+    const autoModelSelectionDocsUrl = "https://docs.github.com/en/copilot/concepts/models/auto-model-selection";
+    /**
+     * Builds the shared description shown for the Auto model, rendered as Markdown
+     * (it contains a "Learn More" link). The discount sentence is only included
+     * when a positive discount is provided.
+     *
+     * @param discountPercent Whole-number percentage (e.g. `10` for 10%). When
+     * omitted or not positive, the discount sentence is left out entirely.
+     */
+    function getAutoModelDescription(discountPercent?: number): string;
 }
 export interface ILanguageModelChatResponse {
     stream: AsyncIterable<IChatResponsePart | IChatResponsePart[]>;
@@ -313,29 +363,53 @@ declare const languageModelChatProviderType: {
             readonly deprecated: true;
             readonly deprecationMessage: string;
         };
+        readonly deprecation: {
+            readonly type: "object";
+            readonly description: string;
+            readonly properties: {
+                readonly link: {
+                    readonly type: "string";
+                    readonly description: string;
+                };
+            };
+        };
         readonly when: {
             readonly type: "string";
             readonly description: string;
         };
     };
 };
-export type IUserFriendlyLanguageModel = TypeFromJsonSchema<typeof languageModelChatProviderType>;
+export type IUserFriendlyLanguageModel = Omit<TypeFromJsonSchema<typeof languageModelChatProviderType>, "deprecation"> & {
+    /**
+     * Marks a provider as deprecated. The Manage Models view renders a link
+     * (pointing to a replacement, e.g. a `vscode:extension/<publisher>.<name>` URI)
+     * next to the provider name. Optional so existing provider descriptors are unaffected.
+     */
+    readonly deprecation?: {
+        readonly link?: string;
+    };
+};
 export interface ILanguageModelProviderDescriptor extends IUserFriendlyLanguageModel {
     readonly isDefault: boolean;
 }
-export declare const languageModelChatProviderExtensionPoint: import("../../../services/extensions/common/extensionsRegistry.js").IExtensionPoint<{
-    readonly vendor: string;
-    readonly displayName: string;
-    readonly configuration: undefined;
-    readonly managementCommand: string | undefined;
-    readonly when: string | undefined;
-} | {
-    readonly vendor: string;
-    readonly displayName: string;
-    readonly configuration: undefined;
-    readonly managementCommand: string | undefined;
-    readonly when: string | undefined;
-}[]>;
+/**
+ * Resolves a provider `deprecation.link` for opening inside the current build. Contributions point
+ * at the replacement extension with a stable `vscode:extension/<id>` URI, but the URL service only
+ * routes URIs whose scheme matches this build's `urlProtocol` (e.g. `code-oss`, `vscode-insiders`).
+ * The `vscode:` scheme is therefore rewritten to the current protocol so the extensions URL handler
+ * opens the extension; without this the opener falls back to treating the URI as a (non-existent)
+ * file resource and fails. Other schemes (http(s), command) are returned unchanged.
+ */
+export declare function resolveProviderDeprecationLink(link: string, urlProtocol: string | undefined): URI;
+export declare const languageModelChatProviderExtensionPoint: import("../../../services/extensions/common/extensionsRegistry.js").IExtensionPoint<IUserFriendlyLanguageModel | IUserFriendlyLanguageModel[]>;
+export declare function isAutoLanguageModel(model: ILanguageModelChatMetadataAndIdentifier | undefined): boolean;
+/**
+ * Builds the per-model configuration submenu actions from a model's
+ * {@link ILanguageModelConfigurationSchema}. The current value is read from
+ * `currentConfig` and selections are routed through `setValue`, allowing the
+ * caller to decide whether changes apply globally or to a per-editor override.
+ */
+export declare function createModelConfigurationActions(schema: ILanguageModelConfigurationSchema | undefined, currentConfig: IStringDictionary<unknown>, setValue: (key: string, value: unknown) => void): IAction[];
 export declare class LanguageModelsService implements ILanguageModelsService {
     private readonly _extensionService;
     private readonly _logService;
@@ -346,12 +420,17 @@ export declare class LanguageModelsService implements ILanguageModelsService {
     private readonly _secretStorageService;
     private readonly _productService;
     private readonly _requestService;
+    private readonly _notificationService;
+    private readonly _openerService;
+    private readonly _telemetryService;
     private static SECRET_KEY_PREFIX;
     private static SECRET_INPUT;
     readonly _serviceBrand: undefined;
     private readonly _store;
     private readonly _providers;
     private readonly _vendors;
+    /** Vendors for which a deprecation notice has already been shown this session. */
+    private readonly _deprecationNoticeShownVendors;
     private readonly _onDidChangeLanguageModelVendors;
     readonly onDidChangeLanguageModelVendors: Event<string[]>;
     private readonly _modelsGroups;
@@ -379,7 +458,7 @@ export declare class LanguageModelsService implements ILanguageModelsService {
     readonly restrictedChatParticipants: IObservable<{
         [name: string]: string[];
     }>;
-    constructor(_extensionService: IExtensionService, _logService: ILogService, _storageService: IStorageService, _contextKeyService: IContextKeyService, _languageModelsConfigurationService: ILanguageModelsConfigurationService, _quickInputService: IQuickInputService, _secretStorageService: ISecretStorageService, _productService: IProductService, _requestService: IRequestService);
+    constructor(_extensionService: IExtensionService, _logService: ILogService, _storageService: IStorageService, _contextKeyService: IContextKeyService, _languageModelsConfigurationService: ILanguageModelsConfigurationService, _quickInputService: IQuickInputService, _secretStorageService: ISecretStorageService, _productService: IProductService, _requestService: IRequestService, _notificationService: INotificationService, _openerService: IOpenerService, _telemetryService: ITelemetryService);
     deltaLanguageModelChatProviderDescriptors(added: IUserFriendlyLanguageModel[], removed: IUserFriendlyLanguageModel[]): void;
     private _onDidChangeLanguageModelGroups;
     getVendors(): ILanguageModelProviderDescriptor[];
@@ -393,6 +472,18 @@ export declare class LanguageModelsService implements ILanguageModelsService {
     selectLanguageModels(selector: ILanguageModelChatSelector): Promise<string[]>;
     registerLanguageModelProvider(vendor: string, provider: ILanguageModelChatProvider): IDisposable;
     sendChatRequest(modelId: string, from: ExtensionIdentifier | undefined, messages: IChatMessage[], options: ILanguageModelChatRequestOptions, token: CancellationToken): Promise<ILanguageModelChatResponse>;
+    /**
+     * When a chat request is made against a deprecated provider (one that contributes a
+     * `deprecation.link`), prompt the user once per session to install the replacement
+     * extension. The notification can be dismissed, and offers a "Don't Show Again" choice that
+     * is persisted across sessions via the notification service's `neverShowAgain` support.
+     */
+    private _maybeShowProviderDeprecationNotice;
+    /**
+     * Reports which in-built BYOK provider (or third-party extension) backs a model request. First-party
+     * Copilot models are intentionally not reported here (see {@link getByokProviderTelemetryName}).
+     */
+    private _logProviderUsageTelemetry;
     private _resolveModelConfigurationWithDefaults;
     computeTokenLength(modelId: string, message: string | IChatMessage, token: CancellationToken): Promise<number>;
     getModelConfiguration(modelId: string): IStringDictionary<unknown> | undefined;