microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-30 06:56:29 -05:00
Code Issues Packages Projects Releases 177 Wiki Activity

Avoid "slash command" name in agent API (#202729)

Browse Source 
* Avoid "slash command" name in agent API

* Fix reference

* Fix
This commit is contained in:
Rob Lourens
2024-01-18 17:05:28 -03:00
committed by GitHub
parent fa989a17f1
commit 63349889d9
5 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
extensions/vscode-api-tests/src/singlefolder-tests/chat.test.ts
View File

@@ -35,8 +35,8 @@ suite('chat', () => {
deferred.complete(request);
return null;
});
agent.slashCommandProvider = {
provideSlashCommands: (_token) => {
agent.subCommandProvider = {
provideSubCommands: (_token) => {
return [{ name: 'hello', description: 'Hello' }];
}
};

10
src/vs/workbench/api/common/extHostChatAgents2.ts
View File

@@ -240,8 +240,8 @@ export class ExtHostChatAgents2 implements ExtHostChatAgentsShape2 {
class ExtHostChatAgent<TResult extends vscode.ChatAgentResult2> {
private _slashCommandProvider: vscode.ChatAgentSlashCommandProvider | undefined;
private _lastSlashCommands: vscode.ChatAgentSlashCommand[] | undefined;
private _slashCommandProvider: vscode.ChatAgentSubCommandProvider | undefined;
private _lastSlashCommands: vscode.ChatAgentSubCommand[] | undefined;
private _followupProvider: vscode.FollowupProvider<TResult> | undefined;
private _description: string | undefined;
private _fullName: string | undefined;
@@ -297,7 +297,7 @@ class ExtHostChatAgent<TResult extends vscode.ChatAgentResult2> {
if (!this._slashCommandProvider) {
return [];
}
const result = await this._slashCommandProvider.provideSlashCommands(token);
const result = await this._slashCommandProvider.provideSubCommands(token);
if (!result) {
return [];
}
@@ -385,10 +385,10 @@ class ExtHostChatAgent<TResult extends vscode.ChatAgentResult2> {
that._iconPath = v;
updateMetadataSoon();
},
get slashCommandProvider() {
get subCommandProvider() {
return that._slashCommandProvider;
},
set slashCommandProvider(v) {
set subCommandProvider(v) {
that._slashCommandProvider = v;
updateMetadataSoon();
},

2
src/vs/workbench/api/common/extHostTypeConverters.ts
View File

@@ -2430,7 +2430,7 @@ export namespace ChatResponseProgress {
}
export namespace ChatAgentRequest {
export function to(request: IChatAgentRequest, slashCommand: vscode.ChatAgentSlashCommand | undefined): vscode.ChatAgentRequest {
export function to(request: IChatAgentRequest, slashCommand: vscode.ChatAgentSubCommand | undefined): vscode.ChatAgentRequest {
return {
prompt: request.message,
variables: ChatVariable.objectTo(request.variables),

38
src/vscode-dts/vscode.proposed.chatAgents2.d.ts vendored
View File

@@ -83,12 +83,12 @@ declare module 'vscode' {
readonly kind: ChatAgentResultFeedbackKind;
}
export interface ChatAgentSlashCommand {
export interface ChatAgentSubCommand {
/**
* A short name by which this command is referred to in the UI, e.g. `fix` or
* `explain` for commands that fix an issue or explain code.
*
* **Note**: The name should be unique among the slash commands provided by this agent.
* **Note**: The name should be unique among the subCommands provided by this agent.
*/
readonly name: string;
@@ -98,39 +98,39 @@ declare module 'vscode' {
readonly description: string;
/**
* When the user clicks this slash command in `/help`, this text will be submitted to this slash command
* When the user clicks this subCommand in `/help`, this text will be submitted to this subCommand
*/
readonly sampleRequest?: string;
/**
* Whether executing the command puts the
* chat into a persistent mode, where the
* slash command is prepended to the chat input.
* subCommand is prepended to the chat input.
*/
readonly shouldRepopulate?: boolean;
/**
* Placeholder text to render in the chat input
* when the slash command has been repopulated.
* when the subCommand has been repopulated.
* Has no effect if `shouldRepopulate` is `false`.
*/
// TODO@API merge this with shouldRepopulate? so that invalid state cannot be represented?
readonly followupPlaceholder?: string;
}
export interface ChatAgentSlashCommandProvider {
export interface ChatAgentSubCommandProvider {
/**
* Returns a list of slash commands that its agent is capable of handling. A slash command
* Returns a list of subCommands that its agent is capable of handling. A subCommand
* can be selected by the user and will then be passed to the {@link ChatAgentHandler handler}
* via the {@link ChatAgentRequest.slashCommand slashCommand} property.
* via the {@link ChatAgentRequest.subCommand subCommand} property.
*
*
* @param token A cancellation token.
* @returns A list of slash commands. The lack of a result can be signaled by returning `undefined`, `null`, or
* @returns A list of subCommands. The lack of a result can be signaled by returning `undefined`, `null`, or
* an empty array.
*/
provideSlashCommands(token: CancellationToken): ProviderResult<ChatAgentSlashCommand[]>;
provideSubCommands(token: CancellationToken): ProviderResult<ChatAgentSubCommand[]>;
}
// TODO@API This should become a progress type, and use vscode.Command
@@ -208,9 +208,9 @@ declare module 'vscode' {
} | ThemeIcon;
/**
* This provider will be called to retrieve the agent's slash commands.
* This provider will be called to retrieve the agent's subCommands.
*/
slashCommandProvider?: ChatAgentSlashCommandProvider;
subCommandProvider?: ChatAgentSubCommandProvider;
/**
* This provider will be called once after each request to retrieve suggested followup questions.
@@ -218,7 +218,7 @@ declare module 'vscode' {
followupProvider?: FollowupProvider<TResult>;
/**
* When the user clicks this agent in `/help`, this text will be submitted to this slash command
* When the user clicks this agent in `/help`, this text will be submitted to this subCommand
*/
sampleRequest?: string;
@@ -240,10 +240,10 @@ declare module 'vscode' {
export interface ChatAgentRequest {
/**
* The prompt entered by the user. The {@link ChatAgent2.name name} of the agent or the {@link ChatAgentSlashCommand.name slash command}
* The prompt entered by the user. The {@link ChatAgent2.name name} of the agent or the {@link ChatAgentSubCommand.name subCommand}
* are not part of the prompt.
*
* @see {@link ChatAgentRequest.slashCommand}
* @see {@link ChatAgentRequest.subCommand}
*/
prompt: string;
@@ -253,14 +253,14 @@ declare module 'vscode' {
agentId: string;
/**
* The {@link ChatAgentSlashCommand slash command} that was selected for this request. It is guaranteed that the passed slash
* command is an instance that was previously returned from the {@link ChatAgentSlashCommandProvider.provideSlashCommands slash command provider}.
* The {@link ChatAgentSubCommand subCommand} that was selected for this request. It is guaranteed that the passed subCommand
* is an instance that was previously returned from the {@link ChatAgentSubCommandProvider.provideSubCommands subCommand provider}.
* @deprecated this will be replaced by `subCommand`
*/
slashCommand?: ChatAgentSlashCommand;
slashCommand?: ChatAgentSubCommand;
/**
* The name of the {@link ChatAgentSlashCommand slash command} that was selected for this request.
* The name of the {@link ChatAgentSubCommand subCommand} that was selected for this request.
*/
subCommand?: string;

2
src/vscode-dts/vscode.proposed.chatAgents2Additions.d.ts vendored
View File

@@ -26,7 +26,7 @@ declare module 'vscode' {
export interface ChatAgentDetectedAgent {
agentName: string;
command?: ChatAgentSlashCommand;
command?: ChatAgentSubCommand;
}
export interface ChatAgentVulnerability {