bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-04-27 16:55:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update chat provider sample (#1216)

Browse Source
This commit is contained in:
Logan Ramos
2025-09-08 10:40:36 -04:00
committed by GitHub
parent cb3a06c814
commit d8963c1c37
2 changed files with 27 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
chat-model-provider-sample/src/provider.ts
View File

@ -1,4 +1,4 @@
import { CancellationToken, LanguageModelChatInformation, LanguageModelChatMessage, LanguageModelChatProvider, LanguageModelChatRequestHandleOptions, LanguageModelResponsePart, LanguageModelTextPart, Progress, ProviderResult } from "vscode";
import { CancellationToken, LanguageModelChatInformation, LanguageModelChatMessage, LanguageModelChatProvider, LanguageModelResponsePart, LanguageModelTextPart, Progress, ProvideLanguageModelChatResponseOptions, ProviderResult } from "vscode";
function getChatModelInfo(id: string, name: string): LanguageModelChatInformation {
return {
@ -17,13 +17,13 @@ function getChatModelInfo(id: string, name: string): LanguageModelChatInformatio
}
export class SampleChatModelProvider implements LanguageModelChatProvider {
prepareLanguageModelChatInformation(_options: { silent: boolean; }, _token: CancellationToken): ProviderResult<LanguageModelChatInformation[]> {
provideLanguageModelChatInformation(_options: { silent: boolean; }, _token: CancellationToken): ProviderResult<LanguageModelChatInformation[]> {
return [
getChatModelInfo("sample-dog-model", "Dog Model"),
getChatModelInfo("sample-cat-model", "Cat Model"),
];
}
async provideLanguageModelChatResponse(model: LanguageModelChatInformation, _messages: Array<LanguageModelChatMessage>, _options: LanguageModelChatRequestHandleOptions, progress: Progress<LanguageModelResponsePart>, _token: CancellationToken): Promise<void> {
async provideLanguageModelChatResponse(model: LanguageModelChatInformation, _messages: Array<LanguageModelChatMessage>, _options: ProvideLanguageModelChatResponseOptions, progress: Progress<LanguageModelResponsePart>, _token: CancellationToken): Promise<void> {
if (model.id === "sample-dog-model") {
progress.report(new LanguageModelTextPart("Woof! This is a dog model response."));
} else if (model.id === "sample-cat-model") {

50
chat-model-provider-sample/src/vscode.d.ts vendored
View File

@ -20378,10 +20378,9 @@ declare module 'vscode' {
/**
* The provider version of {@linkcode LanguageModelChatRequestOptions}
*/
export interface LanguageModelChatRequestHandleOptions {
export interface ProvideLanguageModelChatResponseOptions {
/**
* A set of options that control the behavior of the language model. These options are specific to the language model
* and need to be looked up in the respective documentation.
* A set of options that control the behavior of the language model. These options are specific to the language model.
*/
readonly modelOptions?: { readonly [name: string]: any };
@ -20399,13 +20398,13 @@ declare module 'vscode' {
readonly tools?: readonly LanguageModelChatTool[];
/**
* The tool-selecting mode to use. {@link LanguageModelChatToolMode.Auto} by default.
* The tool-selecting mode to use. The provider must implement respecting this.
*/
readonly toolMode?: LanguageModelChatToolMode;
readonly toolMode: LanguageModelChatToolMode;
}
/**
* All the information representing a single language model contributed by a {@linkcode LanguageModelChatProvider}.
* Represents a language model provided by a {@linkcode LanguageModelChatProvider}.
*/
export interface LanguageModelChatInformation {
@ -20421,23 +20420,22 @@ declare module 'vscode' {
/**
* Opaque family-name of the language model. Values might be `gpt-3.5-turbo`, `gpt4`, `phi2`, or `llama`
* but they are defined by extensions contributing languages and subject to change.
*/
readonly family: string;
/**
* The tooltip to render when hovering the model
* The tooltip to render when hovering the model. Used to provide more information about the model.
*/
readonly tooltip?: string;
/**
* An optional, human-readable string which will be rendered alongside the model.
* Useful for distinguishing models of the same name in the UI.
*/
readonly detail?: string;
/**
* Opaque version string of the model. This is defined by the extension contributing the language model
* and subject to change while the identifier is stable.
* Opaque version string of the model.
* This is used as a lookup value in {@linkcode LanguageModelChatSelector.version}
* An example is how GPT 4o has multiple versions like 2024-11-20 and 2024-08-06
*/
@ -20466,7 +20464,7 @@ declare module 'vscode' {
/**
* Whether tool calling is supported by the model.
* If a number is provided, that is the maximum number of tools a model can call.
* If a number is provided, that is the maximum number of tools that can be provided in a request to the model.
*/
readonly toolCalling?: boolean | number;
};
@ -20482,7 +20480,7 @@ declare module 'vscode' {
readonly role: LanguageModelChatMessageRole;
/**
* A string or heterogeneous array of things that a message can contain as content. Some parts may be message-type
* A heterogeneous array of things that a message can contain as content. Some parts may be message-type
* specific for some models.
*/
readonly content: ReadonlyArray<LanguageModelInputPart | unknown>;
@ -20504,23 +20502,23 @@ declare module 'vscode' {
export type LanguageModelInputPart = LanguageModelTextPart | LanguageModelToolResultPart | LanguageModelToolCallPart;
/**
* Represents a Language model chat provider. This provider provides multiple models in a 1 provider to many model relationship
* An example of this would be how an OpenAI provider would provide models like gpt-5, o3, etc.
* A LanguageModelChatProvider implements access to language models, which users can then use through the chat view, or through extension API by acquiring a LanguageModelChat.
* An example of this would be an OpenAI provider that provides models like gpt-5, o3, etc.
*/
export interface LanguageModelChatProvider<T extends LanguageModelChatInformation = LanguageModelChatInformation> {
/**
* Signals a change from the provider to the editor so that {@linkcode prepareLanguageModelChatInformation} is called again
* An optional event fired when the available set of language models changes.
*/
readonly onDidChangeLanguageModelInformation?: Event<void>;
readonly onDidChangeLanguageModelChatInformation?: Event<void>;
/**
* Get the list of available language models contributed by this provider
* Get the list of available language models provided by this provider
* @param options Options which specify the calling context of this function
* @param token A cancellation token which signals if the user cancelled the request or not
* @returns A promise that resolves to the list of available language models
* @param token A cancellation token
* @returns The list of available language models
*/
prepareLanguageModelChatInformation(options: PrepareLanguageModelChatModelOptions, token: CancellationToken): ProviderResult<T[]>;
provideLanguageModelChatInformation(options: PrepareLanguageModelChatModelOptions, token: CancellationToken): ProviderResult<T[]>;
/**
* Returns the response for a chat request, passing the results to the progress callback.
@ -20529,23 +20527,23 @@ declare module 'vscode' {
* @param messages The messages to include in the request
* @param options Options for the request
* @param progress The progress to emit the streamed response chunks to
* @param token A cancellation token for the request
* @param token A cancellation token
* @returns A promise that resolves when the response is complete. Results are actually passed to the progress callback.
*/
provideLanguageModelChatResponse(model: T, messages: readonly LanguageModelChatRequestMessage[], options: LanguageModelChatRequestHandleOptions, progress: Progress<LanguageModelResponsePart>, token: CancellationToken): Thenable<void>;
provideLanguageModelChatResponse(model: T, messages: readonly LanguageModelChatRequestMessage[], options: ProvideLanguageModelChatResponseOptions, progress: Progress<LanguageModelResponsePart>, token: CancellationToken): Thenable<void>;
/**
* Returns the number of tokens for a given text using the model specific tokenizer logic
* Returns the number of tokens for a given text using the model-specific tokenizer logic
* @param model The language model to use
* @param text The text to count tokens for
* @param token A cancellation token for the request
* @returns A promise that resolves to the number of tokens
* @param token A cancellation token
* @returns The number of tokens
*/
provideTokenCount(model: T, text: string | LanguageModelChatRequestMessage, token: CancellationToken): Thenable<number>;
}
/**
* The list of options passed into {@linkcode LanguageModelChatProvider.prepareLanguageModelChatInformation}
* The list of options passed into {@linkcode LanguageModelChatProvider.provideLanguageModelChatInformation}
*/
export interface PrepareLanguageModelChatModelOptions {
/**