fix: import LanguageModelChat from @types/vscode (#80)

* docs: update examples for rendering prompts * fix: import `LanguageModelChat` from `@vscode/types`
microsoft · Sep 3, 2024 · e0bc4ac · e0bc4ac
1 parent a618ce9
commit e0bc4ac
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -58,11 +58,10 @@ Note: if your codebase depends on both `@vscode/prompt-tsx` and another library
 
 Next, your extension can use `renderPrompt` to render a TSX prompt. Here is an example of using TSX prompts in a Copilot chat participant that suggests SQL queries based on database context:
 ```ts
-import { renderPrompt, Cl100KBaseTokenizer } from '@vscode/prompt-tsx';
+import { renderPrompt } from '@vscode/prompt-tsx';
 import * as vscode from 'vscode';
 import { TestPrompt } from './prompt';
 
-const tokenizer = new Cl100KBaseTokenizer();
 const participant = vscode.chat.createChatParticipant(
   "mssql",
   async (
@@ -73,19 +72,22 @@ const participant = vscode.chat.createChatParticipant(
   ) => {
     response.progress("Reading database context...");
 
+    const models = await vscode.lm.selectChatModels({ family: 'gpt-4' });
+    if (models.length === 0) {
+      // No models available, return early
+      return;
+    }
+    const chatModel = models[0];
+
     // Render TSX prompt
     const { messages } = await renderPrompt(
       TestPrompt,
       { userQuery: request.prompt },
       { modelMaxPromptTokens: 4096 },
-      tokenizer
+      chatModel
     );
-    const models = await vscode.lm.selectChatModels({ family: 'gpt-4' });
-    if (models.length === 0) {
-      // No models available, return early
-      return;
-    }
-    const chatRequest = await models[0].sendChatRequest(
+
+    const chatRequest = await chatModel.sendChatRequest(
       messages,
       {},
       token
@@ -112,11 +114,12 @@ export interface PromptState {
 
 export class TestPrompt extends PromptElement<PromptProps, PromptState> {
     override async prepare() {
+      }
+
+    async render(state: PromptState, sizing: PromptSizing) {
         const sqlExtensionApi = await vscode.extensions.getExtension('ms-mssql.mssql')?.activate();
-        return { creationScript: await sqlExtensionApi.getDatabaseCreateScript?.() };
-    }
+        const creationScript = await sqlExtensionApi.getDatabaseCreateScript?.();
 
-    render(state: PromptState, sizing: PromptSizing) {
         return (
             <>
                 <AssistantMessage>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@vscode/prompt-tsx",
-	"version": "0.2.7-alpha",
+	"version": "0.2.8-alpha",
 	"description": "Declare LLM prompts with TSX",
 	"main": "./dist/base/index.js",
 	"types": "./dist/base/index.d.ts",
@@ -23,7 +23,7 @@
 		"@types/node": "^20.11.30",
 		"@vscode/test-cli": "^0.0.9",
 		"@vscode/test-electron": "^2.4.1",
-		"@types/vscode": "^1.89.0",
+		"@types/vscode": "^1.92.0",
 		"esbuild": "0.20.2",
 		"mocha": "^10.2.0",
 		"npm-dts": "^1.3.12",

diff --git a/src/base/index.ts b/src/base/index.ts
@@ -2,14 +2,14 @@
  *  Copyright (c) Microsoft Corporation and GitHub. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
-import type { CancellationToken, Progress } from 'vscode';
+import type { CancellationToken, ChatResponsePart, LanguageModelChat, Progress } from 'vscode';
 import { PromptElementJSON } from './jsonTypes';
 import { ChatMessage, ChatRole } from './openai';
 import { MetadataMap, PromptRenderer } from './promptRenderer';
 import { PromptReference } from './results';
 import { AnyTokenizer, ITokenizer } from './tokenizer/tokenizer';
 import { BasePromptElementProps, IChatEndpointInfo, PromptElementCtor } from './types';
-import { ChatDocumentContext, ChatResponsePart, LanguageModelChat, LanguageModelChatMessage } from './vscodeTypes.d';
+import { ChatDocumentContext, LanguageModelChatMessage } from './vscodeTypes.d';
 
 export * as JSONTree from './jsonTypes';
 export { AssistantChatMessage, ChatMessage, ChatRole, FunctionChatMessage, SystemChatMessage, ToolChatMessage, UserChatMessage } from './openai';

diff --git a/src/base/tsx-globals.ts b/src/base/tsx-globals.ts
@@ -2,7 +2,7 @@
  *  Copyright (c) Microsoft Corporation and GitHub. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
-import { PieceJSON, PromptElementJSON } from './jsonTypes';
+import { PromptElementJSON } from './jsonTypes';
 import { PromptMetadata, PromptReference } from './results';
 import { URI } from './util/vs/common/uri';
 import { ChatDocumentContext } from './vscodeTypes';

diff --git a/src/base/vscodeTypes.d.ts b/src/base/vscodeTypes.d.ts
@@ -2,7 +2,7 @@
  *  Copyright (c) Microsoft Corporation and GitHub. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
-import type { CancellationToken, Command, Location, MarkdownString, ProviderResult, Range, ThemeIcon, Uri } from 'vscode';
+import type { CancellationToken, Command, Location, MarkdownString, ProviderResult, ThemeIcon, Uri } from 'vscode';
 
 /**
  * Represents a part of a chat response that is formatted as Markdown.