@worktango/ai-assistant 0.0.117 → 0.0.119

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@worktango/ai-assistant",
-  "version": "0.0.117",
+  "version": "0.0.119",
   "files": [
     "constants.js",
     "dist",

package/react.d.ts

@@ -1,4 +1,4 @@
-import type { TSchema, Type, Static, TObject } from "@sinclair/typebox";
+import type { TSchema, Type, Static } from "@sinclair/typebox";
 import {
   AiAssistantProps,
   ChatData,
@@ -9,8 +9,6 @@ import {
   AiAssistantSuggestedPromptsProps,
   GetFollowUpSuggestions,
   ChatDataFile,
-  AiAssistantControls,
-  FollowUpSuggestion,
 } from "./sharedTypes";
 
 export const getDefaultGetFollowUpSuggestions: (args: {
@@ -23,6 +21,36 @@ export function AiAssistantSuggestedPrompts(
   args: AiAssistantSuggestedPromptsProps
 ): JSX.Element;
 
+export interface AiResponseRating {
+  id: string;
+  userRating?: "THUMBS_UP" | "THUMBS_DOWN" | null;
+  userComment?: string | null;
+}
+
+export interface GenAIRatingComponentProps {
+  responseType: "WTC_MESSAGE" | "SURVEY_SUMMARY" | "COMMENTS_SUMMARY";
+  responseId: string;
+  genAiMessage: string;
+  genAiMessageTimestamp: string;
+  onSubmitRating: (input: any) => Promise<any>;
+  isLoading?: boolean;
+  error?: Error;
+  aiResponseRating?: AiResponseRating | null;
+}
+
+export type GenAIRatingComponentApolloWrappedProps = Omit<
+  GenAIRatingComponentProps,
+  "onSubmitRating" | "isLoading" | "error"
+>;
+
+export function GenAIRatingComponent(
+  args: GenAIRatingComponentProps
+): JSX.Element;
+
+export function GenAIRatingComponentApolloWrapped(
+  args: GenAIRatingComponentApolloWrappedProps
+): JSX.Element;
+
 export const tools: {
   kazooTools: {
     getRewardsAndRecognitionCurrentUserTool: ToolDeclaration;
@@ -33,11 +61,49 @@ export const tools: {
     askSingleShotQuestion: ToolDeclaration;
     analyzeCurrentPage: ToolDeclaration;
   };
+  /**
+   * Helper function to define a new tool for the AI Assistant.
+   *
+   * The tool's name, description, and the full schema of its parameters (including
+   * their descriptions) are sent to the LLM at the beginning of every interaction.
+   * The LLM uses this information to understand what the tool does and decide
+   * when and how to call it.
+   *
+   * Providing a clear, descriptive tool `description` and detailed descriptions
+   * for each field in the `parameters` object is essential for reliable tool calling.
+   */
   createTool<TParams extends TSchema = TSchema>(args: {
     name: string;
+    /**
+     * A description of the tool that is provided to the LLM.
+     * This tells the LLM what the tool is capable of getting or doing, helping it
+     * decide when to invoke it.
+     */
     description: string;
+    /**
+     * A user-friendly, present-tense name for the tool (e.g., "Performing calculations").
+     * This is shown in the AI Assistant UI while the tool is executing.
+     */
+    displayName: string;
+    /**
+     * A user-friendly, past-tense name for the tool (e.g., "Performed calculations").
+     * This is shown in the AI Assistant's debug mode after the tool has finished executing.
+     */
+    pastTenseDisplayName: string;
+    /**
+     * A function that returns a JSON schema (using TypeBox) defining the arguments
+     * required by the tool. Each field in the schema should include a `description`
+     * to help the LLM provide accurate values.
+     */
     parameters?: (t: typeof Type) => TParams;
+    /**
+     * The implementation function for the tool. This is called when the LLM
+     * decides to invoke the tool.
+     */
     fulfill: (args: Static<TParams>) => Promise<string | ChatDataFile>;
+    /**
+     * Currently unused. Investigate intent and potential removal before using.
+     */
     chatItemMatches?: (chatItem: ChatItem) => boolean;
   }): ToolDeclaration;
 } = {};

package/sharedTypes.ts

@@ -69,7 +69,20 @@ export type ChatItem = {
 export type ToolDeclaration<TParams extends TSchema = TSchema> = {
   name: string;
   description: string;
+  /**
+   * A user-friendly, present-tense name for the tool (e.g., "Performing calculations").
+   * This is shown in the AI Assistant UI while the tool is executing.
+   */
+  displayName: string;
+  /**
+   * A user-friendly, past-tense name for the tool (e.g., "Performed calculations").
+   * This is shown in the AI Assistant's debug mode after the tool has finished executing.
+   */
+  pastTenseDisplayName: string;
   parameters?: any;
+  /**
+   * Currently unused. Investigate intent and potential removal before using.
+   */
   chatItemMatches?: (chatItem: {
     role: "user" | "model" | "tool";
     parts: ChatData[];