fix: use metadata for consistency (#127)

* chore: update package.json links with public repo * fix: use `metadata` for consistency Fixes #119
microsoft · Oct 31, 2024 · 089ff32 · 089ff32
1 parent 8a504bb
commit 089ff32
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/src/base/index.ts b/src/base/index.ts
@@ -71,7 +71,9 @@ export async function renderPrompt<P extends BasePromptElementProps>(
 ): Promise<{
 	messages: LanguageModelChatMessage[];
 	tokenCount: number;
+	/** @deprecated use {@link metadata} */
 	metadatas: MetadataMap;
+	metadata: MetadataMap;
 	usedContext: ChatDocumentContext[];
 	references: PromptReference[];
 }>;
@@ -99,7 +101,9 @@ export async function renderPrompt<P extends BasePromptElementProps>(
 ): Promise<{
 	messages: ChatMessage[];
 	tokenCount: number;
+	/** @deprecated use {@link metadata} */
 	metadatas: MetadataMap;
+	metadata: MetadataMap;
 	usedContext: ChatDocumentContext[];
 	references: PromptReference[];
 }>;
@@ -114,7 +118,9 @@ export async function renderPrompt<P extends BasePromptElementProps>(
 ): Promise<{
 	messages: (ChatMessage | LanguageModelChatMessage)[];
 	tokenCount: number;
+	/** @deprecated use {@link metadata} */
 	metadatas: MetadataMap;
+	metadata: MetadataMap;
 	usedContext: ChatDocumentContext[];
 	references: PromptReference[];
 }> {
@@ -130,7 +136,7 @@ export async function renderPrompt<P extends BasePromptElementProps>(
 		messages = toVsCodeChatMessages(messages);
 	}
 
-	return { messages, tokenCount, metadatas: metadata, usedContext, references };
+	return { messages, tokenCount, metadatas: metadata, metadata, usedContext, references };
 }
 
 /**