Add error message for tools (#1163)

* feat: add error message for tools

* lint

---------

Co-authored-by: Nathan Sarrazin <[email protected]>

src/lib/components/OpenWebSearchResults.svelte

@@ -16,7 +16,10 @@
 	$: lastMessage = webSearchMessages
 		.filter((update) => update.subtype !== MessageWebSearchUpdateType.Sources)
 		.at(-1) as MessageWebSearchUpdate;
-	$: loading = !sources && lastMessage.subtype !== MessageWebSearchUpdateType.Error;
+	$: errored = webSearchMessages.some(
+		(update) => update.subtype === MessageWebSearchUpdateType.Error
+	);
+	$: loading = !sources && !errored;
 </script>
 
 <details

src/lib/components/chat/ChatMessage.svelte

@@ -29,7 +29,11 @@
 		type MessageWebSearchSourcesUpdate,
 		type MessageWebSearchUpdate,
 	} from "$lib/types/MessageUpdate";
-	import { isMessageToolCallUpdate, isMessageToolResultUpdate } from "$lib/utils/messageUpdates";
+	import {
+		isMessageToolCallUpdate,
+		isMessageToolResultUpdate,
+		isMessageToolErrorUpdate,
+	} from "$lib/utils/messageUpdates";
 	import type { ToolFront } from "$lib/types/Tool";
 	import { base } from "$app/paths";
 	import { useConvTreeStore } from "$lib/stores/convTree";
@@ -287,6 +291,7 @@
 				{#each Object.values(toolUpdates) as tool}
 					{#if tool.length}
 						{@const toolName = tool.find(isMessageToolCallUpdate)?.call.name}
+						{@const toolError = tool.some(isMessageToolErrorUpdate)}
 						{@const toolDone = tool.some(isMessageToolResultUpdate)}
 						{#if toolName && toolName !== "websearch"}
 							<details
@@ -301,7 +306,7 @@
 									>
 										<svg
 											class="absolute inset-0 text-purple-500/40 transition-opacity"
-											class:invisible={toolDone}
+											class:invisible={toolDone || toolError}
 											width="22"
 											height="22"
 											viewBox="0 0 38 38"
@@ -321,7 +326,7 @@
 									</div>
 
 									<span>
-										{toolDone ? "Called" : "Calling"} tool
+										{toolError ? "Error calling" : toolDone ? "Called" : "Calling"} tool
 										<span class="font-semibold"
 											>{availableTools.find((el) => toolHasName(toolName, el))?.displayName}</span
 										>
@@ -341,6 +346,12 @@
 												</li>
 											{/each}
 										</ul>
+									{:else if toolUpdate.subtype === MessageToolUpdateType.Error}
+										<div class="mt-1 flex items-center gap-2 opacity-80">
+											<h3 class="text-sm">Error</h3>
+											<div class="h-px flex-1 bg-gradient-to-r from-gray-500/20" />
+										</div>
+										<p class="text-sm">{toolUpdate.message}</p>
 									{/if}
 								{/each}
 							</details>

src/lib/server/textGeneration/tools.ts

@@ -69,19 +69,38 @@ async function* runTool(
 		call,
 	};
 	try {
-		const toolResult = yield* tool.call(call.parameters, {
-			conv,
-			messages,
-			preprompt,
-			assistant,
-		});
-		yield {
-			type: MessageUpdateType.Tool,
-			subtype: MessageToolUpdateType.Result,
-			uuid,
-			result: { ...toolResult, call } as ToolResult,
-		};
-		return { ...toolResult, call } as ToolResult;
+		try {
+			const toolResult = yield* tool.call(call.parameters, {
+				conv,
+				messages,
+				preprompt,
+				assistant,
+			});
+			if (toolResult.status === ToolResultStatus.Error) {
+				yield {
+					type: MessageUpdateType.Tool,
+					subtype: MessageToolUpdateType.Error,
+					uuid,
+					message: toolResult.message,
+				};
+			} else {
+				yield {
+					type: MessageUpdateType.Tool,
+					subtype: MessageToolUpdateType.Result,
+					uuid,
+					result: { ...toolResult, call } as ToolResult,
+				};
+			}
+
+			return { ...toolResult, call } as ToolResult;
+		} catch (e) {
+			yield {
+				type: MessageUpdateType.Tool,
+				subtype: MessageToolUpdateType.Error,
+				uuid,
+				message: e instanceof Error ? e.message : String(e),
+			};
+		}
 	} catch (cause) {
 		console.error(Error(`Failed while running tool ${call.name}`), { cause });
 		return {

src/lib/server/tools/index.ts

@@ -2,7 +2,7 @@ import type { Assistant } from "$lib/types/Assistant";
 import type { Conversation } from "$lib/types/Conversation";
 import type { Message } from "$lib/types/Message";
 import type { MessageUpdate } from "$lib/types/MessageUpdate";
-import type { Tool, ToolResult } from "$lib/types/Tool";
+import type { Tool, ToolResultError, ToolResultSuccess } from "$lib/types/Tool";
 
 import calculator from "./calculator";
 import directlyAnswer from "./directlyAnswer";
@@ -19,11 +19,17 @@ export interface BackendToolContext {
 	assistant?: Pick<Assistant, "rag" | "dynamicPrompt" | "generateSettings">;
 }
 
+// typescript can't narrow a discriminated union after applying a generic like Omit to it
+// so we have to define the omitted types and create a new union
+type ToolResultSuccessOmitted = Omit<ToolResultSuccess, "call">;
+type ToolResultErrorOmitted = Omit<ToolResultError, "call">;
+type ToolResultOmitted = ToolResultSuccessOmitted | ToolResultErrorOmitted;
+
 export interface BackendTool extends Tool {
 	call(
 		params: Record<string, string | number | boolean>,
 		context: BackendToolContext
-	): AsyncGenerator<MessageUpdate, Omit<ToolResult, "call">, undefined>;
+	): AsyncGenerator<MessageUpdate, ToolResultOmitted, undefined>;
 }
 
 export const allTools: BackendTool[] = [

src/lib/types/MessageUpdate.ts

@@ -74,6 +74,8 @@ export enum MessageToolUpdateType {
 	Call = "call",
 	/** The result of a tool call */
 	Result = "result",
+	/** Error while running tool */
+	Error = "error",
 }
 interface MessageToolBaseUpdate<TSubType extends MessageToolUpdateType> {
 	type: MessageUpdateType.Tool;
@@ -87,7 +89,13 @@ export interface MessageToolResultUpdate
 	extends MessageToolBaseUpdate<MessageToolUpdateType.Result> {
 	result: ToolResult;
 }
-export type MessageToolUpdate = MessageToolCallUpdate | MessageToolResultUpdate;
+export interface MessageToolErrorUpdate extends MessageToolBaseUpdate<MessageToolUpdateType.Error> {
+	message: string;
+}
+export type MessageToolUpdate =
+	| MessageToolCallUpdate
+	| MessageToolResultUpdate
+	| MessageToolErrorUpdate;
 
 // Everything else
 export interface MessageTitleUpdate {

src/lib/types/Tool.ts

@@ -31,13 +31,13 @@ export enum ToolResultStatus {
 	Success = "success",
 	Error = "error",
 }
-interface ToolResultSuccess {
+export interface ToolResultSuccess {
 	status: ToolResultStatus.Success;
 	call: ToolCall;
 	outputs: Record<string, unknown>[];
 	display?: boolean;
 }
-interface ToolResultError {
+export interface ToolResultError {
 	status: ToolResultStatus.Error;
 	call: ToolCall;
 	message: string;

src/lib/utils/messageUpdates.ts

@@ -11,6 +11,8 @@ import {
 	type MessageWebSearchSourcesUpdate,
 	type MessageWebSearchErrorUpdate,
 	MessageWebSearchUpdateType,
+	type MessageToolErrorUpdate,
+	type MessageToolResultUpdate,
 } from "$lib/types/MessageUpdate";
 
 export const isMessageWebSearchUpdate = (update: MessageUpdate): update is MessageWebSearchUpdate =>
@@ -32,8 +34,12 @@ export const isMessageToolUpdate = (update: MessageUpdate): update is MessageToo
 	update.type === MessageUpdateType.Tool;
 export const isMessageToolCallUpdate = (update: MessageUpdate): update is MessageToolCallUpdate =>
 	isMessageToolUpdate(update) && update.subtype === MessageToolUpdateType.Call;
-export const isMessageToolResultUpdate = (update: MessageUpdate): update is MessageToolCallUpdate =>
+export const isMessageToolResultUpdate = (
+	update: MessageUpdate
+): update is MessageToolResultUpdate =>
 	isMessageToolUpdate(update) && update.subtype === MessageToolUpdateType.Result;
+export const isMessageToolErrorUpdate = (update: MessageUpdate): update is MessageToolErrorUpdate =>
+	isMessageToolUpdate(update) && update.subtype === MessageToolUpdateType.Error;
 
 type MessageUpdateRequestOptions = {
 	base: string;