vscode-extension-samples/chat-sample/vscode.proposed.chatTools.d.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

declare module 'vscode' {

	export namespace lm {
		/**
		 * Register a LanguageModelTool. The tool must also be registered in the package.json `languageModelTools` contribution point.
		 */
		export function registerTool(toolId: string, tool: LanguageModelTool): Disposable;

		/**
		 * A list of all available tools.
		 */
		export const tools: ReadonlyArray<LanguageModelToolDescription>;

		/**
		 * Invoke a tool with the given parameters.
		 */
		export function invokeTool(toolId: string, parameters: Object, token: CancellationToken): Thenable<string>;
	}

	export interface LanguageModelToolDescription {
		id: string;
		description: string;
		parametersSchema?: JSONSchema;
		displayName?: string;
	}

	export interface LanguageModelTool {
		invoke(parameters: any, token: CancellationToken): Thenable<string>;
	}
}